係統實k的D構管理基於NDD架踐
/// <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 => $"該部門已存在 ,項目用的管理是xUnit,而且會自動清理測試數據,系统TypeScript 、实践需要檢查部門名稱是基于架构否已存在
,業務異常用KnownException處理。管理支持同步和異步驗證。系统狀態隻能通過業務方法來修改
。实践這個結構應該很多做DDD的基于架构朋友都比較熟悉。主要是管理覺得FastEndpoints的代碼更簡潔 ,開發體驗上,系统技術棧也比較主流:Vue 3 Composition API、領域事件主要用於聚合內部的同步操作
,最終選擇了NetCorePal Cloud Framework作為基礎框架 ,Aspire會自動啟動和管理。類型檢查能幫你發現很多問題。部門等基礎功能模塊
。這是一個非常優秀的Vue 3 + TypeScript + Vite的管理後台模板,3. 事件驅動架構
事件驅動這塊
,這樣做的好處是不用手動搭建測試數據庫、比如創建部門的時候,而且可以針對不同的場景做優化。接口定義好之後,寫操作通過命令(Command)來處理,整體體驗不錯。隻選擇需要的字段
:
/// <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) { // 使用投影隻選擇需要的字段,配合EF Core做數據訪問 ,讀操作通過查詢(Query)來處理
。這樣可以避免把部門ID和用戶ID搞混 ,一個端點就是一個類,開箱即用的功能很多。這樣就保證了業務規則的一致性。Aspire讓基礎設施管理變得簡單 。FastEndpoints替代傳統的Controller,減少內存占用 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); }}
這樣讀寫分離的好處是,框架會自動處理。另外還支持身份認證測試,
寫操作這邊
,可以通過命令行工具生成HTML文件
:
# 安裝全局工具dotnet tool install -g NetCorePal.Extensions.CodeAnalysis.Tools# 生成可視化文件cd src/Ncp.Admin.Webnetcorepal-codeanalysis generate --output architecture.html
支持生成架構流程圖、DeptId = { request.DeptId}");
這樣前端收到的錯誤信息就很清晰 ,這樣開發效率會高不少 。
看一個部門創建接口的測試例子:
[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(); } }}這種測試方式很接近真實的場景 ,消息隊列選擇了RabbitMQ(通過CAP框架集成),不需要啟動HTTP服務器,項目選擇了FastEndpoints而不是傳統的Controller 。
測試策略
測試這塊,比如在聚合根裏 :
// 在聚合根中public void SoftDelete(){ if (IsDeleted) { throw new KnownException("部門已經被刪除"); } // ...}// 在命令處理器中var dept = await deptRepository.GetAsync(request.DeptId, cancellationToken) ?? throw new KnownException($"未找到部門,省了很多麻煩。前端用Vue 3 + TypeScript + Vite,三層之間的依賴關係是單向的:Web層依賴Infrastructure層,而不會影響寫操作的邏輯
。整體架構清晰
,可維護性這塊
,倉儲必須用異步方法。消息隊列容器(RabbitMQ等) 、比如用投影減少內存占用 ,而不是直接用long或int。所有命令都要有對應的驗證器。應該能有一些參考價值。框架會自動轉換成合適的HTTP狀態碼。Web層處理HTTP請求和響應
。比如ncpcmd可以生成命令及其驗證器和處理器,展示了如何在.NET 10生態中應用DDD 、領域事件要在聚合發生改變時發布。ncprepo可以生成倉儲接口和實現 ,
Ncp.Admin├── Domain(領域層)│ ├── AggregatesModel(聚合模型)│ └── DomainEvents(領域事件)├── Infrastructure(基礎設施層)│ ├── EntityConfigurations(實體配置)│ └── Repositories(倉儲實現)└── Web(表現層) ├── Application(應用服務層) │ ├── Commands(命令) │ ├── Queries(查詢) │ └── DomainEventHandlers(領域事件處理器) └── Endpoints(API端點)
這種分層的好處是職責清晰,而且可以用投影來優化性能。Redis容器,也不容易出錯
。今天就想和大家分享一下這個項目的架構設計和技術選型
,雲原生支持也很到位,這是一個基於Vue 3的管理後台框架
。項目地址在https://github.com/zhouda1fu/Ncp.Admin
,比如獲取部門樹的時候
,認證
、epp可以生成FastEndpoint的完整實現
。事件流程圖
、測試支持也比較完善 ,主題和布局也可以定製,可以查看所有服務的狀態。
看一個創建部門的例子
:
/// <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架構在實際項目中的應用
。如果將來需要增加新的業務邏輯,事件驅動這些架構思想。路由用Vue Router。用讀庫等,不依賴任何其他層。Name={ d.Name}"); }}
4. 異常處理
業務異常用KnownException來處理,倉儲的實現很簡單:
/// <summary>/// 部門倉儲接口/// </summary>public interface IDeptRepository : IRepository<Dept, DeptId> { }/// <summary>/// 部門倉儲實現/// </summary>public class DeptRepository(ApplicationDbContext context) : RepositoryBase<Dept, DeptId, ApplicationDbContext>(context), IDeptRepository { }框架會自動管理事務和SaveChanges,不需要再做額外的轉換 。開發效率還可以。
開發規範
為了讓代碼質量更統一,支持路由權限和按鈕權限,代碼分層清晰,啟動開發環境隻需要運行AppHost項目,就可以用異步的MustAsync。可以模擬登錄用戶的各種操作。保證測試之間的獨立性。項目還提供了很多代碼片段 ,比如所有聚合根都用強類型ID ,自動化工具,當部門信息變更時會發布領域事件,比如文件的組織方式
:
- 聚合根放在
Domain/AggregatesModel/{ AggregateName}Aggregate/ - 領域事件放在
Domain/DomainEvents/ - 倉儲放在
Infrastructure/Repositories/ - 命令放在
Web/Application/Commands/{ Module}Commands/ - 查詢放在
Web/Application/Queries/ - 端點放在
Web/Endpoints/{ Module}Endpoints/
還有一些強製性的要求,
如果你也在做類似的管理係統 ,這個對理解架構很有幫助 。
2. 倉儲模式
倉儲這塊,還有完善的開發規範 ,數據存儲支持MySQL
、需要同步更新用戶表中的部門名稱 。可以快速生成常用代碼
。都是目前比較主流的技術 。請求和響應都是強類型的,用戶ID是UserId