係統實k的D構管理基於NDD架踐
前端架構
前端用的管理是Vben Admin這個模板,部門聚合和用戶聚合之間沒有直接依賴,系统用起來很順手。实践命令的基于架构定義很簡單 ,可以看看這個項目的管理代碼,使用.NET 10作為主要框架 ,系统
2. 倉儲模式
倉儲這塊,实践方便新人理解架構。基于架构所有命令都要有對應的管理驗證器。服務之間的系统連接字符串也會自動配置 ,
前端部分基於Vben Admin ,实践Redis、基于架构消息隊列選擇了RabbitMQ(通過CAP框架集成) ,管理代碼組織得也比較規範。系统這個結構應該很多做DDD的朋友都比較熟悉 。而不是直接用long或int。主題和布局也可以定製,
可維護性這塊,
核心設計模式
1. 領域驅動設計(DDD)
在這個項目中 ,FastEndpoints替代傳統的Controller,就拿部門這個聚合根來說吧 :
/// <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); }}這裏有幾個設計點我覺得值得說一下 。比如部門變更時要發送通知,這樣做的好處是職責清晰,自動化工具
,還集成了.NET Aspire來做雲原生的基礎設施管理。集成事件用於跨服務通信。Redis這些基礎設施,比如DeptId ,
項目源碼地址 :https://github.com/zhouda1fu/Ncp.Admin
項目概述
這個項目是一個典型的企業級管理係統,接口定義好之後 ,查詢操作直接使用DbContext 。事件流程圖 、數據存儲支持MySQL、業務異常用KnownException處理。用起來很方便 。RabbitMQ這些 。
另外,這樣開發效率會高不少 。另外 ,比如部門ID是DeptId
,
架構設計
分層架構
整個項目采用了經典的三層架構,依賴EF的值生成器。歡迎交流討論 。就可以用異步驗證 :
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 => $"該部門已存在,其次是屬性都用private set,而且測試起來也很方便,省了很多麻煩。Vben Admin這個框架做得很完善
,部門等基礎功能模塊
。開發效率還可以。開發體驗上,這樣可以通知其他需要同步更新的地方 ,Domain層隻關注業務邏輯
,一個端點就是一個類
,命令鏈路圖、倉儲必須用異步方法。希望能給正在做類似項目的朋友一些參考。開箱即用的功能很多 。
# 僅需確保Docker環境運行docker version# 直接運行AppHost項目,總結
這個項目算是一個DDD架構的實踐案例,這個功能真的很方便。狀態管理用Pinia
,緩存用Redis
,主要是覺得FastEndpoints的代碼更簡潔,
代碼分析可視化
框架還提供了代碼流分析和可視化功能
,epp可以生成FastEndpoint的完整實現。保證測試之間的獨立性。隻選擇需要的字段:
/// <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) { // 使用投影隻選擇需要的字段,編譯器就能幫你檢查出來。可以通過命令行工具生成HTML文件:# 安裝全局工具dotnet tool install -g NetCorePal.Extensions.CodeAnalysis.Tools# 生成可視化文件cd src/Ncp.Admin.Webnetcorepal-codeanalysis generate --output architecture.html
支持生成架構流程圖、減少內存占用 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); }}
這樣讀寫分離的好處是,技術棧也比較主流:Vue 3 Composition API、測試支持也比較完善,每個聚合根都有自己的業務邊界,框架會自動處理
。比如在聚合根裏 :
// 在聚合根中public void SoftDelete(){ if (IsDeleted) { throw new KnownException("部門已經被刪除"); } // ...}// 在命令處理器中var dept = await deptRepository.GetAsync(request.DeptId, cancellationToken) ?? throw new KnownException($"未找到部門,ncprepo可以生成倉儲接口和實現
,請求和響應都是強類型的 ,必須通過業務方法,通過事件來通信。MediatR實現CQRS模式 。隻需要再加一個事件處理器就行了,不需要啟動HTTP服務器,還有代碼可視化工具 ,比如ncpcmd可以生成命令及其驗證器和處理器,首先是強類型ID,Aspire會自動管理所有依賴服務,權限都配置好了。直接測端點就行了。直接使用DbContext,比如所有聚合根都用強類型ID,也不容易出錯
。Aspire讓基礎設施管理變得簡單。領域事件要在聚合發生改變時發布
。前後端都用了TypeScript
,這樣可以避免把部門ID和用戶ID搞混
,包含了用戶、Infrastructure層負責技術實現,4. FastEndpoints輕量級API框架
在API設計這塊
,命令處理器裏不需要手動調用,當部門信息變更的時候 ,DeptId = { request.DeptId}");
這樣前端收到的錯誤信息就很清晰,項目裏製定了一些開發規範
。比如文件的組織方式:
- 聚合根放在
Domain/AggregatesModel/{ AggregateName}Aggregate/ - 領域事件放在
Domain/DomainEvents/ - 倉儲放在
Infrastructure/Repositories/ - 命令放在
Web/Application/Commands/{ Module}Commands/ - 查詢放在
Web/Application/Queries/ - 端點放在
Web/Endpoints/{ Module}Endpoints/
還有一些強製性的要求
,而不會影響寫操作的邏輯 。這樣就保證了業務規則的一致性
。可以多語言切換。用戶ID是UserId。另外還支持身份認證測試 ,代碼分層清晰,消息隊列容器(RabbitMQ等) 、在技術選型上,類型安全有保障
。項目用的是xUnit
,ncpar可以生成聚合根,職責清晰。比如權限控製
,狀態隻能通過業務方法來修改 。而且可以用投影來優化性能
。寫操作通過命令(Command)來處理
,有代碼片段
、或者想了解DDD在實際項目中的應用
,應該能有一些參考價值。Web層處理HTTP請求和響應。支持同步和異步驗證
。CQRS、可以模擬登錄用戶的各種操作
。項目地址在https://github.com/zhouda1fu/Ncp.Admin,這是一個基於Vue 3的管理後台框架 。PostgreSQL和SQL Server,這是一個非常優秀的Vue 3 + TypeScript + Vite的管理後台模板,而且可以針對不同的場景做優化 。
測試策略
測試這塊
,框架會自動處理 return dept.Id; }}
驗證器這裏用了FluentValidation,支持同步和異步驗證。需要檢查部門名稱是否已存在
,不會把部門ID和用戶ID搞混
。TypeScript、
3. 驗證機製
驗證用的是FluentValidation,就可以用異步的MustAsync