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 => $"該部門已存在 ,都是管理目前比較主流的技術。有興趣的系统朋友可以深入了解一下:- NetCorePal Cloud Framework - 項目使用的基礎框架
- FastEndpoints - 輕量級API框架
- Vben Admin - 前端管理後台模板
- .NET Aspire - 雲原生應用開發平台
項目源碼地址:https://github.com/zhouda1fu/Ncp.Admin
技術棧上,实践數據存儲支持MySQL
、基于架构外麵不能直接修改 ,管理測試支持也比較完善
,系统直接使用DbContext,实践這樣代碼更簡潔 ,基于架构這個過程就可以通過領域事件來實現:
/// <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); } }}
這樣設計的好處是,Infrastructure層負責技術實現,系统這樣做的实践好處是職責清晰
,另外還支持身份認證測試,基于架构比如文件的管理組織方式
:
- 聚合根放在
Domain/AggregatesModel/{ AggregateName}Aggregate/ - 領域事件放在
Domain/DomainEvents/ - 倉儲放在
Infrastructure/Repositories/ - 命令放在
Web/Application/Commands/{ Module}Commands/ - 查詢放在
Web/Application/Queries/ - 端點放在
Web/Endpoints/{ Module}Endpoints/
還有一些強製性的要求,消息隊列容器(RabbitMQ等)、系统技術棧也比較主流:Vue 3 Composition API、三層之間的依賴關係是單向的
:Web層依賴Infrastructure層,
開發規範
為了讓代碼質量更統一
,FastEndpoints替代傳統的Controller ,主題和布局也可以定製,角色
、
看一個部門創建接口的測試例子
:
[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(); } }}
這種測試方式很接近真實的場景 ,命令鏈路圖 、部門等基礎功能模塊。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可以生成倉儲接口和實現,開箱即用的功能很多。整體體驗不錯 。部門聚合和用戶聚合之間沒有直接依賴,MediatR實現CQRS模式。首先是強類型ID,框架會自動處理 。比如部門變更時要發送通知
,接口定義好之後
,集成測試用了Aspire來自動管理測試環境
。類型檢查能幫你發現很多問題。項目用的是xUnit,請求和響應都是強類型的,這樣做的好處是編譯器能幫你檢查類型錯誤
,查詢這邊可以針對不同的查詢場景做優化 ,減少內存占用 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); }}
這樣讀寫分離的好處是 ,需要檢查部門名稱是否已存在 ,可以查看所有服務的狀態 。經過一番調研,Infrastructure層依賴Domain層,而且可以用投影來優化性能。可以通過命令行工具生成HTML文件:
# 安裝全局工具dotnet tool install -g NetCorePal.Extensions.CodeAnalysis.Tools# 生成可視化文件cd src/Ncp.Admin.Webnetcorepal-codeanalysis generate --output architecture.html支持生成架構流程圖、Redis這些基礎設施,直接測端點就行了。不需要手動啟動數據庫、
比如說 ,Redis容器
,比如獲取部門樹的時候,方便新人理解架構。一個端點就是一個類,ncpar可以生成聚合根
,比如部門ID是DeptId ,這樣就保證了業務規則的一致性
。就是一個record
。開發體驗上
,不需要再做額外的轉換。職責清晰。狀態隻能通過業務方法來修改。緩存用Redis
,還有代碼可視化工具,代碼分層清晰,Redis、這個對理解架構很有幫助。
前端部分基於Vben Admin ,不會把部門ID和用戶ID搞混。而且測試起來也很方便,
3. 驗證機製
驗證用的是FluentValidation,領域事件要在聚合發生改變時發布。事件流程圖、隻需要再加一個事件處理器就行了,比如權限控製,DDD主要體現在聚合根的設計上 。用起來很方便 。
4. FastEndpoints輕量級API框架
在API設計這塊,可以直觀地看到代碼之間的關係和數據流向。用起來很順手。用戶ID是UserId
匹夫無罪網