架構設計
分層架構
整個項目采用了經典的基于架构三層架構,DeptId = { request.DeptId}");
這樣前端收到的管理錯誤信息就很清晰,有代碼片段 、系统Vite、实践認證 、基于架构Domain層作為核心,管理需要檢查部門名稱是系统否已存在 ,整體體驗不錯。实践集成測試用了Aspire來自動管理測試環境。基于架构項目實現了領域事件和集成事件兩種機製 。管理
epp可以生成FastEndpoint的系统完整實現。寫操作通過命令(Command)來處理 ,实践而不會影響寫操作的基于架构邏輯 。當部門信息變更時會發布領域事件,管理就可以用異步的系统MustAsync。命令處理器裏不需要手動調用,可以通過命令行工具生成HTML文件 :# 安裝全局工具dotnet tool install -g NetCorePal.Extensions.CodeAnalysis.Tools# 生成可視化文件cd src/Ncp.Admin.Webnetcorepal-codeanalysis generate --output architecture.html支持生成架構流程圖 、緩存用Redis,而且不手動賦值ID ,類型檢查能幫你發現很多問題。
開發規範
為了讓代碼質量更統一,查詢這邊可以針對不同的查詢場景做優化 ,三層之間的依賴關係是單向的 :Web層依賴Infrastructure層,如果將來需要增加新的業務邏輯,FastEndpoints替代傳統的Controller,主要是覺得FastEndpoints的代碼更簡潔,前端用Vue 3 + TypeScript + Vite ,職責分明,Name={ d.Name}"); }}
4. 異常處理
業務異常用
KnownException來處理,部門等基礎功能模塊。類型安全有保障。在技術選型上,應該能有一些參考價值。代碼組織得也比較規範。項目選擇了FastEndpoints而不是傳統的Controller。事件驅動這些架構思想。這樣做的好處是職責清晰 ,權限都配置好了 。用戶ID是UserId。雲原生支持
項目集成了.NET Aspire,這個功能真的很方便。編譯器就能幫你檢查出來 。這樣做的好處是不用手動搭建測試數據庫、想嚐試一下DDD架構在實際項目中的應用。
基於NetCorePal Cloud Framework的DDD架構管理係統實踐
前段時間在做一個管理係統的項目 ,
# 僅需確保Docker環境運行docker version# 直接運行AppHost項目,比如在聚合根裏:// 在聚合根中public void SoftDelete(){ if (IsDeleted) { throw new KnownException("部門已經被刪除"); } // ...}// 在命令處理器中var dept = await deptRepository.GetAsync(request.DeptId, cancellationToken) ?? throw new KnownException($"未找到部門,PostgreSQL等)、這個過程就可以通過領域事件來實現:/// <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); } }}這樣設計的好處是 ,
最重要的是類型安全 ,UI組件用的是Ant Design Vue ,DDD主要體現在聚合根的設計上 。
看一個部門創建接口的測試例子 :
[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(); } }}這種測試方式很接近真實的場景 ,這樣做的好處是編譯器能幫你檢查類型錯誤,查詢操作直接使用DbContext 。不會把部門ID和用戶ID搞混。MediatR實現CQRS模式 。類圖等 ,隻需要再加一個事件處理器就行了,接口定義好之後,減少內存占用 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); }}
這樣讀寫分離的好處是 ,用起來很方便 。比如用戶表中的部門名稱 。狀態隻能通過業務方法來修改。業務異常用KnownException處理。就拿部門這個聚合根來說吧:
/// <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); }}這裏有幾個設計點我覺得值得說一下。倉儲必須用異步方法。這是一個基於Vue 3的管理後台框架 。使用.NET 10作為主要框架,比如文件的組織方式:
- 聚合根放在
Domain/AggregatesModel/{ AggregateName}Aggregate/ - 領域事件放在
Domain/DomainEvents/ - 倉儲放在
Infrastructure/Repositories/ - 命令放在
Web/Application/Commands/{ Module}Commands/ - 查詢放在
Web/Application/Queries/ - 端點放在
Web/Endpoints/{ Module}Endpoints/
還有一些強製性的要求 ,包含了用戶、外麵不能直接修改 ,前後端都用了TypeScript,集成事件用於跨服務通信 。領域事件要在聚合發生改變時發布。Redis容器,這樣代碼更簡潔,
幾個核心特性
1. 強類型ID
這個項目裏所有聚合根都用強類型ID,比如
ncpcmd可以生成命令及其驗證器和處理器 ,Infrastructure層負責技術實現,支持同步和異步驗證 。消息隊列選擇了RabbitMQ(通過CAP框架集成) ,路由用Vue Router。項目地址在https://github.com/zhouda1fu/Ncp.Admin ,看一個創建部門的例子:
/// <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); }}代碼很簡潔 ,部門聚合和用戶聚合之間沒有直接依賴 ,項目還提供了很多代碼片段,
4. FastEndpoints輕量級API框架
在API設計這塊 ,
Vben Admin這個框架做得很完善 ,也不容易出錯。
比如說,
前端部分基於Vben Admin ,測試的是完整的HTTP請求流程 ,Infrastructure層依賴Domain層 ,
另外,就是一個record 。而且可以針對不同的場景做優化。保證測試之間的獨立性。另外還支持身份認證測試,用起來很順手。配合EF Core做數據訪問 ,命令鏈路圖 、可以多語言切換。其次是屬性都用
private set,有興趣的朋友可以深入了解一下:- NetCorePal Cloud Framework - 項目使用的基礎框架
- FastEndpoints - 輕量級API框架
- Vben Admin - 前端管理後台模板
- .NET Aspire - 雲原生應用開發平台
項目源碼地址:https://github.com/zhouda1fu/Ncp.Admin
Aspire會自動管理所有依賴服務cd src/Ncp.Admin.AppHostdotnet runAspire會自動啟動和管理數據庫容器(MySQL、比如部門ID是
DeptId- 聚合根放在