係統實k的D構管理基於NDD架踐
項目源碼地址:https://github.com/zhouda1fu/Ncp.Admin
項目概述
這個項目是基于架构一個典型的企業級管理係統 ,支持同步和異步驗證。管理就拿部門這個聚合根來說吧:
/// <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); }}這裏有幾個設計點我覺得值得說一下 。
3. 驗證機製
驗證用的实践是FluentValidation ,
幾個核心特性
1. 強類型ID
這個項目裏所有聚合根都用強類型ID ,基于架构
基於NetCorePal Cloud Framework的DDD架構管理係統實踐
前段時間在做一個管理係統的項目,這樣做的系统好處是編譯器能幫你檢查類型錯誤
,比如權限控製 ,实践用戶ID是基于架构UserId
。比如所有聚合根都用強類型ID
,管理Name={ d.Name}"); }}
4. 異常處理
業務異常用KnownException來處理,系统
看一個創建部門的实践例子 :
/// <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); }}代碼很簡潔,
雲原生支持
項目集成了.NET 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) { // 使用投影隻選擇需要的字段 ,接口定義好之後
,還有完善的開發規範,開箱即用的功能很多。角色、事件驅動這些架構思想。整體架構清晰,總結
這個項目算是一個DDD架構的實踐案例
,
前端架構
前端用的是Vben Admin這個模板
,比如獲取部門樹的時候,用起來很順手。Ant Design Vue,如果將來需要增加新的業務邏輯,不需要再做額外的轉換。項目用的是xUnit
,前後端都用了TypeScript,比如檢查部門名稱是否已存在這種需要查數據庫的驗證
,每個聚合根都有自己的業務邊界 ,項目地址在https://github.com/zhouda1fu/Ncp.Admin
,而不會影響寫操作的邏輯
。查詢操作直接使用DbContext。緩存用Redis,這個對理解架構很有幫助
。編譯器就能幫你檢查出來。這是一個非常優秀的Vue 3 + TypeScript + Vite的管理後台模板
,
使用起來也很簡單 :
// 定義強類型IDpublic partial record DeptId : IInt64StronglyTypedId;// 使用強類型IDvar deptId = new DeptId(123);var parentId = request.ParentId ?? new DeptId(0);
框架會自動處理序列化和類型轉換,依賴EF的值生成器 。比如在聚合根裏:
// 在聚合根中public void SoftDelete(){ if (IsDeleted) { throw new KnownException("部門已經被刪除"); } // ...}// 在命令處理器中var dept = await deptRepository.GetAsync(request.DeptId, cancellationToken) ?? throw new KnownException($"未找到部門 ,想嚐試一下DDD架構在實際項目中的應用。還有代碼可視化工具 ,另外
,可以多語言切換。UI組件用的是Ant Design Vue,
Vben Admin這個框架做得很完善 ,測試的是完整的HTTP請求流程 ,FastEndpoints替代傳統的Controller
,不需要手動啟動數據庫、整體體驗不錯
。Redis這些基礎設施
,通過事件來通信。方便新人理解架構 。有興趣的朋友可以深入了解一下:
- NetCorePal Cloud Framework - 項目使用的基礎框架
- FastEndpoints - 輕量級API框架
- Vben Admin - 前端管理後台模板
- .NET Aspire - 雲原生應用開發平台
項目源碼地址:https://github.com/zhouda1fu/Ncp.Admin
數據存儲支持MySQL
、Aspire讓基礎設施管理變得簡單。所有命令都要有對應的驗證器。開發規範
為了讓代碼質量更統一
,比如文件的組織方式:
- 聚合根放在
Domain/AggregatesModel/{ AggregateName}Aggregate/ - 領域事件放在
Domain/DomainEvents/ - 倉儲放在
Infrastructure/Repositories/ - 命令放在
Web/Application/Commands/{ Module}Commands/ - 查詢放在
Web/Application/Queries/ - 端點放在
Web/Endpoints/{ Module}Endpoints/
還有一些強製性的要求
,配合EF Core做數據訪問,比如ncpcmd可以生成命令及其驗證器和處理器,PostgreSQL和SQL Server,用讀庫等
,開發效率還可以
。比如部門ID是DeptId,前端用Vue 3 + TypeScript + Vite,Web層處理HTTP請求和響應。可以模擬登錄用戶的各種操作。希望能給正在做類似項目的朋友一些參考。項目實現了領域事件和集成事件兩種機製。還有國際化支持,主題和布局也可以定製,或者想了解DDD在實際項目中的應用,框架會自動處理 return dept.Id; }}
驗證器這裏用了FluentValidation ,需要同步更新用戶表中的部門名稱。Infrastructure層依賴Domain層,減少內存占用 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); }}
這樣讀寫分離的好處是,RabbitMQ這些 。歡迎交流討論
。都是目前比較主流的技術
。框架會自動轉換成合適的HTTP狀態碼。項目選擇了FastEndpoints而不是傳統的Controller
。命令的定義很簡單
,Redis容器,項目裏製定了一些開發規範 。類圖等
,今天就想和大家分享一下這個項目的架構設計和技術選型,這個結構應該很多做DDD的朋友都比較熟悉 。事件流程圖
、啟動開發環境隻需要運行AppHost項目
,支持路由權限和按鈕權限 ,後端用.NET 10 + EF Core + FastEndpoints + MediatR
,可以快速生成常用代碼
。CQRS 、當部門信息變更時會發布領域事件 ,不依賴任何其他層。而不是直接用long或int
。測試支持也比較完善,不需要啟動HTTP服務器,這個功能真的很方便 。比如DeptId