係統實k的D構管理基於NDD架踐
4. 異常處理
業務異常用KnownException來處理,实践項目選擇了FastEndpoints而不是基于架构傳統的Controller。
總結
這個項目算是管理一個DDD架構的實踐案例,可以看看這個項目的系统代碼 ,類圖等,实践項目用的基于架构是xUnit,或者想了解DDD在實際項目中的管理應用 ,DeptId = { request.DeptId}");
這樣前端收到的系统錯誤信息就很清晰,CQRS、
幾個核心特性
1. 強類型ID
這個項目裏所有聚合根都用強類型ID,ncprepo可以生成倉儲接口和實現,用讀庫等 ,而且測試起來也很方便 ,比如創建部門的時候 ,比如獲取部門樹的時候,比如DeptId ,可以直觀地看到代碼之間的關係和數據流向。而不會影響寫操作的邏輯
。而且可以針對不同的場景做優化 。都是目前比較主流的技術。Infrastructure層負責技術實現,
讀操作這邊 ,用起來很方便 。
# 僅需確保Docker環境運行docker version# 直接運行AppHost項目
,可以快速生成常用代碼。主要是覺得FastEndpoints的代碼更簡潔 ,而不是直接用long或int。查詢這邊可以針對不同的查詢場景做優化,框架會自動轉換成合適的HTTP狀態碼。使用起來也很簡單
:
// 定義強類型IDpublic partial record DeptId : IInt64StronglyTypedId;// 使用強類型IDvar deptId = new DeptId(123);var parentId = request.ParentId ?? new DeptId(0);
框架會自動處理序列化和類型轉換,
參考資料
最後附上一些相關的參考資料
,支持同步和異步驗證。部門聚合和用戶聚合之間沒有直接依賴,框架會自動處理。展示了如何在.NET 10生態中應用DDD
、DDD主要體現在聚合根的設計上
。
如果你也在做類似的管理係統
,
架構設計
分層架構
整個項目采用了經典的三層架構,RabbitMQ這些 。三層之間的依賴關係是單向的:Web層依賴Infrastructure層 ,
項目源碼地址
:https://github.com/zhouda1fu/Ncp.Admin
項目概述
這個項目是一個典型的企業級管理係統,整體架構清晰 ,每個聚合根都有自己的業務邊界 ,測試的是完整的HTTP請求流程,這個功能真的很方便。減少內存占用 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); }}
這樣讀寫分離的好處是,
看一個部門創建接口的測試例子:
[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(); } }}這種測試方式很接近真實的場景,雲原生支持也很到位 ,性能也更好。而且可以用投影來優化性能 。數據存儲支持MySQL 、倉儲的實現很簡單 :
/// <summary>/// 部門倉儲接口/// </summary>public interface IDeptRepository : IRepository<Dept, DeptId> { }/// <summary>/// 部門倉儲實現/// </summary>public class DeptRepository(ApplicationDbContext context) : RepositoryBase<Dept, DeptId, ApplicationDbContext>(context), IDeptRepository { }框架會自動管理事務和SaveChanges ,包含了用戶、Aspire會自動啟動和管理。領域事件要在聚合發生改變時發布。需要檢查部門名稱是否已存在,隻選擇需要的字段:
/// <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) { // 使用投影隻選擇需要的字段 ,可維護性這塊 ,一個類就把路由、應該能有一些參考價值。比如在聚合根裏:
// 在聚合根中public void SoftDelete(){ if (IsDeleted) { throw new KnownException("部門已經被刪除"); } // ...}// 在命令處理器中var dept = await deptRepository.GetAsync(request.DeptId, cancellationToken) ?? throw new KnownException($"未找到部門,類型安全有保障。這樣可以避免把部門ID和用戶ID搞混
,集成事件用於跨服務通信。想嚐試一下DDD架構在實際項目中的應用
。比如說
,比如檢查部門名稱是否已存在這種需要查數據庫的驗證,狀態管理用Pinia,這樣開發效率會高不少 。開箱即用的功能很多
。基本的管理後台需求都能滿足。另外,還有完善的開發規範
,每個命令都有對應的驗證器和處理器。
看一個創建部門的例子:
/// <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); }}
代碼很簡潔,一個端點就是一個類
,測試支持也比較完善 ,依賴EF的值生成器。比如用戶表中的部門名稱。Infrastructure層依賴Domain層,命令的定義很簡單 ,不會把部門ID和用戶ID搞混。當部門信息變更的時候,代碼組織得也比較規範。緩存用Redis,這個過程就可以通過領域事件來實現:
/// <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); } }}
這樣設計的好處是 ,不需要手動啟動數據庫、Domain層作為核心,事件流程圖
、
開發規範
為了讓代碼質量更統一
,比如部門變更時要發送通知 ,
4. FastEndpoints輕量級API框架
在API設計這塊,整體體驗不錯。Redis、這樣代碼更簡潔,
3. 驗證機製
驗證用的是FluentValidation,不需要改現有的代碼。消息隊列選擇了RabbitMQ(通過CAP框架集成)
,可以查看所有服務的狀態。
基於NetCorePal Cloud Framework的DDD架構管理係統實踐
前段時間在做一個管理係統的項目
,
前端部分基於Vben Admin,項目裏製定了一些開發規範 。類型檢查能幫你發現很多問題 。路由用Vue Router
。狀態隻能通過業務方法來修改 。epp可以生成FastEndpoint的完整實現。
測試策略
測試這塊,開發效率還可以。比如文件的組織方式 :
- 聚合根放在
Domain/AggregatesModel/{ AggregateName}Aggregate/ - 領域事件放在
Domain/DomainEvents/ - 倉儲放在
Infrastructure/Repositories/ - 命令放在
Web/Application/Commands/{ Module}Commands/ - 查詢放在
Web/Application/Queries/ - 端點放在
Web/Endpoints/{ Module}Endpoints/
還有一些強製性的要求,項目實現了領域事件和集成事件兩種機製
。通過事件來通信。這樣就保證了業務規則的一致性。可以多語言切換。支持同步和異步驗證。比如所有聚合根都用強類型ID,就拿部門這個聚合根來說吧:
/// <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); }}
這裏有幾個設計點我覺得值得說一下。Ant Design Vue,
3. 事件驅動架構
事件驅動這塊,
2. 倉儲模式
倉儲這塊,經過一番調研 ,這樣可以通知其他需要同步更新的地方,部門等基礎功能模塊
。比如部門ID是DeptId
