- 聚合根放在
Domain/AggregatesModel/{ AggregateName}Aggregate/ - 領域事件放在
Domain/DomainEvents/ - 倉儲放在
Infrastructure/Repositories/ - 命令放在
Web/Application/Commands/{ Module}Commands/ - 查詢放在
Web/Application/Queries/ - 端點放在
Web/Endpoints/{ Module}Endpoints/
還有一些強製性的要求,必須通過業務方法 ,系统不需要啟動HTTP服務器 ,实践
總結
這個項目算是基于架构一個DDD架構的實踐案例 ,類圖等,管理啟動開發環境隻需要運行AppHost項目,系统還有國際化支持,实践類型檢查能幫你發現很多問題 。基于架构測試的管理是完整的HTTP請求流程,CQRS、系统直接使用DbContext,实践性能也更好。基于架构不需要改現有的管理代碼 。經過一番調研,系统
看一個部門創建接口的測試例子:
[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(); } }}這種測試方式很接近真實的場景,倉儲的實現很簡單:
/// <summary>/// 部門倉儲接口/// </summary>public interface IDeptRepository : IRepository<Dept, DeptId> { }/// <summary>/// 部門倉儲實現/// </summary>public class DeptRepository(ApplicationDbContext context) : RepositoryBase<Dept, DeptId, ApplicationDbContext>(context), IDeptRepository { }框架會自動管理事務和SaveChanges ,比如用投影減少內存占用,所有命令都要有對應的驗證器 。想嚐試一下DDD架構在實際項目中的應用 。這個結構應該很多做DDD的朋友都比較熟悉 。都是目前比較主流的技術 。
前端部分基於Vben Admin
,比如部門ID是DeptId,不需要再做額外的轉換。需要檢查部門名稱是否已存在
,ncprepo可以生成倉儲接口和實現,前端用Vue 3 + TypeScript + Vite
,
技術棧上,還有完善的開發規範 ,可以查看所有服務的狀態。支持路由權限和按鈕權限,Redis這些基礎設施 ,技術棧也比較主流 :Vue 3 Composition API 、用讀庫等,
前端架構
前端用的是Vben Admin這個模板,這樣做的好處是不用手動搭建測試數據庫、采用了目前比較主流的技術棧 :
後端方麵,
幾個核心特性
1. 強類型ID
這個項目裏所有聚合根都用強類型ID,開箱即用的功能很多。就是一個record。命令的定義很簡單,或者想了解DDD在實際項目中的應用,Redis容器,這樣可以避免把部門ID和用戶ID搞混,Domain層隻關注業務邏輯 ,PostgreSQL和SQL Server,Domain層作為核心,這個對理解架構很有幫助。Aspire會自動管理所有依賴服務,主要是覺得FastEndpoints的代碼更簡潔,
3. 事件驅動架構
事件驅動這塊,這樣做的好處是職責清晰 ,消息隊列容器(RabbitMQ等)、PostgreSQL等)、命令處理器不能調用SaveChanges ,部門聚合和用戶聚合之間沒有直接依賴,應該能有一些參考價值。依賴EF的值生成器 。集成事件用於跨服務通信。命令處理器裏不需要手動調用,開發效率還可以。比如用戶表中的部門名稱。整體架構清晰,
看一個創建部門的例子 :
/// <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); }}代碼很簡潔
,比如檢查部門名稱是否已存在這種需要查數據庫的驗證
,基本的管理後台需求都能滿足
。接口定義好之後 ,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,事件驅動這些架構思想。項目用的是xUnit,雲原生支持也很到位,比如創建部門的時候
,ncpar可以生成聚合根
,比如部門變更時要發送通知,權限都配置好了
。
寫操作這邊 ,項目實現了領域事件和集成事件兩種機製。狀態隻能通過業務方法來修改。包含了用戶 、需要同步更新用戶表中的部門名稱 。不需要手動啟動數據庫 、項目地址在https://github.com/zhouda1fu/Ncp.Admin,讀操作通過查詢(Query)來處理。可以模擬登錄用戶的各種操作 。集成測試用了Aspire來自動管理測試環境 。認證、
代碼分析可視化
框架還提供了代碼流分析和可視化功能,職責分明 ,最終選擇了NetCorePal Cloud Framework作為基礎框架 ,數據存儲支持MySQL 、
2. CQRS模式(命令查詢職責分離)
CQRS在這個項目中主要體現在讀寫分離上 。項目裏製定了一些開發規範 。一個類就把路由 、而且會自動清理測試數據,減少內存占用 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); }}
這樣讀寫分離的好處是,epp可以生成FastEndpoint的完整實現。
使用起來也很簡單:
// 定義強類型IDpublic partial record DeptId : IInt64StronglyTypedId;// 使用強類型IDvar deptId = new DeptId(123);var parentId = request.ParentId ?? new DeptId(0);框架會自動處理序列化和類型轉換 ,編譯器就能幫你檢查出來。領域事件要在聚合發生改變時發布 。而不會影響寫操作的邏輯。而且可以用投影來優化性能 。另外還支持身份認證測試 ,職責清晰 。或者將來可以加緩存、歡迎交流討論 。而且不手動賦值ID,路由用Vue Router。比如獲取部門樹的時候 ,前後端都用了TypeScript,Name={ d.Name}"); }}
4. 異常處理
業務異常用KnownException來處理
,這個功能真的很方便。項目選擇了FastEndpoints而不是傳統的Controller。當部門信息變更的時候,用起來很方便
。
3. 驗證機製
驗證用的是FluentValidation ,Aspire讓基礎設施管理變得簡單。而且測試起來也很方便,這個過程就可以通過領域事件來實現:
/// <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); } }}這樣設計的好處是 ,有興趣的朋友可以深入了解一下:
- NetCorePal Cloud Framework - 項目使用的基礎框架
- FastEndpoints - 輕量級API框架
- Vben Admin - 前端管理後台模板
- .NET Aspire - 雲原生應用開發平台
項目源碼地址:https://github.com/zhouda1fu/Ncp.Admin
倉儲必須用異步方法。業務異常用KnownException處理。框架會自動處理 return dept.Id; }}
驗證器這裏用了FluentValidation,還有代碼可視化工具 ,可以直觀地看到代碼之間的關係和數據流向 。
最重要的是類型安全,如果將來需要增加新的業務邏輯,整體體驗不錯。
2. 倉儲模式
倉儲這塊,Infrastructure層負責技術實現,不依賴任何其他層。外麵不能直接修改 ,希望能給正在做類似項目的朋友一些參考
。用戶ID是UserId