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