基於NetCorePal Cloud Framework的DDD架構管理係統實踐
前段時間在做一個管理係統的項目 ,比如用投影減少內存占用,管理比如創建部門的系统時候 ,部門等基礎功能模塊。实践這樣做的基于架构好處是編譯器能幫你檢查類型錯誤 ,可以直觀地看到代碼之間的管理關係和數據流向 。Name={ d.Name}"); RuleFor(d => d.Status).InclusiveBetween(0,系统 1).WithMessage("狀態值必須為0或1"); }}/// <summary>/// 命令處理器/// </summary>public class CreateDeptCommandHandler(IDeptRepository deptRepository) : ICommandHandler<CreateDeptCommand, DeptId>{ public async Task<DeptId> Handle(CreateDeptCommand request, CancellationToken cancellationToken) { var parentId = request.ParentId ?? new DeptId(0); var dept = new Dept(request.Name, request.Remark, parentId, request.Status); await deptRepository.AddAsync(dept, cancellationToken); // 注意 :不需要手動調用SaveChanges,
核心設計模式
1. 領域驅動設計(DDD)
在這個項目中 ,性能也更好 。寫操作通過倉儲來處理,Aspire會自動管理所有依賴服務,領域事件主要用於聚合內部的同步操作,DeptId = { request.DeptId}");
這樣前端收到的錯誤信息就很清晰,就可以用異步的MustAsync。支持同步和異步驗證
。
雲原生支持
項目集成了.NET Aspire,可以快速生成常用代碼。部門聚合和用戶聚合之間沒有直接依賴,代碼組織得也比較規範。而且可以用投影來優化性能 。需要同步更新用戶表中的部門名稱 。比如文件的組織方式:
- 聚合根放在
Domain/AggregatesModel/{ AggregateName}Aggregate/ - 領域事件放在
Domain/DomainEvents/ - 倉儲放在
Infrastructure/Repositories/ - 命令放在
Web/Application/Commands/{ Module}Commands/ - 查詢放在
Web/Application/Queries/ - 端點放在
Web/Endpoints/{ Module}Endpoints/
還有一些強製性的要求 ,服務之間的連接字符串也會自動配置 ,這樣代碼更簡潔 ,
看一個部門創建接口的測試例子 :
[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(); } }}這種測試方式很接近真實的場景,自動化工具,前端用Vue 3 + TypeScript + Vite ,這樣就保證了業務規則的一致性。編譯器就能幫你檢查出來。ncpar可以生成聚合根,
Ncp.Admin├── Domain(領域層)│ ├── AggregatesModel(聚合模型)│ └── DomainEvents(領域事件)├── Infrastructure(基礎設施層)│ ├── EntityConfigurations(實體配置)│ └── Repositories(倉儲實現)└── Web(表現層) ├── Application(應用服務層) │ ├── Commands(命令) │ ├── Queries(查詢) │ └── DomainEventHandlers(領域事件處理器) └── Endpoints(API端點)這種分層的好處是職責清晰,
開發規範
為了讓代碼質量更統一,最終選擇了NetCorePal Cloud Framework作為基礎框架,經過一番調研,不依賴任何其他層 。這個結構應該很多做DDD的朋友都比較熟悉 。如果將來需要增加新的業務邏輯 ,測試的是完整的HTTP請求流程,RabbitMQ這些 。
比如說 ,不需要啟動HTTP服務器,命令鏈路圖、職責清晰 。FastEndpoints替代傳統的Controller ,
參考資料
最後附上一些相關的參考資料,Domain層隻關注業務邏輯 ,項目地址在https://github.com/zhouda1fu/Ncp.Admin,代碼分層清晰,比如用戶表中的部門名稱。
3. 驗證機製
驗證用的是FluentValidation ,
幾個核心特性
1. 強類型ID
這個項目裏所有聚合根都用強類型ID ,就可以用異步驗證 :
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 => $"該部門已存在,而不會影響寫操作的邏輯
。命令的定義很簡單,直接使用DbContext,框架會自動處理 return dept.Id; }}驗證器這裏用了FluentValidation,epp可以生成FastEndpoint的完整實現
。DDD主要體現在聚合根的設計上 。可以看看這個項目的代碼
,還集成了.NET Aspire來做雲原生的基礎設施管理 。用起來很方便。結合.NET 10和Vue 3搭建了一套完整的前後端分離架構 。不需要改現有的代碼。首先是強類型ID ,事件流程圖、直接測端點就行了
。類型安全有保障。采用了目前比較主流的技術棧:
後端方麵,消息隊列選擇了RabbitMQ(通過CAP框架集成) ,每個命令都有對應的驗證器和處理器。用讀庫等,比如獲取部門樹的時候,必須通過業務方法,看一個創建部門的例子 :
/// <summary>/// 創建部門命令/// </summary>public record CreateDeptCommand(string Name, string Remark, DeptId? ParentId, int Status) : ICommand<DeptId>;/// <summary>/// 命令驗證器/// </summary>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 => $"該部門已存在
,希望能給正在做類似項目的朋友一些參考。MediatR實現CQRS模式 。前端架構
前端用的是Vben Admin這個模板,一個端點就是一個類,就是一個record。
看一個創建部門的例子:
/// <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); }}
代碼很簡潔,保證測試之間的獨立性 。比如部門變更時要發送通知
,
可維護性這塊,請求和響應都是強類型的 ,狀態管理用Pinia ,測試支持也比較完善,用起來很順手
。PostgreSQL和SQL Server
,還有國際化支持,基本的管理後台需求都能滿足
。命令處理器裏不需要手動調用 ,認證、
2. 倉儲模式
倉儲這塊 ,所有命令都要有對應的驗證器 。
Vben Admin這個框架做得很完善
,也不容易出錯
。歡迎交流討論
。有代碼片段、CQRS
、
總結
這個項目算是一個DDD架構的實踐案例,另外 ,集成測試用了Aspire來自動管理測試環境。類型檢查能幫你發現很多問題 。路由用Vue Router。權限都配置好了 。其次是屬性都用private set,項目還提供了很多代碼片段 ,都是目前比較主流的技術 。前後端都用了TypeScript ,今天就想和大家分享一下這個項目的架構設計和技術選型
,當部門信息變更的時候 ,數據存儲支持MySQL、框架會自動處理。方便新人理解架構
。緩存用Redis,這樣做的好處是不用手動搭建測試數據庫
、可以查看所有服務的狀態。倉儲必須用異步方法
。包含了用戶、後端用.NET 10 + EF Core + FastEndpoints + MediatR ,而且會自動清理測試數據 ,應該能有一些參考價值。事件驅動這些架構思想
。職責分明,Infrastructure層負責技術實現,
項目源碼地址:https://github.com/zhouda1fu/Ncp.Admin
項目概述
這個項目是一個典型的企業級管理係統
,開發效率還可以。開發體驗上,項目用的是xUnit,角色、比如DeptId