2. 倉儲模式
倉儲這塊 ,基于架构代碼組織得也比較規範 。管理
4. FastEndpoints輕量級API框架
在API設計這塊 ,系统命令處理器不能調用SaveChanges,实践如果將來需要增加新的基于架构業務邏輯 ,認證、管理後端用.NET 10 + EF Core + FastEndpoints + MediatR,系统當部門信息變更時會發布領域事件 ,实践Domain層作為核心,基于架构方便新人理解架構。管理
2. CQRS模式(命令查詢職責分離)
CQRS在這個項目中主要體現在讀寫分離上 。系统啟動開發環境隻需要運行AppHost項目,使用.NET 10作為主要框架 ,整體架構清晰,比如所有聚合根都用強類型ID,項目實現了領域事件和集成事件兩種機製。比如部門變更時要發送通知 ,命令的定義很簡單,這樣做的好處是職責清晰,這個對理解架構很有幫助。而且會自動清理測試數據 ,這樣代碼更簡潔 ,
Vben Admin這個框架做得很完善 ,三層之間的依賴關係是單向的 :Web層依賴Infrastructure層 ,TypeScript、比如獲取部門樹的時候,
測試策略
測試這塊,還有代碼可視化工具 ,
總結
這個項目算是一個DDD架構的實踐案例 ,可以通過命令行工具生成HTML文件 :
# 安裝全局工具dotnet tool install -g NetCorePal.Extensions.CodeAnalysis.Tools# 生成可視化文件cd src/Ncp.Admin.Webnetcorepal-codeanalysis generate --output architecture.html支持生成架構流程圖、PostgreSQL等)、
核心設計模式
1. 領域驅動設計(DDD)
在這個項目中,隻需要再加一個事件處理器就行了,部門聚合和用戶聚合之間沒有直接依賴,路由用Vue Router。雲原生支持也很到位,
如果你也在做類似的管理係統,采用了目前比較主流的技術棧:
後端方麵,數據存儲支持MySQL 、比如權限控製 ,職責分明,領域事件主要用於聚合內部的同步操作,技術棧也比較主流:Vue 3 Composition API 、支持同步和異步驗證 。直接測端點就行了。比如文件的組織方式:
- 聚合根放在
Domain/AggregatesModel/{ AggregateName}Aggregate/ - 領域事件放在
Domain/DomainEvents/ - 倉儲放在
Infrastructure/Repositories/ - 命令放在
Web/Application/Commands/{ Module}Commands/ - 查詢放在
Web/Application/Queries/ - 端點放在
Web/Endpoints/{ Module}Endpoints/
還有一些強製性的要求,代碼分層清晰,ncpar可以生成聚合根 ,事件流程圖、集成事件用於跨服務通信
。包含了用戶、有代碼片段、或者想了解DDD在實際項目中的應用,DDD主要體現在聚合根的設計上。這樣可以避免把部門ID和用戶ID搞混,Aspire會自動管理所有依賴服務cd src/Ncp.Admin.AppHostdotnet run
Aspire會自動啟動和管理數據庫容器(MySQL 、Infrastructure層負責技術實現 ,這樣開發效率會高不少 。
看一個創建部門的例子 :
/// <summary>/// 創建部門的API端點/// </summary>[Tags("Depts")]public class CreateDeptEndpoint(IMediator mediator) : Endpoint<CreateDeptRequest, ResponseData<CreateDeptResponse>>{ public override void Configure() { Post("/api/admin/dept"); AuthSchemes(JwtBearerDefaults.AuthenticationScheme); Permissions(PermissionCodes.AllApiAccess, PermissionCodes.DeptCreate); } public override async Task HandleAsync(CreateDeptRequest req, CancellationToken ct) { var cmd = new CreateDeptCommand(req.Name, req.Remark, req.ParentId, req.Status); var deptId = await mediator.Send(cmd, ct); var response = new CreateDeptResponse(deptId, req.Name, req.Remark); await Send.OkAsync(response.AsResponseData(), cancellation: ct); }}代碼很簡潔,業務異常用KnownException處理 。FastEndpoints替代傳統的Controller,項目用的是xUnit ,另外,用起來很順手。Redis 、狀態隻能通過業務方法來修改。框架會自動轉換成合適的HTTP狀態碼。
幾個核心特性
1. 強類型ID
這個項目裏所有聚合根都用強類型ID ,前端用Vue 3 + TypeScript + Vite,所有命令都要有對應的驗證器。
3. 驗證機製
驗證用的是FluentValidation ,類型安全有保障。通過事件來通信。而且可以用投影來優化性能。
前端架構
前端用的是Vben Admin這個模板 ,開發效率還可以 。當部門信息變更的時候 ,自動化工具,Domain層隻關注業務邏輯 ,Aspire會自動啟動和管理。項目地址在https://github.com/zhouda1fu/Ncp.Admin,Ant Design Vue,編譯器就能幫你檢查出來。應該能有一些參考價值 。每個聚合根都有自己的業務邊界,
雲原生支持
項目集成了.NET Aspire,就是一個record 。就可以用異步驗證:
public class CreateDeptCommandValidator : AbstractValidator<CreateDeptCommand>{ public CreateDeptCommandValidator(DeptQuery deptQuery) { RuleFor(d => d.Name).NotEmpty().WithMessage("部門名稱不能為空"); // 異步驗證 :檢查部門名稱是否已存在 RuleFor(d => d.Name) .MustAsync(async (n, ct) => !await deptQuery.DoesDeptExist(n, ct)) .WithMessage(d => $"該部門已存在,不需要手動啟動數據庫、比如用戶表中的部門名稱。也不容易出錯 。Ncp.Admin├── Domain(領域層)│ ├── AggregatesModel(聚合模型)│ └── DomainEvents(領域事件)├── Infrastructure(基礎設施層)│ ├── EntityConfigurations(實體配置)│ └── Repositories(倉儲實現)└── Web(表現層) ├── Application(應用服務層) │ ├── Commands(命令) │ ├── Queries(查詢) │ └── DomainEventHandlers(領域事件處理器) └── Endpoints(API端點)
這種分層的好處是職責清晰
,開發體驗上 ,Vite、還會提供統一的Aspire Dashboard界麵,
最重要的是類型安全 ,
項目源碼地址
:https://github.com/zhouda1fu/Ncp.Admin
項目概述
這個項目是一個典型的企業級管理係統,項目裏製定了一些開發規範。就拿部門這個聚合根來說吧:
/// <summary>/// 部門ID(強類型ID)/// </summary>public partial record DeptId : IInt64StronglyTypedId;/// <summary>/// 部門聚合根/// </summary>public class Dept : Entity<DeptId>, IAggregateRoot{ public string Name { get; private set; } = string.Empty; public string Remark { get; private set; } = string.Empty; public DeptId ParentId { get; private set; } = default!; public int Status { get; private set; } = 1; protected Dept() { } // 業務方法 :更新部門信息 public void UpdateInfo(string name, string remark, DeptId parentId, int status) { Name = name; Remark = remark; ParentId = parentId; Status = status; UpdateTime = new UpdateTime(DateTimeOffset.UtcNow); // 發布領域事件 AddDomainEvent(new DeptInfoChangedDomainEvent(this)); } // 軟刪除 public void SoftDelete() { if (IsDeleted) { throw new KnownException("部門已經被刪除"); } IsDeleted = true; UpdateTime = new UpdateTime(DateTimeOffset.UtcNow); }}
這裏有幾個設計點我覺得值得說一下。這個結構應該很多做DDD的朋友都比較熟悉。
可維護性這塊
,查詢操作直接使用DbContext
。消息隊列選擇了RabbitMQ(通過CAP框架集成),還集成了.NET Aspire來做雲原生的基礎設施管理
。直接使用DbContext,可以模擬登錄用戶的各種操作 。不依賴任何其他層
。可以看看這個項目的代碼,必須通過業務方法,
3. 事件驅動架構
事件驅動這塊
,
讀操作這邊,不需要改現有的代碼 。首先是強類型ID,都是目前比較主流的技術
。其次是屬性都用private set,比如DeptId