跳到主要内容
版本:3.0.0

入门

如果你是第一次接入 Aegis,不要从概念开始啃。
最稳的方式是:

  1. 先照着 快速开始 跑通一个最小系统
  2. 再看 层次介绍 和各页职责
  3. 最后按需阅读扩展组件

先明确文档边界

这套文档面向 业务项目使用 Aegis,默认目标是:

  • 新建业务项目
  • 使用 .NET 8
  • 接入 Aegis 3.x
  • 先跑通宿主、数据库、Swagger、日志

它不是用来介绍 Aegis 源码仓内部模块结构的,也不是升级旧版本项目的主入口。

一个业务项目通常会有哪些层

在 Aegis 业务项目里,最常见的分层通常包括:

层级作用常见内容
WebApi宿主与接口层Program.csStartup、Controller、配置文件
Contract服务契约层IBusinessService 接口、跨层契约
Services业务服务层业务编排、调用 Repository、返回 DTO
Dto数据传输层RequestDto、分页请求等
Repository数据访问层IDbSource、Entity、Repository、FreeSql

需要注意:

  • 这里说的是 业务项目的分层
  • 文档里如果使用 His.* 作为命名示例,也是为了演示业务项目结构。
  • 它不代表 Aegis 框架源码仓必须长成那样。

可以怎样理解 HIS 示例

例如下面这种结构:

Dezhen.His.Master
├── His.WebApi
│ └── His.Patient.WebApi
├── His.Services
│ └── Patient
│ ├── His.Patient.Contract
│ ├── His.Patient.Services
│ └── His.Patient.Dto
└── His.Repository

它表达的是:

  • 按业务域组织项目
  • 把接口、服务、DTO、仓储拆开
  • 让业务系统使用 Aegis 的宿主能力和组件能力

如果你的业务不叫 HIS,完全可以替换成自己的系统命名。

当前基线只覆盖到哪里

本轮基线主线只覆盖四条能力:

  1. 宿主与启动
  2. 数据库闭环
  3. Swagger
  4. 日志

这些内容足够支撑你做出一个最小的、可以演示和继续扩展的业务系统。

以下内容不在这轮基线主线里:

  • 鉴权
  • 缓存
  • 配置中心
  • 事件总线
  • 延迟任务
  • SignalR

推荐阅读顺序

第一次接入时建议按下面顺序:

  1. 快速开始
  2. 初始系统验证清单
  3. 层次介绍
  4. 再按需展开看 Startup / 配置 / 日志 / Repository / Controller / Swagger

读完这页之后,下一步做什么

如果你现在的目标是“今天先跑起来”,请直接进入 快速开始
如果你已经跑通最小系统,再回来读这页,会更容易把整体结构看明白。