Meiam System 开源项目使用教程
1. 项目的目录结构及介绍
Meiam System 是一个基于 .NET Core 的企业级前后端分离权限框架。以下是项目的目录结构及其介绍:
Meiam System
├── Meiam.System.Common # 存放常用类库、加密解密单元等
├── Meiam.System.Core # 数据库、缓存相关类
├── Meiam.System.Extensions # 外部接口引用集成
├── Meiam.System.Interfaces # Service、IServer 基础服务类
├── Meiam.System.Model # Entity、Dto、ViewModel
├── Meiam.System.Hostd # WebAPI
├── Meiam.System.Tools # 代码生成器
├── Meiam.System.Tasks # 任务调度中心
├── gitattributes
├── gitignore
├── LICENSE
├── Meiam.System-MySQL.sql
├── Meiam.System-SQLServer.sql
├── Meiam.System.sln
├── NLog-MySQL.config
├── NLog-SQLServer.config
├── README.md
目录结构介绍
- Meiam.System.Common: 存放项目中常用的类库和工具类。
- Meiam.System.Core: 包含数据库和缓存相关的核心类。
- Meiam.System.Extensions: 集成外部接口的扩展类。
- Meiam.System.Interfaces: 定义服务层的基础接口和类。
- Meiam.System.Model: 包含实体类、数据传输对象和视图模型。
- Meiam.System.Hostd: 提供 WebAPI 接口。
- Meiam.System.Tools: 包含代码生成器工具。
- Meiam.System.Tasks: 任务调度中心,用于定时任务管理。
- gitattributes: Git 属性配置文件。
- gitignore: Git 忽略文件配置。
- LICENSE: 项目许可证文件。
- Meiam.System-MySQL.sql: MySQL 数据库脚本。
- Meiam.System-SQLServer.sql: SQL Server 数据库脚本。
- Meiam.System.sln: Visual Studio 解决方案文件。
- NLog-MySQL.config: NLog 日志配置文件(MySQL)。
- NLog-SQLServer.config: NLog 日志配置文件(SQL Server)。
- README.md: 项目说明文档。
2. 项目的启动文件介绍
Meiam System 的启动文件位于 Meiam.System.Hostd
目录下,主要文件为 Startup.cs
和 Program.cs
。
Program.cs
Program.cs
文件是应用程序的入口点,负责配置和启动 Web 主机。
public class Program
{
public static void Main(string[] args)
{
CreateHostBuilder(args).Build().Run();
}
public static IHostBuilder CreateHostBuilder(string[] args) =>
Host.CreateDefaultBuilder(args)
.ConfigureWebHostDefaults(webBuilder =>
{
webBuilder.UseStartup<Startup>();
});
}
Startup.cs
Startup.cs
文件负责配置应用程序的服务和请求管道。
public class Startup
{
public Startup(IConfiguration configuration)
{
Configuration = configuration;
}
public IConfiguration Configuration { get; }
public void ConfigureServices(IServiceCollection services)
{
// 配置服务
services.AddControllers();
// 其他服务配置...
}
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
if (env.IsDevelopment())
{
app.UseDeveloperExceptionPage();
}
app.UseRouting();
app.UseAuthorization();
app.UseEndpoints(endpoints =>
{
endpoints.MapControllers();
});
}
}
3. 项目的配置文件介绍
Meiam System 的配置文件主要包括 appsettings.json
和日志配置文件 NLog-MySQL.config
、NLog-SQLServer.config
。
appsettings.json
appsettings.json
文件用于配置应用程序的各种设置,如数据库连接字