# 僅需確保Docker環境運行docker version# 直接運行AppHost項目 ,框架會自動處理
。整體體驗不錯 。基於NetCorePal Cloud Framework的DDD架構管理係統實踐
前段時間在做一個管理係統的項目
,這樣做的好處是職責清晰,
比如說,狀態隻能通過業務方法來修改
。需要檢查部門名稱是否已存在,還會提供統一的Aspire Dashboard界麵 ,而且會自動清理測試數據,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
,Aspire會自動管理所有依賴服務
,前後端都用了TypeScript ,啟動開發環境隻需要運行AppHost項目,或者想了解DDD在實際項目中的應用,比如部門ID是DeptId
,Domain層作為核心,
項目源碼地址 :https://github.com/zhouda1fu/Ncp.Admin
項目概述
這個項目是一個典型的企業級管理係統,也不容易出錯。數據存儲支持MySQL、職責分明,UI組件用的是Ant Design Vue,Redis
、如果將來需要增加新的業務邏輯
,還有國際化支持,就是一個record。雲原生支持也很到位
,這個對理解架構很有幫助。Infrastructure層依賴Domain層,必須通過業務方法,類型安全有保障。不會把部門ID和用戶ID搞混 。可以多語言切換。寫操作通過倉儲來處理,今天就想和大家分享一下這個項目的架構設計和技術選型,
開發規範
為了讓代碼質量更統一 ,保證測試之間的獨立性。
寫操作這邊
,不需要再做額外的轉換。
前端部分基於Vben Admin,比如DeptId
,查詢操作直接使用DbContext。Infrastructure層負責技術實現,這個結構應該很多做DDD的朋友都比較熟悉。可以看看這個項目的代碼 ,類圖等
,基本的管理後台需求都能滿足 。想嚐試一下DDD架構在實際項目中的應用。或者將來可以加緩存
、用起來很方便
。在技術選型上 ,
讀操作這邊
,ncpar可以生成聚合根
,代碼組織得也比較規範。領域事件要在聚合發生改變時發布
。
Vben Admin這個框架做得很完善
,項目用的是xUnit,比如ncpcmd可以生成命令及其驗證器和處理器,
總結
這個項目算是一個DDD架構的實踐案例,包含了用戶、性能也更好。ncprepo可以生成倉儲接口和實現 ,
最重要的是類型安全
,開發效率還可以。Domain層隻關注業務邏輯 ,開箱即用的功能很多
。MediatR實現CQRS模式。後端用.NET 10 + EF Core + FastEndpoints + MediatR,消息隊列選擇了RabbitMQ(通過CAP框架集成)
,直接使用DbContext
,
看一個部門創建接口的測試例子:
[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(); } }}
這種測試方式很接近真實的場景,
技術棧上
,這個功能真的很方便。這樣做的好處是不用手動搭建測試數據庫
、緩存用Redis ,命令處理器不能調用SaveChanges,事件驅動這些架構思想。用讀庫等
,
看一個創建部門的例子:
/// <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); }}
代碼很簡潔
,權限都配置好了
。而不是直接用long或int
。集成測試用了Aspire來自動管理測試環境。當部門信息變更的時候,可以模擬登錄用戶的各種操作。支持同步和異步驗證。就可以用異步的MustAsync。Aspire會自動啟動和管理。前端用Vue 3 + TypeScript + Vite
,接口定義好之後 ,
參考資料
最後附上一些相關的參考資料,Aspire讓基礎設施管理變得簡單。
2. 倉儲模式
倉儲這塊
,測試支持也比較完善,
架構設計
分層架構
整個項目采用了經典的三層架構
,有代碼片段
、請求和響應都是強類型的,自動化工具,這樣可以避免把部門ID和用戶ID搞混,類型檢查能幫你發現很多問題。都是目前比較主流的技術
。比如在聚合根裏:
// 在聚合根中public void SoftDelete(){ if (IsDeleted) { throw new KnownException("部門已經被刪除"); } // ...}// 在命令處理器中var dept = await deptRepository.GetAsync(request.DeptId, cancellationToken) ?? throw new KnownException($"未找到部門
,項目裏製定了一些開發規範。Name={ d.Name}"); }}
4. 異常處理
業務異常用KnownException來處理 ,PostgreSQL和SQL Server
,狀態管理用Pinia ,項目選擇了FastEndpoints而不是傳統的Controller。這個過程就可以通過領域事件來實現
:
/// <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); } }}
這樣設計的好處是
,依賴EF的值生成器
。需要同步更新用戶表中的部門名稱。
使用起來也很簡單
:
// 定義強類型IDpublic partial record DeptId : IInt64StronglyTypedId;// 使用強類型IDvar deptId = new DeptId(123);var parentId = request.ParentId ?? new DeptId(0);
框架會自動處理序列化和類型轉換,DDD主要體現在聚合根的設計上
。一個端點就是一個類 ,而且不手動賦值ID ,配合EF Core做數據訪問,路由用Vue Router。認證、隻選擇需要的字段:
/// <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) { // 使用投影隻選擇需要的字段
,其次是屬性都用private set
,而且測試起來也很方便 ,另外 ,主題和布局也可以定製,倉儲必須用異步方法
。CQRS、比如文件的組織方式:
- 聚合根放在
Domain/AggregatesModel/{ AggregateName}Aggregate/ - 領域事件放在
Domain/DomainEvents/ - 倉儲放在
Infrastructure/Repositories/ - 命令放在
Web/Application/Commands/{ Module}Commands/ - 查詢放在
Web/Application/Queries/ - 端點放在
Web/Endpoints/{ Module}Endpoints/
還有一些強製性的要求 ,應該能有一些參考價值。
雲原生支持
項目集成了.NET Aspire ,用戶ID是UserId。
測試策略
測試這塊,比如獲取部門樹的時候,
核心設計模式
1. 領域驅動設計(DDD)
在這個項目中
,這樣可以通知其他需要同步更新的地方
,不依賴任何其他層。
4. FastEndpoints輕量級API框架
在API設計這塊,寫操作通過命令(Command)來處理,省了很多麻煩。所有命令都要有對應的驗證器。
可維護性這塊
,比如檢查部門名稱是否已存在這種需要查數據庫的驗證,另外,一個類就把路由、事件流程圖、
幾個核心特性
1. 強類型ID
這個項目裏所有聚合根都用強類型ID,這是一個基於Vue 3的管理後台框架。倉儲的實現很簡單:
/// <summary>/// 部門倉儲接口/// </summary>public interface IDeptRepository : IRepository<Dept, DeptId> { }/// <summary>/// 部門倉儲實現/// </summary>public class DeptRepository(ApplicationDbContext context) : RepositoryBase<Dept, DeptId, ApplicationDbContext>(context), IDeptRepository { }
框架會自動管理事務和SaveChanges
,看一個創建部門的例子 :
/// <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 => $"該部門已存在,當部門信息變更時會發布領域事件 ,如果你也在做類似的管理係統
,
前端架構
前端用的是Vben Admin這個模板 ,技術棧也比較主流
:Vue 3 Composition API 、epp可以生成FastEndpoint的完整實現。消息隊列容器(RabbitMQ等)、