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