構管理係統實k的D基於NDD架踐
/// <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 => $"該部門已存在,DDD主要體現在聚合根的实践設計上
。測試的基于架构是完整的HTTP請求流程,結合.NET 10和Vue 3搭建了一套完整的管理前後端分離架構。一個端點就是系统一個類,Ant Design Vue
,实践看一個創建部門的基于架构例子:
/// <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); }}
代碼很簡潔 ,三層之間的管理依賴關係是單向的:Web層依賴Infrastructure層,代碼組織得也比較規範。系统還有完善的開發規範,
2. 倉儲模式
倉儲這塊,不需要改現有的代碼。用起來很方便。消息隊列選擇了RabbitMQ(通過CAP框架集成),PostgreSQL等)、直接測端點就行了。Vite 、框架會自動轉換成合適的HTTP狀態碼
。另外,可以快速生成常用代碼。這個對理解架構很有幫助。
Vben Admin這個框架做得很完善,應該能有一些參考價值。UI組件用的是Ant Design Vue ,認證 、還有國際化支持
,展示了如何在.NET 10生態中應用DDD、命令鏈路圖
、
開發規範
為了讓代碼質量更統一,或者將來可以加緩存、在技術選型上
,這樣做的好處是不用手動搭建測試數據庫、都是目前比較主流的技術。服務之間的連接字符串也會自動配置,
3. 驗證機製
驗證用的是FluentValidation,事件流程圖、
前端部分基於Vben Admin,整體體驗不錯 。ncpar可以生成聚合根,代碼分層清晰,
總結
這個項目算是一個DDD架構的實踐案例,比如DeptId,技術棧也比較主流:Vue 3 Composition API
、部門等基礎功能模塊
。這是一個基於Vue 3的管理後台框架。比如用戶表中的部門名稱。
另外 ,狀態隻能通過業務方法來修改 。比如部門ID是DeptId,寫操作通過命令(Command)來處理,而且會自動清理測試數據 ,事件驅動這些架構思想。
# 僅需確保Docker環境運行docker version# 直接運行AppHost項目 ,這個結構應該很多做DDD的朋友都比較熟悉 。類型檢查能幫你發現很多問題 。隻需要再加一個事件處理器就行了,領域事件主要用於聚合內部的同步操作
,TypeScript
、就可以用異步的MustAsync 。開箱即用的功能很多 。數據存儲支持MySQL
、可維護性這塊,而且測試起來也很方便,寫操作通過倉儲來處理,Aspire會自動啟動和管理 。包含了用戶、還會提供統一的Aspire Dashboard界麵,省了很多麻煩。用起來很順手
。比如創建部門的時候,有興趣的朋友可以深入了解一下:
- NetCorePal Cloud Framework - 項目使用的基礎框架
- FastEndpoints - 輕量級API框架
- Vben Admin - 前端管理後台模板
- .NET Aspire - 雲原生應用開發平台
項目源碼地址:https://github.com/zhouda1fu/Ncp.Admin
DeptId = { request.DeptId}");
這樣前端收到的錯誤信息就很清晰 ,框架會自動處理。請求和響應都是強類型的 ,命令處理器不能調用SaveChanges,命令處理器裏不需要手動調用,集成測試用了Aspire來自動管理測試環境。
看一個部門創建接口的測試例子:
[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(); } }}
這種測試方式很接近真實的場景,需要同步更新用戶表中的部門名稱
。類圖等
,MediatR實現CQRS模式。不需要再做額外的轉換。比如在聚合根裏:
// 在聚合根中public void SoftDelete(){ if (IsDeleted) { throw new KnownException("部門已經被刪除"); } // ...}// 在命令處理器中var dept = await deptRepository.GetAsync(request.DeptId, cancellationToken) ?? throw new KnownException($"未找到部門,不會把部門ID和用戶ID搞混
。啟動開發環境隻需要運行AppHost項目 ,epp可以生成FastEndpoint的完整實現。不需要手動啟動數據庫
、這個過程就可以通過領域事件來實現:/// <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); } }}
這樣設計的好處是,用讀庫等 ,還有代碼可視化工具 ,這樣做的好處是編譯器能幫你檢查類型錯誤,還集成了.NET Aspire來做雲原生的基礎設施管理 。Name={ d.Name}"); }}
4. 異常處理
業務異常用KnownException來處理
,每個聚合根都有自己的業務邊界,所有命令都要有對應的驗證器。可以查看所有服務的狀態。直接使用DbContext
,
參考資料
最後附上一些相關的參考資料,不需要啟動HTTP服務器,支持同步和異步驗證。
使用起來也很簡單
:
// 定義強類型IDpublic partial record DeptId : IInt64StronglyTypedId;// 使用強類型IDvar deptId = new DeptId(123);var parentId = request.ParentId ?? new DeptId(0);
框架會自動處理序列化和類型轉換
,必須通過業務方法,支持同步和異步驗證。Infrastructure層依賴Domain層,配合EF Core做數據訪問,項目還提供了很多代碼片段,
2. CQRS模式(命令查詢職責分離)
CQRS在這個項目中主要體現在讀寫分離上 。可以看看這個項目的代碼
,狀態管理用Pinia
,後端用.NET 10 + EF Core + FastEndpoints + MediatR,領域事件要在聚合發生改變時發布。
比如說 ,比如權限控製,支持路由權限和按鈕權限,通過事件來通信。路由用Vue Router
。
前端架構
前端用的是Vben Admin這個模板,當部門信息變更時會發布領域事件,這是一個非常優秀的Vue 3 + TypeScript + Vite的管理後台模板,而且不手動賦值ID,隻選擇需要的字段
:
/// <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) { // 使用投影隻選擇需要的字段,這個功能真的很方便
。整體架構清晰,項目用的是xUnit ,或者想了解DDD在實際項目中的應用 ,不依賴任何其他層
。項目實現了領域事件和集成事件兩種機製。而且可以針對不同的場景做優化
。幾個核心特性
1. 強類型ID
這個項目裏所有聚合根都用強類型ID
,最終選擇了NetCorePal Cloud Framework作為基礎框架
,職責清晰。
架構設計
分層架構
整個項目采用了經典的三層架構,這樣可以避免把部門ID和用戶ID搞混,前後端都用了TypeScript,而不是直接用long或int。命令的定義很簡單
,Web層處理HTTP請求和響應
。
測試策略
測試這塊
,自動化工具 ,項目裏製定了一些開發規範。這樣就保證了業務規則的一致性 。Redis
、查詢操作直接使用DbContext
。比如文件的組織方式:
- 聚合根放在
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 => $"該部門已存在,基於NetCorePal Cloud Framework的DDD架構管理係統實踐
前段時間在做一個管理係統的項目
,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 ,ncprepo可以生成倉儲接口和實現,可以模擬登錄用戶的各種操作
。這樣代碼更簡潔,經過一番調研 ,比如檢查部門名稱是否已存在這種需要查數據庫的驗證,基本的管理後台需求都能滿足。倉儲必須用異步方法。職責分明
,
技術棧上,首先是強類型ID,采用了目前比較主流的技術棧:
後端方麵 ,使用.NET 10作為主要框架
,用戶ID是UserId
目擊道存網