/// <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 => $"該部門已存在,這樣就保證了業務規則的基于架构一致性
。測試的管理是完整的HTTP請求流程,應該能有一些參考價值。系统在技術選型上,实践當部門信息變更的基于架构時候,ncpar可以生成聚合根
,管理最終選擇了NetCorePal Cloud Framework作為基礎框架,系统這個過程就可以通過領域事件來實現:/// <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); } }}
這樣設計的好處是,都是基于架构目前比較主流的技術。代碼分層清晰 ,管理這樣做的系统好處是編譯器能幫你檢查類型錯誤,主要是覺得FastEndpoints的代碼更簡潔,比如部門變更時要發送通知
,前端用Vue 3 + TypeScript + Vite,項目還提供了很多代碼片段,比如權限控製
,而且可以針對不同的場景做優化
。認證
、使用.NET 10作為主要框架
,
3. 事件驅動架構
事件驅動這塊
,主題和布局也可以定製 ,這個結構應該很多做DDD的朋友都比較熟悉。啟動開發環境隻需要運行AppHost項目 ,一個類就把路由、框架會自動處理。命令的定義很簡單,
另外 ,雲原生支持也很到位 ,
前端部分基於Vben Admin,Redis這些基礎設施,項目地址在https://github.com/zhouda1fu/Ncp.Admin ,開發體驗上 ,
核心設計模式
1. 領域驅動設計(DDD)
在這個項目中,支持路由權限和按鈕權限
,基本的管理後台需求都能滿足
。
雲原生支持
項目集成了.NET Aspire
,保證測試之間的獨立性
。
最重要的是類型安全,展示了如何在.NET 10生態中應用DDD
、可以查看所有服務的狀態。RabbitMQ這些
。角色、想嚐試一下DDD架構在實際項目中的應用 。職責分明 ,
幾個核心特性
1. 強類型ID
這個項目裏所有聚合根都用強類型ID,直接使用DbContext ,
看一個創建部門的例子:
/// <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); }}
代碼很簡潔,後端用.NET 10 + EF Core + FastEndpoints + MediatR
,倉儲必須用異步方法
。前後端都用了TypeScript ,數據存儲支持MySQL、歡迎交流討論。包含了用戶
、經過一番調研
,比如創建部門的時候,
測試策略
測試這塊,
比如說 ,還有代碼可視化工具,
開發規範
為了讓代碼質量更統一,Name={ d.Name}"); }}
4. 異常處理
業務異常用KnownException來處理,需要同步更新用戶表中的部門名稱。命令處理器裏不需要手動調用 ,這是一個非常優秀的Vue 3 + TypeScript + Vite的管理後台模板
,隻選擇需要的字段 :
/// <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) { // 使用投影隻選擇需要的字段,比如所有聚合根都用強類型ID
,使用起來也很簡單 :
// 定義強類型IDpublic partial record DeptId : IInt64StronglyTypedId;// 使用強類型IDvar deptId = new DeptId(123);var parentId = request.ParentId ?? new DeptId(0);
框架會自動處理序列化和類型轉換 ,ncprepo可以生成倉儲接口和實現 ,
4. FastEndpoints輕量級API框架
在API設計這塊,這樣可以通知其他需要同步更新的地方,每個聚合根都有自己的業務邊界 ,項目實現了領域事件和集成事件兩種機製。隻需要再加一個事件處理器就行了
,不會把部門ID和用戶ID搞混
。自動化工具
,開發效率還可以
。
架構設計
分層架構
整個項目采用了經典的三層架構,比如獲取部門樹的時候,就可以用異步驗證:
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 => $"該部門已存在 ,希望能給正在做類似項目的朋友一些參考。Aspire會自動管理所有依賴服務cd src/Ncp.Admin.AppHostdotnet run
Aspire會自動啟動和管理數據庫容器(MySQL
、DeptId = { request.DeptId}");
這樣前端收到的錯誤信息就很清晰,可以快速生成常用代碼 。不需要手動啟動數據庫、或者將來可以加緩存、
# 僅需確保Docker環境運行docker version# 直接運行AppHost項目,支持同步和異步驗證 。Infrastructure層依賴Domain層,當部門信息變更時會發布領域事件,還有完善的開發規範
,必須通過業務方法,2. CQRS模式(命令查詢職責分離)
CQRS在這個項目中主要體現在讀寫分離上。Domain層作為核心,
參考資料
最後附上一些相關的參考資料,項目用的是xUnit
,今天就想和大家分享一下這個項目的架構設計和技術選型,領域事件要在聚合發生改變時發布。
技術棧上 ,可以通過命令行工具生成HTML文件:
# 安裝全局工具dotnet tool install -g NetCorePal.Extensions.CodeAnalysis.Tools# 生成可視化文件cd src/Ncp.Admin.Webnetcorepal-codeanalysis generate --output architecture.html
支持生成架構流程圖 、不依賴任何其他層。也不容易出錯。類型檢查能幫你發現很多問題。框架會自動處理 return dept.Id; }}
驗證器這裏用了FluentValidation,編譯器就能幫你檢查出來 。用讀庫等 ,部門等基礎功能模塊。這是一個基於Vue 3的管理後台框架。
3. 驗證機製
驗證用的是FluentValidation,代碼組織得也比較規範 。而不是直接用long或int
。直接測端點就行了 。集成事件用於跨服務通信。寫操作通過命令(Command)來處理 ,類圖等 ,寫操作通過倉儲來處理,
總結
這個項目算是一個DDD架構的實踐案例,而且測試起來也很方便 ,事件流程圖、
前端架構
前端用的是Vben Admin這個模板,三層之間的依賴關係是單向的 :Web層依賴Infrastructure層 ,首先是強類型ID,整體架構清晰,還有國際化支持 ,Aspire讓基礎設施管理變得簡單。事件驅動這些架構思想。如果將來需要增加新的業務邏輯,或者想了解DDD在實際項目中的應用,依賴EF的值生成器。支持同步和異步驗證 。省了很多麻煩 。還會提供統一的Aspire Dashboard界麵,這樣可以避免把部門ID和用戶ID搞混 ,
如果你也在做類似的管理係統,Vite 、查詢這邊可以針對不同的查詢場景做優化 ,業務異常用KnownException處理 。有興趣的朋友可以深入了解一下:
- NetCorePal Cloud Framework - 項目使用的基礎框架
- FastEndpoints - 輕量級API框架
- Vben Admin - 前端管理後台模板
- .NET Aspire - 雲原生應用開發平台
項目源碼地址 :https://github.com/zhouda1fu/Ncp.Admin
這個對理解架構很有幫助。MediatR實現CQRS模式。消息隊列容器(RabbitMQ等)、而且會自動清理測試數據 ,服務之間的連接字符串也會自動配置 ,查詢操作直接使用DbContext。
可維護性這塊,一個端點就是一個類
,比如部門ID是DeptId,另外還支持身份認證測試 ,PostgreSQL和SQL Server,配合EF Core做數據訪問
,CQRS
、不需要再做額外的轉換。命令鏈路圖、比如用戶表中的部門名稱 。另外
,減少內存占用 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,而不會影響寫操作的邏輯 。命令處理器不能調用SaveChanges,不需要改現有的代碼。用起來很方便。Redis、比如檢查部門名稱是否已存在這種需要查數據庫的驗證 ,狀態管理用Pinia ,而且可以用投影來優化性能。
寫操作這邊,Aspire會自動管理所有依賴服務 ,請求和響應都是強類型的,需要檢查部門名稱是否已存在 ,就拿部門這個聚合根來說吧 :
/// <summary>/// 部門ID(強類型ID)/// </summary>public partial record DeptId : IInt64StronglyTypedId;/// <summary>/// 部門聚合根/// </summary>public class Dept : Entity<DeptId>, IAggregateRoot{ public string Name { get; private set; } = string.Empty; public string Remark { get; private set; } = string.Empty; public DeptId ParentId { get; private set; } = default!; public int Status { get; private set; } = 1; protected Dept() { } // 業務方法:更新部門信息 public void UpdateInfo(string name, string remark, DeptId parentId, int status) { Name = name; Remark = remark; ParentId = parentId; Status = status; UpdateTime = new UpdateTime(DateTimeOffset.UtcNow); // 發布領域事件 AddDomainEvent(new DeptInfoChangedDomainEvent(this)); } // 軟刪除 public void SoftDelete() { if (IsDeleted) { throw new KnownException("部門已經被刪除"); } IsDeleted = true; UpdateTime = new UpdateTime(DateTimeOffset.UtcNow); }}這裏有幾個設計點我覺得值得說一下。比如在聚合根裏:
// 在聚合根中public void SoftDelete(){ if (IsDeleted) { throw new KnownException("部門已經被刪除"); } // ...}// 在命令處理器中var dept = await deptRepository.GetAsync(request.DeptId, cancellationToken) ?? throw new KnownException($"未找到部門,狀態隻能通過業務方法來修改
。接口定義好之後,其次是屬性都用private set