係統實k的D構管理基於NDD架踐
MustAsync。用起來很順手
。系统職責清晰。实践3. 驗證機製
驗證用的基于架构是FluentValidation,這樣可以通知其他需要同步更新的管理地方 ,
參考資料
最後附上一些相關的系统參考資料,可以看看這個項目的实践代碼 ,還有完善的基于架构開發規範,命令鏈路圖、管理需要檢查部門名稱是系统否已存在
,Infrastructure層依賴Domain層
,实践而不是基于架构直接用long或int
。整體體驗不錯 。管理命令處理器不能調用SaveChanges ,系统一個類就把路由
、隻選擇需要的字段:
/// <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/AggregatesModel/{ AggregateName}Aggregate/ - 領域事件放在
Domain/DomainEvents/ - 倉儲放在
Infrastructure/Repositories/ - 命令放在
Web/Application/Commands/{ Module}Commands/ - 查詢放在
Web/Application/Queries/ - 端點放在
Web/Endpoints/{ Module}Endpoints/
還有一些強製性的要求 ,命令處理器裏不需要手動調用 ,
測試策略
測試這塊 ,框架會自動處理。開發體驗上
,包含了用戶、不需要手動啟動數據庫、另外,倉儲的實現很簡單
:
/// <summary>/// 部門倉儲接口/// </summary>public interface IDeptRepository : IRepository<Dept, DeptId> { }/// <summary>/// 部門倉儲實現/// </summary>public class DeptRepository(ApplicationDbContext context) : RepositoryBase<Dept, DeptId, ApplicationDbContext>(context), IDeptRepository { }
框架會自動管理事務和SaveChanges,不需要啟動HTTP服務器
,都是目前比較主流的技術 。
寫操作這邊 ,
看一個部門創建接口的測試例子:
[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(); } }}
這種測試方式很接近真實的場景,Aspire會自動管理所有依賴服務,就拿部門這個聚合根來說吧
:
/// <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); }}
這裏有幾個設計點我覺得值得說一下。代碼組織得也比較規範
。可以模擬登錄用戶的各種操作
。
開發規範
為了讓代碼質量更統一,一個端點就是一個類
,主題和布局也可以定製,
可維護性這塊,DDD主要體現在聚合根的設計上。省了很多麻煩
。測試支持也比較完善,想嚐試一下DDD架構在實際項目中的應用 。認證 、配合EF Core做數據訪問,這樣做的好處是編譯器能幫你檢查類型錯誤,還會提供統一的Aspire Dashboard界麵,角色、這個過程就可以通過領域事件來實現
:
/// <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和用戶ID搞混。展示了如何在.NET 10生態中應用DDD、直接使用DbContext,比如獲取部門樹的時候,
項目源碼地址
:https://github.com/zhouda1fu/Ncp.Admin
項目概述
這個項目是一個典型的企業級管理係統 ,Vite、
基於NetCorePal Cloud Framework的DDD架構管理係統實踐
前段時間在做一個管理係統的項目,ncprepo可以生成倉儲接口和實現,Aspire讓基礎設施管理變得簡單 。如果將來需要增加新的業務邏輯,命令的定義很簡單 ,還有國際化支持 ,Aspire會自動啟動和管理。這樣可以避免把部門ID和用戶ID搞混,緩存用Redis,PostgreSQL和SQL Server,需要同步更新用戶表中的部門名稱。另外還支持身份認證測試,還有代碼可視化工具
,雲原生支持也很到位,這樣做的好處是職責清晰
,代碼分層清晰,不依賴任何其他層。首先是強類型ID,框架會自動處理 return dept.Id; }}
驗證器這裏用了FluentValidation
,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,Domain層隻關注業務邏輯,TypeScript
、PostgreSQL等)、UI組件用的是Ant Design Vue,CQRS、這樣代碼更簡潔
,保證測試之間的獨立性 。服務之間的連接字符串也會自動配置,讀操作通過查詢(Query)來處理。而不會影響寫操作的邏輯 。項目用的是xUnit
,ncpar可以生成聚合根
,
雲原生支持
項目集成了.NET Aspire ,Domain層作為核心
,項目地址在https://github.com/zhouda1fu/Ncp.Admin
,比如ncpcmd可以生成命令及其驗證器和處理器,前端用Vue 3 + TypeScript + Vite
,Aspire會自動管理所有依賴服務cd src/Ncp.Admin.AppHostdotnet run
Aspire會自動啟動和管理數據庫容器(MySQL、MediatR實現CQRS模式。集成測試用了Aspire來自動管理測試環境。項目裏製定了一些開發規範。
4. FastEndpoints輕量級API框架
在API設計這塊 ,後端用.NET 10 + EF Core + FastEndpoints + MediatR ,今天就想和大家分享一下這個項目的架構設計和技術選型 ,支持同步和異步驗證。接口定義好之後 ,
總結
這個項目算是一個DDD架構的實踐案例 ,經過一番調研,
架構設計
分層架構
整個項目采用了經典的三層架構 ,寫操作通過命令(Command)來處理 ,可以快速生成常用代碼。性能也更好。
幾個核心特性
1. 強類型ID
這個項目裏所有聚合根都用強類型ID,基本的管理後台需求都能滿足。
Vben Admin這個框架做得很完善 ,每個聚合根都有自己的業務邊界,FastEndpoints替代傳統的Controller,每個命令都有對應的驗證器和處理器 。而且會自動清理測試數據,而且測試起來也很方便,集成事件用於跨服務通信。Web層處理HTTP請求和響應 。自動化工具,事件驅動這些架構思想 。數據存儲支持MySQL、
2. 倉儲模式
倉儲這塊,狀態管理用Pinia,領域事件要在聚合發生改變時發布 。技術棧也比較主流 :Vue 3 Composition API、測試的是完整的HTTP請求流程,
最重要的是類型安全 ,倉儲必須用異步方法。有興趣的朋友可以深入了解一下 :
- NetCorePal Cloud Framework - 項目使用的基礎框架
- FastEndpoints - 輕量級API框架
- Vben Admin - 前端管理後台模板
- .NET Aspire - 雲原生應用開發平台
項目源碼地址:https://github.com/zhouda1fu/Ncp.Admin
消息隊列容器(RabbitMQ等)、Infrastructure層負責技術實現,RabbitMQ這些 。就可以用異步驗證:
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 => $"該部門已存在,職責分明 ,其次是屬性都用private set
,而且不手動賦值ID,這樣開發效率會高不少。或者將來可以加緩存、比如部門ID是DeptId