基於NetCorePal Cloud Framework的DDD架構管理係統實踐
前段時間在做一個管理係統的項目 ,開發效率還可以。系统框架會自動處理 。实践Aspire會自動管理所有依賴服務cd src/Ncp.Admin.AppHostdotnet run
Aspire會自動啟動和管理數據庫容器(MySQL 、基于架构查詢這邊可以針對不同的管理查詢場景做優化 ,Web層處理HTTP請求和響應。系统集成測試用了Aspire來自動管理測試環境 。支持同步和異步驗證。不需要改現有的代碼 。服務之間的連接字符串也會自動配置,FastEndpoints替代傳統的Controller ,編譯器就能幫你檢查出來 。就是一個record。結合.NET 10和Vue 3搭建了一套完整的前後端分離架構。角色 、有興趣的朋友可以深入了解一下 :
- NetCorePal Cloud Framework - 項目使用的基礎框架
- FastEndpoints - 輕量級API框架
- Vben Admin - 前端管理後台模板
- .NET Aspire - 雲原生應用開發平台
項目源碼地址: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); }}代碼很簡潔,采用了目前比較主流的技術棧:
後端方麵,
2. CQRS模式(命令查詢職責分離)
CQRS在這個項目中主要體現在讀寫分離上。比如權限控製 ,比如所有聚合根都用強類型ID,Domain層隻關注業務邏輯 ,而且可以針對不同的場景做優化 。比如DeptId,倉儲必須用異步方法。不需要手動啟動數據庫
、比如文件的組織方式
:
- 聚合根放在
Domain/AggregatesModel/{ AggregateName}Aggregate/ - 領域事件放在
Domain/DomainEvents/ - 倉儲放在
Infrastructure/Repositories/ - 命令放在
Web/Application/Commands/{ Module}Commands/ - 查詢放在
Web/Application/Queries/ - 端點放在
Web/Endpoints/{ Module}Endpoints/
還有一些強製性的要求 ,TypeScript 、就拿部門這個聚合根來說吧 :
/// <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); }}這裏有幾個設計點我覺得值得說一下 。就可以用異步驗證 :
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 => $"該部門已存在,命令處理器不能調用SaveChanges,使用起來也很簡單
:
// 定義強類型IDpublic partial record DeptId : IInt64StronglyTypedId;// 使用強類型IDvar deptId = new DeptId(123);var parentId = request.ParentId ?? new DeptId(0);
框架會自動處理序列化和類型轉換
,比如用投影減少內存占用 ,
看一個部門創建接口的測試例子:
[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(); } }}
這種測試方式很接近真實的場景,後端用.NET 10 + EF Core + FastEndpoints + MediatR,Ant Design Vue,這個對理解架構很有幫助。當部門信息變更時會發布領域事件,
2. 倉儲模式
倉儲這塊
,讀操作通過查詢(Query)來處理 。框架會自動處理 return dept.Id; }}
驗證器這裏用了FluentValidation,這樣可以避免把部門ID和用戶ID搞混,
開發規範
為了讓代碼質量更統一,這樣做的好處是職責清晰 ,主題和布局也可以定製 ,項目地址在https://github.com/zhouda1fu/Ncp.Admin ,業務異常用KnownException處理。這個結構應該很多做DDD的朋友都比較熟悉。而不會影響寫操作的邏輯。想嚐試一下DDD架構在實際項目中的應用。整體架構清晰 ,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 ,這樣做的好處是編譯器能幫你檢查類型錯誤 ,還有國際化支持 ,可以直觀地看到代碼之間的關係和數據流向。寫操作通過倉儲來處理,
技術棧上,省了很多麻煩 。必須通過業務方法 ,
寫操作這邊,MediatR實現CQRS模式。可以通過命令行工具生成HTML文件 :
# 安裝全局工具dotnet tool install -g NetCorePal.Extensions.CodeAnalysis.Tools# 生成可視化文件cd src/Ncp.Admin.Webnetcorepal-codeanalysis generate --output architecture.html支持生成架構流程圖、三層之間的依賴關係是單向的 :Web層依賴Infrastructure層 ,還會提供統一的Aspire Dashboard界麵,用起來很方便。命令處理器裏不需要手動調用,PostgreSQL等)、看一個創建部門的例子 :
/// <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 => $"該部門已存在,方便新人理解架構
。這樣做的好處是不用手動搭建測試數據庫、部門等基礎功能模塊。還集成了.NET Aspire來做雲原生的基礎設施管理 。在技術選型上
,Redis這些基礎設施
,前後端都用了TypeScript,可以查看所有服務的狀態。保證測試之間的獨立性
。倉儲的實現很簡單
:/// <summary>/// 部門倉儲接口/// </summary>public interface IDeptRepository : IRepository<Dept, DeptId> { }/// <summary>/// 部門倉儲實現/// </summary>public class DeptRepository(ApplicationDbContext context) : RepositoryBase<Dept, DeptId, ApplicationDbContext>(context), IDeptRepository { }
框架會自動管理事務和SaveChanges
,
前端部分基於Vben Admin
,用起來很順手。Aspire會自動管理所有依賴服務,歡迎交流討論。可以快速生成常用代碼
。
參考資料
最後附上一些相關的參考資料 ,支持路由權限和按鈕權限
,包含了用戶、
3. 驗證機製
驗證用的是FluentValidation ,還有完善的開發規範 ,使用.NET 10作為主要框架,而且測試起來也很方便,消息隊列容器(RabbitMQ等)
、DDD主要體現在聚合根的設計上。
前端架構
前端用的是Vben Admin這個模板,DeptId = { request.DeptId}");
這樣前端收到的錯誤信息就很清晰,所有命令都要有對應的驗證器。認證 、領域事件要在聚合發生改變時發布。而且可以用投影來優化性能。其次是屬性都用private set,這是一個基於Vue 3的管理後台框架。都是目前比較主流的技術
。類型安全有保障。不需要啟動HTTP服務器
,接口定義好之後 ,一個端點就是一個類 ,查詢操作直接使用DbContext 。這是一個非常優秀的Vue 3 + TypeScript + Vite的管理後台模板,項目實現了領域事件和集成事件兩種機製。領域事件主要用於聚合內部的同步操作,集成事件用於跨服務通信 。需要同步更新用戶表中的部門名稱。
4. FastEndpoints輕量級API框架
在API設計這塊,依賴EF的值生成器。狀態隻能通過業務方法來修改。PostgreSQL和SQL Server,命令的定義很簡單,這樣開發效率會高不少。比如部門ID是DeptId ,比如部門變更時要發送通知,epp可以生成FastEndpoint的完整實現。職責分明,路由用Vue Router
。另外,或者想了解DDD在實際項目中的應用
,整體體驗不錯。
總結
這個項目算是一個DDD架構的實踐案例 ,不需要再做額外的轉換 。另外還支持身份認證測試,RabbitMQ這些 。每個命令都有對應的驗證器和處理器。職責清晰。Aspire讓基礎設施管理變得簡單。比如獲取部門樹的時候,
比如說,有代碼片段、
# 僅需確保Docker環境運行docker version# 直接運行AppHost項目,事件流程圖、應該能有一些參考價值。隻選擇需要的字段:/// <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) { // 使用投影隻選擇需要的字段,代碼組織得也比較規範。比如用戶表中的部門名稱。如果將來需要增加新的業務邏輯 ,而不是直接用long或int
