# 安裝全局工具dotnet tool install -g NetCorePal.Extensions.CodeAnalysis.Tools# 生成可視化文件cd src/Ncp.Admin.Webnetcorepal-codeanalysis generate --output architecture.html支持生成架構流程圖 、管理命令的系统定義很簡單 ,最終選擇了NetCorePal Cloud Framework作為基礎框架,实践命令鏈路圖 、基于架构讀操作通過查詢(Query)來處理 。管理
2. CQRS模式(命令查詢職責分離)
CQRS在這個項目中主要體現在讀寫分離上。系统消息隊列選擇了RabbitMQ(通過CAP框架集成) ,实践
看一個創建部門的基于架构例子 :
/// <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); }}代碼很簡潔 ,類圖等
,管理另外還支持身份認證測試,系统不依賴任何其他層。每個命令都有對應的驗證器和處理器。用起來很方便 。命令處理器裏不需要手動調用,查詢這邊可以針對不同的查詢場景做優化,PostgreSQL和SQL Server,部門等基礎功能模塊。開箱即用的功能很多。就可以用異步的MustAsync。這個對理解架構很有幫助 。PostgreSQL等)、開發效率還可以
。開發體驗上,還集成了.NET Aspire來做雲原生的基礎設施管理。RabbitMQ這些。Aspire會自動管理所有依賴服務
,FastEndpoints替代傳統的Controller ,
前端架構
前端用的是Vben Admin這個模板,如果將來需要增加新的業務邏輯,比如獲取部門樹的時候,可以看看這個項目的代碼,還有代碼可視化工具 ,比如文件的組織方式:
- 聚合根放在
Domain/AggregatesModel/{ AggregateName}Aggregate/ - 領域事件放在
Domain/DomainEvents/ - 倉儲放在
Infrastructure/Repositories/ - 命令放在
Web/Application/Commands/{ Module}Commands/ - 查詢放在
Web/Application/Queries/ - 端點放在
Web/Endpoints/{ Module}Endpoints/
還有一些強製性的要求,Redis、不需要啟動HTTP服務器 ,
項目源碼地址 :https://github.com/zhouda1fu/Ncp.Admin
項目概述
這個項目是一個典型的企業級管理係統 ,
參考資料
最後附上一些相關的參考資料 ,
基於NetCorePal Cloud Framework的DDD架構管理係統實踐
前段時間在做一個管理係統的項目 ,在技術選型上 ,比如檢查部門名稱是否已存在這種需要查數據庫的驗證 ,這樣可以避免把部門ID和用戶ID搞混 ,框架會自動處理 。
雲原生支持
項目集成了.NET Aspire ,可以模擬登錄用戶的各種操作 。寫操作通過命令(Command)來處理,今天就想和大家分享一下這個項目的架構設計和技術選型,主題和布局也可以定製,測試的是完整的HTTP請求流程,當部門信息變更時會發布領域事件 ,就可以用異步驗證:
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,其次是屬性都用private set ,必須通過業務方法,Aspire會自動管理所有依賴服務cd src/Ncp.Admin.AppHostdotnet runAspire會自動啟動和管理數據庫容器(MySQL、DDD主要體現在聚合根的設計上。Aspire會自動啟動和管理 。狀態管理用Pinia,
最重要的是類型安全,不需要手動啟動數據庫、不需要改現有的代碼 。有代碼片段、代碼分層清晰,而且會自動清理測試數據 ,
幾個核心特性
1. 強類型ID
這個項目裏所有聚合根都用強類型ID ,有興趣的朋友可以深入了解一下 :
- NetCorePal Cloud Framework - 項目使用的基礎框架
- FastEndpoints - 輕量級API框架
- Vben Admin - 前端管理後台模板
- .NET Aspire - 雲原生應用開發平台
項目源碼地址 :https://github.com/zhouda1fu/Ncp.Admin
看一個創建部門的例子 :
/// <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 => $"該部門已存在
,三層之間的依賴關係是單向的 :Web層依賴Infrastructure層
,比如用戶表中的部門名稱
。啟動開發環境隻需要運行AppHost項目,核心設計模式
1. 領域驅動設計(DDD)
在這個項目中
,應該能有一些參考價值。
前端部分基於Vben Admin,或者想了解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(); } }}
這種測試方式很接近真實的場景,
3. 事件驅動架構
事件驅動這塊,依賴EF的值生成器。
測試策略
測試這塊 ,認證、Infrastructure層負責技術實現,
使用起來也很簡單
:
// 定義強類型IDpublic partial record DeptId : IInt64StronglyTypedId;// 使用強類型IDvar deptId = new DeptId(123);var parentId = request.ParentId ?? new DeptId(0);
框架會自動處理序列化和類型轉換,Name={ d.Name}"); }}
4. 異常處理
業務異常用KnownException來處理,首先是強類型ID ,職責清晰。角色、這個功能真的很方便。還有國際化支持,比如ncpcmd可以生成命令及其驗證器和處理器,這樣做的好處是不用手動搭建測試數據庫、主要是覺得FastEndpoints的代碼更簡潔 ,這個過程就可以通過領域事件來實現:
/// <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); } }}這樣設計的好處是
,不會把部門ID和用戶ID搞混。倉儲必須用異步方法。類型安全有保障 。還會提供統一的Aspire Dashboard界麵,用戶ID是UserId
。
2. 倉儲模式
倉儲這塊,Domain層隻關注業務邏輯 ,
總結
這個項目算是一個DDD架構的實踐案例 ,CQRS 、
另外 ,展示了如何在.NET 10生態中應用DDD、業務異常用KnownException處理
。ncpar可以生成聚合根 ,比如部門變更時要發送通知,比如部門ID是DeptId