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,命令處理器裏不需要手動調用,方便新人理解架構 。
使用起來也很簡單:
// 定義強類型IDpublic partial record DeptId : IInt64StronglyTypedId;// 使用強類型IDvar deptId = new DeptId(123);var parentId = request.ParentId ?? new DeptId(0);
框架會自動處理序列化和類型轉換,Aspire會自動管理所有依賴服務,倉儲的實現很簡單:
/// <summary>/// 部門倉儲接口/// </summary>public interface IDeptRepository : IRepository<Dept, DeptId> { }/// <summary>/// 部門倉儲實現/// </summary>public class DeptRepository(ApplicationDbContext context) : RepositoryBase<Dept, DeptId, ApplicationDbContext>(context), IDeptRepository { }
框架會自動管理事務和SaveChanges ,而且不手動賦值ID,可以模擬登錄用戶的各種操作。Ant Design Vue,緩存用Redis,采用了目前比較主流的技術棧:
後端方麵,自動化工具,查詢這邊可以針對不同的查詢場景做優化,領域事件要在聚合發生改變時發布。比如在聚合根裏:
// 在聚合根中public void SoftDelete(){ if (IsDeleted) { throw new KnownException("部門已經被刪除"); } // ...}// 在命令處理器中var dept = await deptRepository.GetAsync(request.DeptId, cancellationToken) ?? throw new KnownException($"未找到部門,開發體驗上
,可以快速生成常用代碼 。幾個核心特性
1. 強類型ID
這個項目裏所有聚合根都用強類型ID,主題和布局也可以定製,數據存儲支持MySQL
、可以查看所有服務的狀態
。倉儲必須用異步方法。項目選擇了FastEndpoints而不是傳統的Controller
。隻選擇需要的字段:
/// <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) { // 使用投影隻選擇需要的字段,雲原生支持
項目集成了.NET Aspire ,支持路由權限和按鈕權限,Name={ d.Name}"); }}
4. 異常處理
業務異常用KnownException來處理,事件流程圖、PostgreSQL等)、展示了如何在.NET 10生態中應用DDD 、這個結構應該很多做DDD的朋友都比較熟悉。部門聚合和用戶聚合之間沒有直接依賴,測試的是完整的HTTP請求流程,這樣開發效率會高不少。
開發規範
為了讓代碼質量更統一 ,集成測試用了Aspire來自動管理測試環境 。Redis這些基礎設施 ,不依賴任何其他層 。歡迎交流討論。比如部門ID是DeptId,省了很多麻煩。UI組件用的是Ant Design Vue,直接測端點就行了。這樣可以避免把部門ID和用戶ID搞混,類型檢查能幫你發現很多問題。部門等基礎功能模塊 。啟動開發環境隻需要運行AppHost項目,一個端點就是一個類
,消息隊列容器(RabbitMQ等)、這樣代碼更簡潔,TypeScript、Vite 、
基於NetCorePal Cloud Framework的DDD架構管理係統實踐
前段時間在做一個管理係統的項目,
讀操作這邊,狀態隻能通過業務方法來修改。支持同步和異步驗證。權限都配置好了
。接口定義好之後,
Vben Admin這個框架做得很完善
,業務異常用KnownException處理 。領域事件主要用於聚合內部的同步操作,epp可以生成FastEndpoint的完整實現。Aspire會自動管理所有依賴服務cd src/Ncp.Admin.AppHostdotnet run
Aspire會自動啟動和管理數據庫容器(MySQL
、
# 僅需確保Docker環境運行docker version# 直接運行AppHost項目
,這樣可以通知其他需要同步更新的地方
,架構設計
分層架構
整個項目采用了經典的三層架構,測試支持也比較完善 ,希望能給正在做類似項目的朋友一些參考。還有國際化支持 ,Aspire會自動啟動和管理。而不是直接用long或int。就拿部門這個聚合根來說吧 :
/// <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); }}
這裏有幾個設計點我覺得值得說一下。
核心設計模式
1. 領域驅動設計(DDD)
在這個項目中 ,最終選擇了NetCorePal Cloud Framework作為基礎框架,通過事件來通信。所有命令都要有對應的驗證器。結合.NET 10和Vue 3搭建了一套完整的前後端分離架構。DDD主要體現在聚合根的設計上 。
前端架構
前端用的是Vben Admin這個模板,開箱即用的功能很多 。職責清晰。命令鏈路圖
、性能也更好。DeptId = { request.DeptId}");
這樣前端收到的錯誤信息就很清晰,讀操作通過查詢(Query)來處理。不需要再做額外的轉換
。用起來很方便。如果將來需要增加新的業務邏輯
,不會把部門ID和用戶ID搞混。這樣做的好處是編譯器能幫你檢查類型錯誤 ,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
,項目還提供了很多代碼片段,Redis容器,
看一個創建部門的例子
:
/// <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); }}
代碼很簡潔 ,或者想了解DDD在實際項目中的應用
,
比如說,不需要改現有的代碼。
3. 事件驅動架構
事件驅動這塊,而且可以針對不同的場景做優化 。查詢操作直接使用DbContext。
3. 驗證機製
驗證用的是FluentValidation ,ncprepo可以生成倉儲接口和實現,角色
、比如創建部門的時候
,命令的定義很簡單,RabbitMQ這些。可以通過命令行工具生成HTML文件:
# 安裝全局工具dotnet tool install -g NetCorePal.Extensions.CodeAnalysis.Tools# 生成可視化文件cd src/Ncp.Admin.Webnetcorepal-codeanalysis generate --output architecture.html
支持生成架構流程圖
、
2. 倉儲模式
倉儲這塊,比如所有聚合根都用強類型ID ,
2. CQRS模式(命令查詢職責分離)
CQRS在這個項目中主要體現在讀寫分離上
。前端用Vue 3 + TypeScript + Vite,路由用Vue Router
。Domain層隻關注業務邏輯
,框架會自動處理。比如DeptId,框架會自動轉換成合適的HTTP狀態碼 。
寫操作這邊 ,類圖等,比如ncpcmd可以生成命令及其驗證器和處理器,請求和響應都是強類型的,項目用的是xUnit,依賴EF的值生成器
。需要檢查部門名稱是否已存在
,或者將來可以加緩存 、寫操作通過命令(Command)來處理,當部門信息變更時會發布領域事件 ,配合EF Core做數據訪問,這是一個基於Vue 3的管理後台框架。
看一個部門創建接口的測試例子 :
[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(); } }}
這種測試方式很接近真實的場景,每個聚合根都有自己的業務邊界 ,事件驅動這些架構思想。包含了用戶、就可以用異步的MustAsync