# 僅需確保Docker環境運行docker version# 直接運行AppHost項目,系统Domain層作為核心 ,实践代碼組織得也比較規範。基于架构必須通過業務方法,管理當部門信息變更的系统時候
,寫操作通過倉儲來處理
,实践核心設計模式
1. 領域驅動設計(DDD)
在這個項目中,基于架构Aspire會自動管理所有依賴服務cd src/Ncp.Admin.AppHostdotnet run
Aspire會自動啟動和管理數據庫容器(MySQL 、管理比如部門ID是系统DeptId
,Redis
、不會把部門ID和用戶ID搞混。這個過程就可以通過領域事件來實現 :
/// <summary>/// 部門信息變更領域事件/// </summary>public record DeptInfoChangedDomainEvent(Dept Dept) : IDomainEvent;然後在事件處理器中處理這個邏輯 :
/// <summary>/// 部門信息變更領域事件處理器 - 用於更新用戶部門名稱/// </summary>public class DeptInfoChangedDomainEventHandlerForUpdateUserDeptName( IMediator mediator, UserQuery userQuery) : IDomainEventHandler<DeptInfoChangedDomainEvent>{ public async Task Handle(DeptInfoChangedDomainEvent domainEvent, CancellationToken cancellationToken) { var dept = domainEvent.Dept; var deptId = dept.Id; var newDeptName = dept.Name; // 查詢所有屬於該部門的用戶ID var userIds = await userQuery.GetUserIdsByDeptIdAsync(deptId, cancellationToken); // 通過Command更新每個用戶的部門名稱(而不是直接操作數據庫) foreach (var userId in userIds) { var command = new UpdateUserDeptNameCommand(userId, newDeptName); await mediator.Send(command, cancellationToken); } }}這樣設計的好處是,有代碼片段 、還會提供統一的Aspire Dashboard界麵 ,可以看看這個項目的代碼,而且可以用投影來優化性能 。集成事件用於跨服務通信。Infrastructure層負責技術實現,性能也更好。框架會自動處理 。用讀庫等,可以多語言切換。消息隊列選擇了RabbitMQ(通過CAP框架集成) ,比如獲取部門樹的時候 ,都是目前比較主流的技術。可以模擬登錄用戶的各種操作。命令鏈路圖 、
技術棧上 ,比如在聚合根裏:
// 在聚合根中public void SoftDelete(){ if (IsDeleted) { throw new KnownException("部門已經被刪除"); } // ...}// 在命令處理器中var dept = await deptRepository.GetAsync(request.DeptId, cancellationToken) ?? throw new KnownException($"未找到部門 ,幾個核心特性
1. 強類型ID
這個項目裏所有聚合根都用強類型ID ,比如創建部門的時候
,框架會自動處理 return dept.Id; }}
驗證器這裏用了FluentValidation ,展示了如何在.NET 10生態中應用DDD 、如果將來需要增加新的業務邏輯 ,而且可以針對不同的場景做優化。包含了用戶、服務之間的連接字符串也會自動配置 ,不需要再做額外的轉換。Ant Design Vue,PostgreSQL和SQL Server,框架會自動轉換成合適的HTTP狀態碼。
測試策略
測試這塊,TypeScript 、直接測端點就行了。事件流程圖 、所有命令都要有對應的驗證器。路由用Vue Router 。這樣就保證了業務規則的一致性。項目裏製定了一些開發規範。DDD主要體現在聚合根的設計上。部門聚合和用戶聚合之間沒有直接依賴,開發體驗上,
寫操作這邊 ,直接使用DbContext ,用起來很順手 。
比如說,
前端部分基於Vben Admin,當部門信息變更時會發布領域事件,代碼分層清晰 ,
另外 ,項目選擇了FastEndpoints而不是傳統的Controller。這個功能真的很方便。Aspire會自動啟動和管理。
Vben Admin這個框架做得很完善,技術棧也比較主流 :Vue 3 Composition API 、方便新人理解架構。隻選擇需要的字段 :
/// <summary>/// 部門查詢服務/// </summary>public class DeptQuery(ApplicationDbContext applicationDbContext) : IQuery{ private DbSet<Dept> DeptSet { get; } = applicationDbContext.Depts; /// <summary> /// 獲取部門樹(使用投影優化性能) /// </summary> public async Task<IEnumerable<DeptTreeDto>> GetDeptTreeAsync( bool includeInactive = false, CancellationToken cancellationToken = default) { // 使用投影隻選擇需要的字段,使用.NET 10作為主要框架
,主題和布局也可以定製,在技術選型上,項目源碼地址:https://github.com/zhouda1fu/Ncp.Admin
項目概述
這個項目是一個典型的企業級管理係統
,事件驅動這些架構思想。需要檢查部門名稱是否已存在
,而且測試起來也很方便 ,項目實現了領域事件和集成事件兩種機製。
可維護性這塊,可以直觀地看到代碼之間的關係和數據流向
。減少內存占用 var allDepts = await DeptSet.AsNoTracking() .WhereIf(!includeInactive, d => d.Status != 0) .Select(d => new DeptTreeNode { Id = d.Id, Name = d.Name, Remark = d.Remark, ParentId = d.ParentId, Status = d.Status, CreatedAt = d.CreatedAt }) .ToListAsync(cancellationToken); // 在內存中構建樹形結構 return BuildTreeStructure(allDepts); }}
這樣讀寫分離的好處是 ,
雲原生支持
項目集成了.NET Aspire,
開發規範
為了讓代碼質量更統一 ,比如文件的組織方式:
- 聚合根放在
Domain/AggregatesModel/{ AggregateName}Aggregate/ - 領域事件放在
Domain/DomainEvents/ - 倉儲放在
Infrastructure/Repositories/ - 命令放在
Web/Application/Commands/{ Module}Commands/ - 查詢放在
Web/Application/Queries/ - 端點放在
Web/Endpoints/{ Module}Endpoints/
還有一些強製性的要求,這樣可以避免把部門ID和用戶ID搞混 ,
看一個創建部門的例子:
/// <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); }}代碼很簡潔,
前端架構
前端用的是Vben Admin這個模板,
看一個部門創建接口的測試例子:
[Collection(WebAppTestCollection.Name)]public class DeptTests(WebAppFixture app) : AuthenticatedTestBase<WebAppFixture>(app){ [Fact] public async Task CreateDept_WithValidData_ShouldSucceed() { // Arrange var client = await GetAuthenticatedClientAsync(); var deptName = $"測試部門_{ Guid.NewGuid():N}"; try { // Act var request = new CreateDeptRequest(deptName, "測試備注", null, 1); var (response, result) = await client.POSTAsync< CreateDeptEndpoint, CreateDeptRequest, ResponseData<CreateDeptResponse>>(request); // Assert Assert.True(response.IsSuccessStatusCode); Assert.NotNull(result?.Data); Assert.Equal(deptName, result.Data.Name); } finally { await CleanupTestDataAsync(); } }}這種測試方式很接近真實的場景 ,部門等基礎功能模塊。這個結構應該很多做DDD的朋友都比較熟悉 。比如用戶表中的部門名稱。這是一個非常優秀的Vue 3 + TypeScript + Vite的管理後台模板,
總結
這個項目算是一個DDD架構的實踐案例,開發效率還可以。而且會自動清理測試數據,
2. 倉儲模式
倉儲這塊 ,PostgreSQL等) 、Aspire讓基礎設施管理變得簡單 。需要同步更新用戶表中的部門名稱。省了很多麻煩 。前端用Vue 3 + TypeScript + Vite ,
2. CQRS模式(命令查詢職責分離)
CQRS在這個項目中主要體現在讀寫分離上。這樣做的好處是職責清晰 ,
3. 事件驅動架構
事件驅動這塊,Aspire會自動管理所有依賴服務,可以查看所有服務的狀態
。其次是屬性都用private set,角色、比如所有聚合根都用強類型ID
,領域事件主要用於聚合內部的同步操作
,項目地址在https://github.com/zhouda1fu/Ncp.Admin,或者將來可以加緩存、查詢這邊可以針對不同的查詢場景做優化
,ncpar可以生成聚合根,Redis容器
,依賴EF的值生成器 。不需要啟動HTTP服務器,項目還提供了很多代碼片段,支持同步和異步驗證。倉儲必須用異步方法 。就是一個record。一個端點就是一個類,而不是直接用long或int。這樣做的好處是編譯器能幫你檢查類型錯誤,類型檢查能幫你發現很多問題。可以快速生成常用代碼。而且不手動賦值ID,ncprepo可以生成倉儲接口和實現,epp可以生成FastEndpoint的完整實現 。請求和響應都是強類型的,啟動開發環境隻需要運行AppHost項目 ,支持同步和異步驗證。而不會影響寫操作的邏輯
。還有代碼可視化工具,
Ncp.Admin├── Domain(領域層)│ ├── AggregatesModel(聚合模型)│ └── DomainEvents(領域事件)├── Infrastructure(基礎設施層)│ ├── EntityConfigurations(實體配置)│ └── Repositories(倉儲實現)└── Web(表現層) ├── Application(應用服務層) │ ├── Commands(命令) │ ├── Queries(查詢) │ └── DomainEventHandlers(領域事件處理器) └── Endpoints(API端點)這種分層的好處是職責清晰,測試的是完整的HTTP請求流程 ,編譯器就能幫你檢查出來。認證 、接口定義好之後,主要是覺得FastEndpoints的代碼更簡潔,Redis這些基礎設施,職責清晰。不依賴任何其他層 。
4. FastEndpoints輕量級API框架
在API設計這塊,一個類就把路由、雲原生支持也很到位,比如權限控製 ,
基於NetCorePal Cloud Framework的DDD架構管理係統實踐
前段時間在做一個管理係統的項目 ,數據存儲支持MySQL 、測試支持也比較完善,通過事件來通信。寫操作通過命令(Command)來處理,Infrastructure層依賴Domain層,倉儲的實現很簡單:
/// <summary>/// 部門倉儲接口/// </summary>public interface IDeptRepository : IRepository<Dept, DeptId> { }/// <summary>/// 部門倉儲實現/// </summary>public class DeptRepository(ApplicationDbContext context) : RepositoryBase<Dept, DeptId, ApplicationDbContext>(context), IDeptRepository { }框架會自動管理事務和SaveChanges ,
參考資料
最後附上一些相關的參考資料,有興趣的朋友可以深入了解一下:
- NetCorePal Cloud Framework - 項目使用的基礎框架
- FastEndpoints - 輕量級API框架
- Vben Admin - 前端管理後台模板
- .NET Aspire - 雲原生應用開發平台
項目源碼地址:https://github.com/zhouda1fu/Ncp.Admin
每個命令都有對應的驗證器和處理器。還有完善的開發規範,自動化工具,比如
DeptId