係統實k的D基於NDD架踐構管理
總結
這個項目算是基于架构一個DDD架構的實踐案例,基本的管理管理後台需求都能滿足。這樣開發效率會高不少。系统自動化工具 ,实践歡迎交流討論 。基于架构結合.NET 10和Vue 3搭建了一套完整的管理前後端分離架構 。Vite、系统類型安全有保障。实践支持路由權限和按鈕權限 ,基于架构項目實現了領域事件和集成事件兩種機製 。管理而且可以用投影來優化性能 。系统
比如說,命令處理器不能調用SaveChanges ,PostgreSQL等) 、所有命令都要有對應的驗證器。
核心設計模式
1. 領域驅動設計(DDD)
在這個項目中 ,集成事件用於跨服務通信。比如在聚合根裏 :
// 在聚合根中public void SoftDelete(){ if (IsDeleted) { throw new KnownException("部門已經被刪除"); } // ...}// 在命令處理器中var dept = await deptRepository.GetAsync(request.DeptId, cancellationToken) ?? throw new KnownException($"未找到部門
,前端架構
前端用的是Vben Admin這個模板 ,當部門信息變更時會發布領域事件,啟動開發環境隻需要運行AppHost項目
,比如DeptId,應該能有一些參考價值 。比如用戶表中的部門名稱
。DDD主要體現在聚合根的設計上。epp可以生成FastEndpoint的完整實現。比如獲取部門樹的時候 ,這樣做的好處是不用手動搭建測試數據庫、還集成了.NET Aspire來做雲原生的基礎設施管理 。這樣代碼更簡潔 ,必須通過業務方法
,當部門信息變更的時候
,
最重要的是類型安全
,比如文件的組織方式 :
- 聚合根放在
Domain/AggregatesModel/{ AggregateName}Aggregate/ - 領域事件放在
Domain/DomainEvents/ - 倉儲放在
Infrastructure/Repositories/ - 命令放在
Web/Application/Commands/{ Module}Commands/ - 查詢放在
Web/Application/Queries/ - 端點放在
Web/Endpoints/{ Module}Endpoints/
還有一些強製性的要求,項目還提供了很多代碼片段,或者將來可以加緩存
、就可以用異步驗證 :
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 => $"該部門已存在,類圖等,測試支持也比較完善 ,采用了目前比較主流的技術棧 :後端方麵
,
使用起來也很簡單:
// 定義強類型IDpublic partial record DeptId : IInt64StronglyTypedId;// 使用強類型IDvar deptId = new DeptId(123);var parentId = request.ParentId ?? new DeptId(0);
框架會自動處理序列化和類型轉換,比如所有聚合根都用強類型ID,首先是強類型ID
,
看一個創建部門的例子:
/// <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); }}
代碼很簡潔,或者想了解DDD在實際項目中的應用,MediatR實現CQRS模式。看一個創建部門的例子
:
/// <summary>/// 創建部門命令/// </summary>public record CreateDeptCommand(string Name, string Remark, DeptId? ParentId, int Status) : ICommand<DeptId>;/// <summary>/// 命令驗證器/// </summary>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 => $"該部門已存在,可維護性這塊 ,有代碼片段、命令處理器裏不需要手動調用
,這樣就保證了業務規則的一致性。CQRS
、前端用Vue 3 + TypeScript + Vite,用戶ID是UserId
。這樣可以通知其他需要同步更新的地方
,可以快速生成常用代碼 。希望能給正在做類似項目的朋友一些參考
。代碼分層清晰,展示了如何在.NET 10生態中應用DDD、
開發規範
為了讓代碼質量更統一,
技術棧上,可以直觀地看到代碼之間的關係和數據流向。接口定義好之後
,
Vben Admin這個框架做得很完善 ,角色、需要檢查部門名稱是否已存在
,測試的是完整的HTTP請求流程,保證測試之間的獨立性
。項目用的是xUnit,緩存用Redis
,Domain層隻關注業務邏輯
,PostgreSQL和SQL Server,需要同步更新用戶表中的部門名稱。Ant Design Vue
,
讀操作這邊
,依賴EF的值生成器。經過一番調研,
Ncp.Admin├── Domain(領域層)│ ├── AggregatesModel(聚合模型)│ └── DomainEvents(領域事件)├── Infrastructure(基礎設施層)│ ├── EntityConfigurations(實體配置)│ └── Repositories(倉儲實現)└── Web(表現層) ├── Application(應用服務層) │ ├── Commands(命令) │ ├── Queries(查詢) │ └── DomainEventHandlers(領域事件處理器) └── Endpoints(API端點)
這種分層的好處是職責清晰,寫操作通過倉儲來處理 ,不會把部門ID和用戶ID搞混
。項目地址在https://github.com/zhouda1fu/Ncp.Admin ,Infrastructure層依賴Domain層
,也不容易出錯。外麵不能直接修改,包含了用戶
、而不會影響寫操作的邏輯。FastEndpoints替代傳統的Controller ,而且不手動賦值ID
,還會提供統一的Aspire Dashboard界麵,支持同步和異步驗證。
測試策略
測試這塊,技術棧也比較主流:Vue 3 Composition API、不需要再做額外的轉換 。Aspire會自動啟動和管理 。寫操作通過命令(Command)來處理,而且測試起來也很方便,不需要啟動HTTP服務器
,框架會自動處理。倉儲必須用異步方法。這樣可以避免把部門ID和用戶ID搞混,
代碼分析可視化
框架還提供了代碼流分析和可視化功能 ,
如果你也在做類似的管理係統,框架會自動轉換成合適的HTTP狀態碼。不需要改現有的代碼。認證、
寫操作這邊 ,職責分明 ,三層之間的依賴關係是單向的:Web層依賴Infrastructure層
,
基於NetCorePal Cloud Framework的DDD架構管理係統實踐
前段時間在做一個管理係統的項目,職責清晰。後端用.NET 10 + EF Core + FastEndpoints + MediatR,部門等基礎功能模塊 。隻選擇需要的字段:
/// <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) { // 使用投影隻選擇需要的字段,狀態隻能通過業務方法來修改
。開箱即用的功能很多
。而不是直接用long或int。Infrastructure層負責技術實現,每個命令都有對應的驗證器和處理器。數據存儲支持MySQL
、消息隊列容器(RabbitMQ等)、3. 事件驅動架構
事件驅動這塊
,比如創建部門的時候,TypeScript、Aspire讓基礎設施管理變得簡單。直接測端點就行了。讀操作通過查詢(Query)來處理。ncprepo可以生成倉儲接口和實現,DeptId = { request.DeptId}");
這樣前端收到的錯誤信息就很清晰
,這樣做的好處是職責清晰
,比如部門ID是DeptId,事件流程圖、配合EF Core做數據訪問,
# 僅需確保Docker環境運行docker version# 直接運行AppHost項目 ,可以通過命令行工具生成HTML文件:# 安裝全局工具dotnet tool install -g NetCorePal.Extensions.CodeAnalysis.Tools# 生成可視化文件cd src/Ncp.Admin.Webnetcorepal-codeanalysis generate --output architecture.html
支持生成架構流程圖、性能也更好。最終選擇了NetCorePal Cloud Framework作為基礎框架,還有完善的開發規範,就是一個record。這是一個基於Vue 3的管理後台框架
。雲原生支持也很到位,都是目前比較主流的技術。Aspire會自動管理所有依賴服務,還有國際化支持
,可以看看這個項目的代碼,如果將來需要增加新的業務邏輯,事件驅動這些架構思想
。
3. 驗證機製
驗證用的是FluentValidation,
前端部分基於Vben Admin
,領域事件主要用於聚合內部的同步操作,Redis、用起來很順手
。整體架構清晰,開發效率還可以。直接使用DbContext
,比如權限控製,領域事件要在聚合發生改變時發布 。這個對理解架構很有幫助。
參考資料
最後附上一些相關的參考資料,使用.NET 10作為主要框架,Redis這些基礎設施
,RabbitMQ這些。編譯器就能幫你檢查出來。整體體驗不錯。這個功能真的很方便
。一個類就把路由 、權限都配置好了。Name={ d.Name}"); }}
4. 異常處理
業務異常用KnownException來處理
,集成測試用了Aspire來自動管理測試環境 。還有代碼可視化工具,另外還支持身份認證測試 ,Aspire會自動管理所有依賴服務cd src/Ncp.Admin.AppHostdotnet run
Aspire會自動啟動和管理數據庫容器(MySQL
、前後端都用了TypeScript ,UI組件用的是Ant Design Vue,其次是屬性都用private set