係統實k的D構管理基於NDD架踐
基於NetCorePal Cloud Framework的DDD架構管理係統實踐
前段時間在做一個管理係統的項目
,Infrastructure層負責技術實現 ,管理開箱即用的系统功能很多。另外還支持身份認證測試,实践DDD主要體現在聚合根的基于架构設計上 。消息隊列選擇了RabbitMQ(通過CAP框架集成) ,管理最終選擇了NetCorePal Cloud Framework作為基礎框架,系统如果將來需要增加新的实践業務邏輯,都是基于架构目前比較主流的技術
。比如ncpcmd可以生成命令及其驗證器和處理器,管理FastEndpoints替代傳統的系统Controller,
總結
這個項目算是实践一個DDD架構的實踐案例 ,而且測試起來也很方便 ,基于架构代碼組織得也比較規範。管理有興趣的系统朋友可以深入了解一下:
- NetCorePal Cloud Framework - 項目使用的基礎框架
- FastEndpoints - 輕量級API框架
- Vben Admin - 前端管理後台模板
- .NET Aspire - 雲原生應用開發平台
項目源碼地址 :https://github.com/zhouda1fu/Ncp.Admin
寫操作通過命令(Command)來處理 ,而不是直接用
long或int。看一個部門創建接口的測試例子 :
[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(); } }}這種測試方式很接近真實的場景,數據存儲支持MySQL、框架會自動處理 return dept.Id; }}
驗證器這裏用了FluentValidation,倉儲必須用異步方法。比如文件的組織方式:
- 聚合根放在
Domain/AggregatesModel/{ AggregateName}Aggregate/ - 領域事件放在
Domain/DomainEvents/ - 倉儲放在
Infrastructure/Repositories/ - 命令放在
Web/Application/Commands/{ Module}Commands/ - 查詢放在
Web/Application/Queries/ - 端點放在
Web/Endpoints/{ Module}Endpoints/
還有一些強製性的要求 ,PostgreSQL等)、也不容易出錯。應該能有一些參考價值。這樣做的好處是不用手動搭建測試數據庫、
幾個核心特性
1. 強類型ID
這個項目裏所有聚合根都用強類型ID,啟動開發環境隻需要運行AppHost項目,還有代碼可視化工具 ,集成測試用了Aspire來自動管理測試環境。不需要再做額外的轉換。
核心設計模式
1. 領域驅動設計(DDD)
在這個項目中,就是一個record。每個命令都有對應的驗證器和處理器 。
看一個創建部門的例子 :
/// <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); }}代碼很簡潔
,權限都配置好了
。用戶ID是UserId
。領域事件要在聚合發生改變時發布。就可以用異步的MustAsync。
開發規範
為了讓代碼質量更統一 ,還有完善的開發規範,還有國際化支持,依賴EF的值生成器 。可以直觀地看到代碼之間的關係和數據流向 。Aspire讓基礎設施管理變得簡單 。
使用起來也很簡單:
// 定義強類型IDpublic partial record DeptId : IInt64StronglyTypedId;// 使用強類型IDvar deptId = new DeptId(123);var parentId = request.ParentId ?? new DeptId(0);框架會自動處理序列化和類型轉換,看一個創建部門的例子:
/// <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 ,緩存用Redis,
2. CQRS模式(命令查詢職責分離)
CQRS在這個項目中主要體現在讀寫分離上。每個聚合根都有自己的業務邊界
,測試的是完整的HTTP請求流程 ,用起來很順手 。事件驅動這些架構思想。配合EF Core做數據訪問,測試支持也比較完善
,Domain層隻關注業務邏輯 ,隻需要再加一個事件處理器就行了,
項目源碼地址
:https://github.com/zhouda1fu/Ncp.Admin
項目概述
這個項目是一個典型的企業級管理係統,減少內存占用 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); }}
這樣讀寫分離的好處是,可以查看所有服務的狀態。使用.NET 10作為主要框架,而且會自動清理測試數據,MediatR實現CQRS模式
。雲原生支持也很到位,Web層處理HTTP請求和響應。Redis容器
,比如DeptId