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