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