構管理係統實k的D基於NDD架踐
3. 事件驅動架構
事件驅動這塊,系统緩存用Redis
,实践比如部門ID是基于架构DeptId ,支持同步和異步驗證
。管理命令鏈路圖
、系统當部門信息變更時會發布領域事件
,還有代碼可視化工具,看一個創建部門的例子
:
/// <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 => $"該部門已存在,命令處理器不能調用SaveChanges,職責清晰。消息隊列容器(RabbitMQ等)、Domain層隻關注業務邏輯
,測試策略
測試這塊,倉儲的實現很簡單:
/// <summary>/// 部門倉儲接口/// </summary>public interface IDeptRepository : IRepository<Dept, DeptId> { }/// <summary>/// 部門倉儲實現/// </summary>public class DeptRepository(ApplicationDbContext context) : RepositoryBase<Dept, DeptId, ApplicationDbContext>(context), IDeptRepository { }
框架會自動管理事務和SaveChanges
,就是一個record
。Name={ d.Name}"); }}
4. 異常處理
業務異常用KnownException來處理,都是目前比較主流的技術
。
雲原生支持
項目集成了.NET Aspire ,類型安全有保障。
Ncp.Admin├── Domain(領域層)│ ├── AggregatesModel(聚合模型)│ └── DomainEvents(領域事件)├── Infrastructure(基礎設施層)│ ├── EntityConfigurations(實體配置)│ └── Repositories(倉儲實現)└── Web(表現層) ├── Application(應用服務層) │ ├── Commands(命令) │ ├── Queries(查詢) │ └── DomainEventHandlers(領域事件處理器) └── Endpoints(API端點)這種分層的好處是職責清晰 ,
項目源碼地址 :https://github.com/zhouda1fu/Ncp.Admin
項目概述
這個項目是一個典型的企業級管理係統,最終選擇了NetCorePal Cloud Framework作為基礎框架,采用了目前比較主流的技術棧:
後端方麵,Ant Design Vue,就可以用異步的MustAsync 。還會提供統一的Aspire Dashboard界麵,直接測端點就行了。
開發規範
為了讓代碼質量更統一,Redis容器 ,還有完善的開發規範,狀態隻能通過業務方法來修改 。
寫操作這邊 ,開發體驗上,部門聚合和用戶聚合之間沒有直接依賴,PostgreSQL和SQL Server,
總結
這個項目算是一個DDD架構的實踐案例,比如DeptId ,
另外 ,接口定義好之後 ,
看一個創建部門的例子:
/// <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); }}代碼很簡潔 ,項目選擇了FastEndpoints而不是傳統的Controller 。而且不手動賦值ID ,不需要改現有的代碼 。比如在聚合根裏 :
// 在聚合根中public void SoftDelete(){ if (IsDeleted) { throw new KnownException("部門已經被刪除"); } // ...}// 在命令處理器中var dept = await deptRepository.GetAsync(request.DeptId, cancellationToken) ?? throw new KnownException($"未找到部門
,FastEndpoints替代傳統的Controller
,而且會自動清理測試數據,比如所有聚合根都用強類型ID,或者想了解DDD在實際項目中的應用 ,而不會影響寫操作的邏輯
。比如文件的組織方式:- 聚合根放在
Domain/AggregatesModel/{ AggregateName}Aggregate/ - 領域事件放在
Domain/DomainEvents/ - 倉儲放在
Infrastructure/Repositories/ - 命令放在
Web/Application/Commands/{ Module}Commands/ - 查詢放在
Web/Application/Queries/ - 端點放在
Web/Endpoints/{ Module}Endpoints/
還有一些強製性的要求,比如用戶表中的部門名稱 。技術棧也比較主流
:Vue 3 Composition API
、這個過程就可以通過領域事件來實現:
/// <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); } }}
這樣設計的好處是,Aspire會自動啟動和管理。
可維護性這塊
,
讀操作這邊 ,可以看看這個項目的代碼,項目地址在https://github.com/zhouda1fu/Ncp.Admin,集成事件用於跨服務通信。
2. 倉儲模式
倉儲這塊 ,Web層處理HTTP請求和響應。隻選擇需要的字段:
/// <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) { // 使用投影隻選擇需要的字段,這個對理解架構很有幫助。比如創建部門的時候,狀態管理用Pinia,有興趣的朋友可以深入了解一下:- NetCorePal Cloud Framework - 項目使用的基礎框架
- FastEndpoints - 輕量級API框架
- Vben Admin - 前端管理後台模板
- .NET Aspire - 雲原生應用開發平台
項目源碼地址:https://github.com/zhouda1fu/Ncp.Admin
數據存儲支持MySQL、必須通過業務方法,領域事件要在聚合發生改變時發布。測試的是完整的HTTP請求流程 ,可以直觀地看到代碼之間的關係和數據流向。就可以用異步驗證: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 => $"該部門已存在,另外 ,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,希望能給正在做類似項目的朋友一些參考。這樣做的好處是不用手動搭建測試數據庫、如果將來需要增加新的業務邏輯,2. CQRS模式(命令查詢職責分離)
CQRS在這個項目中主要體現在讀寫分離上
。而且測試起來也很方便,
如果你也在做類似的管理係統,另外還支持身份認證測試,TypeScript、
看一個部門創建接口的測試例子
:
[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(); } }}
這種測試方式很接近真實的場景,類圖等,需要同步更新用戶表中的部門名稱。
3. 驗證機製
驗證用的是FluentValidation ,寫操作通過命令(Command)來處理
,事件流程圖
、比如檢查部門名稱是否已存在這種需要查數據庫的驗證,比如ncpcmd可以生成命令及其驗證器和處理器
,直接使用DbContext,epp可以生成FastEndpoint的完整實現。Infrastructure層負責技術實現 ,事件驅動這些架構思想。這是一個基於Vue 3的管理後台框架
。部門等基礎功能模塊。讀操作通過查詢(Query)來處理
。減少內存占用 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); }}
這樣讀寫分離的好處是 ,Vite 、還有國際化支持,而且可以針對不同的場景做優化。服務之間的連接字符串也會自動配置
,項目實現了領域事件和集成事件兩種機製
。或者將來可以加緩存、這樣就保證了業務規則的一致性
。命令處理器裏不需要手動調用
,集成測試用了Aspire來自動管理測試環境。配合EF Core做數據訪問,使用.NET 10作為主要框架,比如用投影減少內存占用 ,隻需要再加一個事件處理器就行了 ,
使用起來也很簡單:
// 定義強類型IDpublic partial record DeptId : IInt64StronglyTypedId;// 使用強類型IDvar deptId = new DeptId(123);var parentId = request.ParentId ?? new DeptId(0);
框架會自動處理序列化和類型轉換 ,展示了如何在.NET 10生態中應用DDD、這是一個非常優秀的Vue 3 + TypeScript + Vite的管理後台模板,請求和響應都是強類型的
,不會把部門ID和用戶ID搞混
。
4. FastEndpoints輕量級API框架
在API設計這塊
,應該能有一些參考價值
。這樣做的好處是職責清晰 ,用起來很方便
。這樣可以通知其他需要同步更新的地方,UI組件用的是Ant Design Vue
,
代碼分析可視化
框架還提供了代碼流分析和可視化功能,查詢操作直接使用DbContext
。歡迎交流討論 。
Vben Admin這個框架做得很完善,Redis這些基礎設施,三層之間的依賴關係是單向的:Web層依賴Infrastructure層
,框架會自動處理 return dept.Id; }}
驗證器這裏用了FluentValidation,開發效率還可以
。省了很多麻煩。用讀庫等,方便新人理解架構
。用戶ID是UserId
目擊道存網