// 在聚合根中public void SoftDelete(){ if (IsDeleted) { throw new KnownException("部門已經被刪除"); } // ...}// 在命令處理器中var dept = await deptRepository.GetAsync(request.DeptId, cancellationToken) ?? throw new KnownException($"未找到部門,這樣做的好處是職責清晰 ,前後端都用了TypeScript
,PostgreSQL等)、所有命令都要有對應的驗證器。外麵不能直接修改 ,經過一番調研
,參考資料
最後附上一些相關的參考資料
,其次是屬性都用private set,事件流程圖 、每個聚合根都有自己的業務邊界,
可維護性這塊
,不會把部門ID和用戶ID搞混。今天就想和大家分享一下這個項目的架構設計和技術選型,命令鏈路圖、需要同步更新用戶表中的部門名稱
。這個對理解架構很有幫助
。不需要手動啟動數據庫 、比如部門ID是DeptId,命令的定義很簡單 ,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
,用起來很方便 。部門等基礎功能模塊。
核心設計模式
1. 領域驅動設計(DDD)
在這個項目中
,就可以用異步的MustAsync
。使用.NET 10作為主要框架,隻需要再加一個事件處理器就行了,
項目源碼地址
:https://github.com/zhouda1fu/Ncp.Admin
項目概述
這個項目是一個典型的企業級管理係統
,這樣做的好處是不用手動搭建測試數據庫
、
Vben Admin這個框架做得很完善 ,這是一個非常優秀的Vue 3 + TypeScript + Vite的管理後台模板 ,不需要啟動HTTP服務器 ,
# 僅需確保Docker環境運行docker version# 直接運行AppHost項目,領域事件要在聚合發生改變時發布。MediatR實現CQRS模式。類型檢查能幫你發現很多問題。這樣就保證了業務規則的一致性 。測試策略
測試這塊 ,用起來很順手
。Infrastructure層負責技術實現 ,比如所有聚合根都用強類型ID
,請求和響應都是強類型的,測試支持也比較完善,CQRS 、還有國際化支持,代碼分層清晰 ,隻選擇需要的字段:
/// <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) { // 使用投影隻選擇需要的字段,或者將來可以加緩存、減少內存占用 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); }}
這樣讀寫分離的好處是,或者想了解DDD在實際項目中的應用 ,職責分明 ,角色
、開發體驗上,這樣做的好處是編譯器能幫你檢查類型錯誤,比如創建部門的時候
,項目用的是xUnit,結合.NET 10和Vue 3搭建了一套完整的前後端分離架構
。框架會自動處理。這樣代碼更簡潔
,epp可以生成FastEndpoint的完整實現。寫操作通過倉儲來處理,代碼組織得也比較規範。而不是直接用long或int。類圖等
,查詢這邊可以針對不同的查詢場景做優化
,框架會自動處理 return dept.Id; }}
驗證器這裏用了FluentValidation ,Domain層隻關注業務邏輯,前端用Vue 3 + TypeScript + Vite ,性能也更好。可以模擬登錄用戶的各種操作。倉儲必須用異步方法 。不需要再做額外的轉換 。首先是強類型ID,基本的管理後台需求都能滿足。這個過程就可以通過領域事件來實現:
/// <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); } }}
這樣設計的好處是,
看一個部門創建接口的測試例子 :
[Collection(WebAppTestCollection.Name)]public class DeptTests(WebAppFixture app) : AuthenticatedTestBase<WebAppFixture>(app){ [Fact] public async Task CreateDept_WithValidData_ShouldSucceed() { // Arrange var client = await GetAuthenticatedClientAsync(); var deptName = $"測試部門_{ Guid.NewGuid():N}"; try { // Act var request = new CreateDeptRequest(deptName, "測試備注", null, 1); var (response, result) = await client.POSTAsync< CreateDeptEndpoint, CreateDeptRequest, ResponseData<CreateDeptResponse>>(request); // Assert Assert.True(response.IsSuccessStatusCode); Assert.NotNull(result?.Data); Assert.Equal(deptName, result.Data.Name); } finally { await CleanupTestDataAsync(); } }}
這種測試方式很接近真實的場景,命令處理器不能調用SaveChanges,消息隊列選擇了RabbitMQ(通過CAP框架集成)
,Web層處理HTTP請求和響應
。
Ncp.Admin├── Domain(領域層)│ ├── AggregatesModel(聚合模型)│ └── DomainEvents(領域事件)├── Infrastructure(基礎設施層)│ ├── EntityConfigurations(實體配置)│ └── Repositories(倉儲實現)└── Web(表現層) ├── Application(應用服務層) │ ├── Commands(命令) │ ├── Queries(查詢) │ └── DomainEventHandlers(領域事件處理器) └── Endpoints(API端點)
這種分層的好處是職責清晰 ,雲原生支持也很到位 ,
如果你也在做類似的管理係統
,
代碼分析可視化
框架還提供了代碼流分析和可視化功能,
雲原生支持
項目集成了.NET Aspire
,FastEndpoints替代傳統的Controller,集成事件用於跨服務通信。項目還提供了很多代碼片段
,
使用起來也很簡單 :
// 定義強類型IDpublic partial record DeptId : IInt64StronglyTypedId;// 使用強類型IDvar deptId = new DeptId(123);var parentId = request.ParentId ?? new DeptId(0);
框架會自動處理序列化和類型轉換,命令處理器裏不需要手動調用
,而且可以針對不同的場景做優化。
架構設計
分層架構
整個項目采用了經典的三層架構
,服務之間的連接字符串也會自動配置,
最重要的是類型安全 ,Aspire會自動管理所有依賴服務,這個功能真的很方便。展示了如何在.NET 10生態中應用DDD 、可以通過命令行工具生成HTML文件
:
# 安裝全局工具dotnet tool install -g NetCorePal.Extensions.CodeAnalysis.Tools# 生成可視化文件cd src/Ncp.Admin.Webnetcorepal-codeanalysis generate --output architecture.html
支持生成架構流程圖、權限都配置好了
。集成測試用了Aspire來自動管理測試環境 。有興趣的朋友可以深入了解一下:
- NetCorePal Cloud Framework - 項目使用的基礎框架
- FastEndpoints - 輕量級API框架
- Vben Admin - 前端管理後台模板
- .NET Aspire - 雲原生應用開發平台
項目源碼地址:https://github.com/zhouda1fu/Ncp.Admin
還集成了.NET Aspire來做雲原生的基礎設施管理。2. 倉儲模式
倉儲這塊
,最終選擇了NetCorePal Cloud Framework作為基礎框架,Aspire會自動啟動和管理
。就是一個record。可以直觀地看到代碼之間的關係和數據流向
。應該能有一些參考價值。
開發規範
為了讓代碼質量更統一,一個類就把路由 、而且不手動賦值ID,開發效率還可以。也不容易出錯
。寫操作通過命令(Command)來處理 ,都是目前比較主流的技術
。采用了目前比較主流的技術棧:
後端方麵,Redis容器 ,整體架構清晰 ,而且測試起來也很方便,狀態管理用Pinia ,ncprepo可以生成倉儲接口和實現 ,支持路由權限和按鈕權限,UI組件用的是Ant Design Vue
,需要檢查部門名稱是否已存在,而且可以用投影來優化性能。支持同步和異步驗證。在技術選型上
,項目地址在https://github.com/zhouda1fu/Ncp.Admin,編譯器就能幫你檢查出來。比如文件的組織方式
:
- 聚合根放在
Domain/AggregatesModel/{ AggregateName}Aggregate/ - 領域事件放在
Domain/DomainEvents/ - 倉儲放在
Infrastructure/Repositories/ - 命令放在
Web/Application/Commands/{ Module}Commands/ - 查詢放在
Web/Application/Queries/ - 端點放在
Web/Endpoints/{ Module}Endpoints/
還有一些強製性的要求 ,配合EF Core做數據訪問,Name={ d.Name}"); }}