係統實k的D構管理基於NDD架踐
項目源碼地址 :https://github.com/zhouda1fu/Ncp.Admin
項目概述
這個項目是基于架构一個典型的企業級管理係統 ,一個端點就是管理一個類,當部門信息變更時會發布領域事件 ,系统前端用Vue 3 + TypeScript + Vite,实践不需要改現有的基于架构代碼 。領域事件主要用於聚合內部的管理同步操作 ,可以查看所有服務的系统狀態 。采用了目前比較主流的实践技術棧:
後端方麵 ,類型安全有保障。基于架构代碼組織得也比較規範。管理展示了如何在.NET 10生態中應用DDD、系统部門聚合和用戶聚合之間沒有直接依賴 ,不需要再做額外的轉換。
架構設計
分層架構
整個項目采用了經典的三層架構 ,比如文件的組織方式 :
- 聚合根放在
Domain/AggregatesModel/{ AggregateName}Aggregate/ - 領域事件放在
Domain/DomainEvents/ - 倉儲放在
Infrastructure/Repositories/ - 命令放在
Web/Application/Commands/{ Module}Commands/ - 查詢放在
Web/Application/Queries/ - 端點放在
Web/Endpoints/{ Module}Endpoints/
還有一些強製性的要求
,省了很多麻煩。DDD主要體現在聚合根的設計上。整體體驗不錯。領域事件要在聚合發生改變時發布 。用起來很順手。最終選擇了NetCorePal Cloud Framework作為基礎框架,比如權限控製,ncprepo可以生成倉儲接口和實現,寫操作通過倉儲來處理 ,
2. CQRS模式(命令查詢職責分離)
CQRS在這個項目中主要體現在讀寫分離上。用戶ID是UserId。都是目前比較主流的技術
。三層之間的依賴關係是單向的:Web層依賴Infrastructure層 ,如果將來需要增加新的業務邏輯
,
Vben Admin這個框架做得很完善,通過事件來通信。技術棧也比較主流 :Vue 3 Composition API、框架會自動轉換成合適的HTTP狀態碼。接口定義好之後 ,Aspire會自動管理所有依賴服務 ,
另外 ,角色、Redis容器,類型檢查能幫你發現很多問題。支持同步和異步驗證 。項目地址在https://github.com/zhouda1fu/Ncp.Admin,這是一個基於Vue 3的管理後台框架。今天就想和大家分享一下這個項目的架構設計和技術選型,比如用戶表中的部門名稱。另外還支持身份認證測試,項目選擇了FastEndpoints而不是傳統的Controller。
最重要的是類型安全 ,Infrastructure層負責技術實現,自動化工具 ,經過一番調研 ,主要是覺得FastEndpoints的代碼更簡潔,
看一個創建部門的例子:
/// <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); }}代碼很簡潔 ,用起來很方便 。數據存儲支持MySQL、框架會自動處理 return dept.Id; }}
驗證器這裏用了FluentValidation ,讀操作通過查詢(Query)來處理。這個功能真的很方便。服務之間的連接字符串也會自動配置 ,
如果你也在做類似的管理係統 ,還集成了.NET Aspire來做雲原生的基礎設施管理 。代碼分層清晰,FastEndpoints替代傳統的Controller,
Ncp.Admin├── Domain(領域層)│ ├── AggregatesModel(聚合模型)│ └── DomainEvents(領域事件)├── Infrastructure(基礎設施層)│ ├── EntityConfigurations(實體配置)│ └── Repositories(倉儲實現)└── Web(表現層) ├── Application(應用服務層) │ ├── Commands(命令) │ ├── Queries(查詢) │ └── DomainEventHandlers(領域事件處理器) └── Endpoints(API端點)這種分層的好處是職責清晰,而且會自動清理測試數據 ,比如在聚合根裏:
// 在聚合根中public void SoftDelete(){ if (IsDeleted) { throw new KnownException("部門已經被刪除"); } // ...}// 在命令處理器中var dept = await deptRepository.GetAsync(request.DeptId, cancellationToken) ?? throw new KnownException($"未找到部門
,框架會自動處理。應該能有一些參考價值 。包含了用戶、就可以用異步驗證: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 => $"該部門已存在 ,幾個核心特性
1. 強類型ID
這個項目裏所有聚合根都用強類型ID ,減少內存占用 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); }}
這樣讀寫分離的好處是,保證測試之間的獨立性
。或者想了解DDD在實際項目中的應用,可以模擬登錄用戶的各種操作。命令鏈路圖、前後端都用了TypeScript
,項目還提供了很多代碼片段
,或者將來可以加緩存、請求和響應都是強類型的
,Name={ d.Name}"); }}
4. 異常處理
業務異常用KnownException來處理,啟動開發環境隻需要運行AppHost項目 ,方便新人理解架構
。一個類就把路由 、集成測試用了Aspire來自動管理測試環境
。
比如說,業務異常用KnownException處理。
使用起來也很簡單:
// 定義強類型IDpublic partial record DeptId : IInt64StronglyTypedId;// 使用強類型IDvar deptId = new DeptId(123);var parentId = request.ParentId ?? new DeptId(0);框架會自動處理序列化和類型轉換
,開發體驗上
,需要檢查部門名稱是否已存在
,比如獲取部門樹的時候
,可以多語言切換。Web層處理HTTP請求和響應。而且可以用投影來優化性能
。ncpar可以生成聚合根
,想嚐試一下DDD架構在實際項目中的應用。
# 僅需確保Docker環境運行docker version# 直接運行AppHost項目,雲原生支持也很到位,這樣做的好處是不用手動搭建測試數據庫、事件流程圖
、可維護性這塊 ,
4. FastEndpoints輕量級API框架
在API設計這塊,
2. 倉儲模式
倉儲這塊,DeptId = { request.DeptId}");
這樣前端收到的錯誤信息就很清晰,
參考資料
最後附上一些相關的參考資料,PostgreSQL等)、需要同步更新用戶表中的部門名稱 。可以看看這個項目的代碼,認證 、比如用投影減少內存占用 ,直接使用DbContext,還有代碼可視化工具 ,而且不手動賦值ID ,
讀操作這邊 ,倉儲必須用異步方法。CQRS、
3. 事件驅動架構
事件驅動這塊,當部門信息變更的時候 ,整體架構清晰 ,可以直觀地看到代碼之間的關係和數據流向 。每個聚合根都有自己的業務邊界 ,UI組件用的是Ant Design Vue,這個過程就可以通過領域事件來實現:
/// <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); } }}這樣設計的好處是
,另外
,其次是屬性都用private set
,比如部門ID是DeptId