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