项目介绍
本框架是一个基于 .NET 10.0 构建的模块化开发框架,专为 中后台系统 与 高并发场景 设计。
框架提供开箱即用的多项目模板支持,帮助开发者快速搭建企业级应用。通过该模板,开发者可以快速完成基础框架搭建,将更多精力聚焦于业务逻辑开发,并灵活应对复杂系统架构需求。
适用场景
- 企业级后台管理系统接口快速搭建
- 需要通过网关统一管理多个模块接口的项目
- 多模块、微服务或准微服务架构项目
- 高并发业务接口系统
安装或升级模板
升级模板命令与安装模板命令相同。
1 | dotnet new install ZhonTai.Template.Framework |
安装指定版本
例如安装 9.0.1 版本:
1 | dotnet new install ZhonTai.Template.Framework::9.0.1 |
卸载模板
1 | dotnet new uninstall ZhonTai.Template.Framework |
创建框架项目
使用以下命令创建框架项目:
1 | dotnet new MyFramework -n MyCompanyName.MyProjectName |
创建完成后,双击打开解决方案文件:
1 | MyCompanyName.MyProjectName\MyCompanyName.MyProjectName.sln |
搭建项目
项目创建完成后,需要继续添加网关项目、即时通讯服务端项目以及业务端项目。
1. 新建网关项目
操作位置
在解决方案中,选择以下目录:
1 | 02.Gateways |
右键菜单点击:
1 | 添加 -> 新建项目 |
需要提前安装网关项目模板。安装后,项目模板类型中可通过
ZhonTai过滤中台模板。
选择模板
选择以下模板:
1 | ZhonTai.Template.Gateway |
点击 下一步。
配置新项目
| 配置项 | 值 |
|---|---|
| 项目名称 | MyCompanyName.MyGateway |
| 位置 | MyCompanyName.MyProjectName\Gateways |
| 端口 | 16010 |
配置完成后,点击 创建。
2. 新建 ImServer 项目
操作位置
在解决方案中,选择以下目录:
1 | 03.Modules\ImServer |
右键菜单点击:
1 | 添加 -> 新建项目 |
需要提前安装即时通讯服务端项目模板。
选择模板
选择以下模板:
1 | ZhonTai.Template.IMServer |
点击 下一步。
配置新项目
| 配置项 | 值 |
|---|---|
| 项目名称 | MyCompanyName.MyIMServer |
| 位置 | MyCompanyName.MyProjectName\Modules |
| 端口 | 17010 |
配置完成后,点击 创建。
3. 新建平台端项目
操作位置
在解决方案中,选择以下目录:
1 | 03.Modules\System |
右键菜单点击:
1 | 添加 -> 新建项目 |
需要提前安装 App 业务端项目模板。
选择模板
选择以下模板:
1 | ZhonTai.Template.App |
点击 下一步。
配置新项目
| 配置项 | 值 |
|---|---|
| 项目名称 | MyCompanyName.MySys |
| 位置 | MyCompanyName.MyProjectName\Modules |
| 项目类别 | sys |
| Http 端口 | 18010 |
| Grpc 端口 | 18011 |
配置完成后,点击 创建。
提示
- 项目编码不填写时,默认为
sys - 安全密钥不填写时,默认自动生成 GUID 唯一编码
4. 配置静态资源
在项目框架搭建的最后一步,需要确保所有公共配置文件能够正确加载到项目中,同时清理项目中冗余的配置文件。
4.1 修改 MyCompanyName.MySys.Host.csproj 文件
打开以下项目文件:
1 | MyCompanyName.MySys.Host.csproj |
在文件中添加以下配置:
1 | project |
该配置会将以下目录中的所有文件复制到项目输出目录中,并保持文件结构:
1 | Frameworks/Assets |
包括配置文件在内的所有资源文件都会在运行时正确加载。
4.2 移动 jwtconfig.json 文件
将以下文件:
1 | MyCompanyName.MySys.Host/ConfigCenter/jwtconfig.json |
移动到:
1 | 04.Frameworks/Assets/ConfigCenter/jwtconfig.json |
这样可以将配置文件统一管理,方便后续维护和更新。
4.3 删除项目下的 nlog.config 文件
如果项目中存在以下文件,请将其删除:
1 | MyCompanyName.MySys.Host/nlog.config |
原因是日志配置已经统一迁移到 Frameworks/Assets 目录下,删除该文件可以避免重复配置和潜在冲突。
完成项目搭建
完成以上操作后,项目中的公共配置文件已经能够正确加载,冗余配置文件也已清理完成。
现在可以启动项目,并检查以下内容:
- 网关项目是否正常启动
- ImServer 项目是否正常启动
- 平台端项目是否正常启动
- 公共配置文件是否成功加载
- 日志配置是否正常生效
- JWT 配置是否可以正常读取
至此,框架项目搭建完成。
#中台/搭建项目框架