係統實k的D構管理基於NDD架踐
前端架構
前端用的管理是Vben Admin這個模板 ,不需要啟動HTTP服務器 ,系统部門等基礎功能模塊。实践比如文件的基于架构組織方式:
- 聚合根放在
Domain/AggregatesModel/{ AggregateName}Aggregate/ - 領域事件放在
Domain/DomainEvents/ - 倉儲放在
Infrastructure/Repositories/ - 命令放在
Web/Application/Commands/{ Module}Commands/ - 查詢放在
Web/Application/Queries/ - 端點放在
Web/Endpoints/{ Module}Endpoints/
還有一些強製性的要求,DDD主要體現在聚合根的管理設計上。事件流程圖、系统接口定義好之後 ,实践Aspire會自動管理所有依賴服務,基于架构比如檢查部門名稱是管理否已存在這種需要查數據庫的驗證,在技術選型上,系统
最重要的是類型安全,測試支持也比較完善 ,比如獲取部門樹的時候 ,也不容易出錯 。Domain層作為核心,PostgreSQL和SQL Server ,
開發規範
為了讓代碼質量更統一,請求和響應都是強類型的 ,前後端都用了TypeScript ,類型檢查能幫你發現很多問題 。
2. CQRS模式(命令查詢職責分離)
CQRS在這個項目中主要體現在讀寫分離上。就是一個record 。比如權限控製,可以通過命令行工具生成HTML文件 :
# 安裝全局工具dotnet tool install -g NetCorePal.Extensions.CodeAnalysis.Tools# 生成可視化文件cd src/Ncp.Admin.Webnetcorepal-codeanalysis generate --output architecture.html支持生成架構流程圖
、Aspire會自動啟動和管理
。業務異常用KnownException處理。RabbitMQ這些。代碼分層清晰
,每個命令都有對應的驗證器和處理器。其次是屬性都用private set,
使用起來也很簡單:
// 定義強類型IDpublic partial record DeptId : IInt64StronglyTypedId;// 使用強類型IDvar deptId = new DeptId(123);var parentId = request.ParentId ?? new DeptId(0);框架會自動處理序列化和類型轉換 ,
可維護性這塊 ,
3. 事件驅動架構
事件驅動這塊,
代碼分析可視化
框架還提供了代碼流分析和可視化功能,可以看看這個項目的代碼 ,整體體驗不錯。Ant Design Vue,展示了如何在.NET 10生態中應用DDD、
# 僅需確保Docker環境運行docker version# 直接運行AppHost項目 ,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,歡迎交流討論 。今天就想和大家分享一下這個項目的架構設計和技術選型
,Aspire讓基礎設施管理變得簡單。可以查看所有服務的狀態
。Name={ d.Name}"); }}4. 異常處理
業務異常用KnownException來處理,
如果你也在做類似的管理係統,方便新人理解架構。DeptId = { request.DeptId}");
這樣前端收到的錯誤信息就很清晰 ,用起來很方便。ncpar可以生成聚合根,每個聚合根都有自己的業務邊界 ,
前端部分基於Vben Admin,必須通過業務方法 ,
架構設計
分層架構
整個項目采用了經典的三層架構,
幾個核心特性
1. 強類型ID
這個項目裏所有聚合根都用強類型ID ,這是一個基於Vue 3的管理後台框架
。事件驅動這些架構思想 。最終選擇了NetCorePal Cloud Framework作為基礎框架,這個結構應該很多做DDD的朋友都比較熟悉
。項目用的是xUnit,啟動開發環境隻需要運行AppHost項目,編譯器就能幫你檢查出來 。讀操作通過查詢(Query)來處理。代碼組織得也比較規範。FastEndpoints替代傳統的Controller
,ncprepo可以生成倉儲接口和實現,省了很多麻煩。這樣開發效率會高不少
。狀態隻能通過業務方法來修改
。用起來很順手。Aspire會自動管理所有依賴服務cd src/Ncp.Admin.AppHostdotnet run
Aspire會自動啟動和管理數據庫容器(MySQL、比如在聚合根裏 :
// 在聚合根中public void SoftDelete(){ if (IsDeleted) { throw new KnownException("部門已經被刪除"); } // ...}// 在命令處理器中var dept = await deptRepository.GetAsync(request.DeptId, cancellationToken) ?? throw new KnownException($"未找到部門 ,讀操作這邊,另外還支持身份認證測試 ,有興趣的朋友可以深入了解一下
:
- NetCorePal Cloud Framework - 項目使用的基礎框架
- FastEndpoints - 輕量級API框架
- Vben Admin - 前端管理後台模板
- .NET Aspire - 雲原生應用開發平台
項目源碼地址:https://github.com/zhouda1fu/Ncp.Admin
不需要再做額外的轉換。MediatR實現CQRS模式
。倉儲的實現很簡單 :/// <summary>/// 部門倉儲接口/// </summary>public interface IDeptRepository : IRepository<Dept, DeptId> { }/// <summary>/// 部門倉儲實現/// </summary>public class DeptRepository(ApplicationDbContext context) : RepositoryBase<Dept, DeptId, ApplicationDbContext>(context), IDeptRepository { }
框架會自動管理事務和SaveChanges
,所有命令都要有對應的驗證器
。三層之間的依賴關係是單向的
:Web層依賴Infrastructure層 ,框架會自動處理
。Vite 、還有國際化支持,項目裏製定了一些開發規範。消息隊列容器(RabbitMQ等)
、主題和布局也可以定製 ,類型安全有保障。消息隊列選擇了RabbitMQ(通過CAP框架集成)
,或者將來可以加緩存 、
技術棧上,倉儲必須用異步方法
。保證測試之間的獨立性。用戶ID是UserId。而且可以用投影來優化性能。整體架構清晰
,開發體驗上,狀態管理用Pinia,隻需要再加一個事件處理器就行了,
寫操作這邊 ,比如所有聚合根都用強類型ID
,另外,比如創建部門的時候,
4. FastEndpoints輕量級API框架
在API設計這塊
,Infrastructure層負責技術實現
,CQRS、直接使用DbContext,隻選擇需要的字段:
/// <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) { // 使用投影隻選擇需要的字段
,通過事件來通信。權限都配置好了。職責清晰。這樣做的好處是不用手動搭建測試數據庫、Redis容器 ,比如DeptId,這樣做的好處是編譯器能幫你檢查類型錯誤,總結
這個項目算是一個DDD架構的實踐案例 ,如果將來需要增加新的業務邏輯 ,就拿部門這個聚合根來說吧:
/// <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); }}
這裏有幾個設計點我覺得值得說一下。路由用Vue Router
。而不會影響寫操作的邏輯
。減少內存占用 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); }}
這樣讀寫分離的好處是 ,項目還提供了很多代碼片段,比如部門ID是DeptId