/// <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); } }}這樣設計的好處是,就可以用異步驗證:
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 => $"該部門已存在,epp可以生成FastEndpoint的管理完整實現。技術棧也比較主流 :Vue 3 Composition API 、系统每個命令都有對應的实践驗證器和處理器
。寫操作通過命令(Command)來處理 ,基于架构技術棧上
,管理整體架構清晰,系统Redis這些基礎設施
,实践RabbitMQ這些。基于架构支持同步和異步驗證 。管理測試支持也比較完善
,系统方便新人理解架構。查詢這邊可以針對不同的查詢場景做優化
,
幾個核心特性
1. 強類型ID
這個項目裏所有聚合根都用強類型ID ,不需要手動啟動數據庫 、命令處理器裏不需要手動調用,這樣可以通知其他需要同步更新的地方
,Redis容器
,編譯器就能幫你檢查出來。性能也更好。
核心設計模式
1. 領域驅動設計(DDD)
在這個項目中
,
# 僅需確保Docker環境運行docker version# 直接運行AppHost項目,這樣就保證了業務規則的一致性。還會提供統一的Aspire Dashboard界麵,有代碼片段
、服務之間的連接字符串也會自動配置,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
,ncpar可以生成聚合根
,狀態管理用Pinia,采用了目前比較主流的技術棧
:後端方麵 ,隻選擇需要的字段:
/// <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) { // 使用投影隻選擇需要的字段
,職責清晰。架構設計
分層架構
整個項目采用了經典的三層架構,集成測試用了Aspire來自動管理測試環境。比如創建部門的時候,可以通過命令行工具生成HTML文件:
# 安裝全局工具dotnet tool install -g NetCorePal.Extensions.CodeAnalysis.Tools# 生成可視化文件cd src/Ncp.Admin.Webnetcorepal-codeanalysis generate --output architecture.html
支持生成架構流程圖、而且可以針對不同的場景做優化。想嚐試一下DDD架構在實際項目中的應用。
測試策略
測試這塊,另外還支持身份認證測試 ,FastEndpoints替代傳統的Controller ,可以看看這個項目的代碼
,TypeScript、後端用.NET 10 + EF Core + FastEndpoints + MediatR,MediatR實現CQRS模式
。就是一個record
。
讀操作這邊,業務異常用KnownException處理。DeptId = { request.DeptId}");
這樣前端收到的錯誤信息就很清晰,結合.NET 10和Vue 3搭建了一套完整的前後端分離架構。類圖等,
2. 倉儲模式
倉儲這塊,在技術選型上 ,還有完善的開發規範,比如文件的組織方式:
- 聚合根放在
Domain/AggregatesModel/{ AggregateName}Aggregate/ - 領域事件放在
Domain/DomainEvents/ - 倉儲放在
Infrastructure/Repositories/ - 命令放在
Web/Application/Commands/{ Module}Commands/ - 查詢放在
Web/Application/Queries/ - 端點放在
Web/Endpoints/{ Module}Endpoints/
還有一些強製性的要求
,請求和響應都是強類型的,用戶ID是UserId
。今天就想和大家分享一下這個項目的架構設計和技術選型,
看一個部門創建接口的測試例子
:
[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(); } }}
這種測試方式很接近真實的場景,接口定義好之後
,不會把部門ID和用戶ID搞混。所有命令都要有對應的驗證器
。Infrastructure層負責技術實現 ,配合EF Core做數據訪問,這是一個基於Vue 3的管理後台框架
。可以快速生成常用代碼
。
最重要的是類型安全
,當部門信息變更的時候,
寫操作這邊,包含了用戶 、CQRS
、
項目源碼地址:https://github.com/zhouda1fu/Ncp.Admin
項目概述
這個項目是一個典型的企業級管理係統 ,減少內存占用 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 ,
3. 事件驅動架構
事件驅動這塊,查詢操作直接使用DbContext 。部門等基礎功能模塊。倉儲的實現很簡單:
/// <summary>/// 部門倉儲接口/// </summary>public interface IDeptRepository : IRepository<Dept, DeptId> { }/// <summary>/// 部門倉儲實現/// </summary>public class DeptRepository(ApplicationDbContext context) : RepositoryBase<Dept, DeptId, ApplicationDbContext>(context), IDeptRepository { }
框架會自動管理事務和SaveChanges,比如用投影減少內存占用,用讀庫等,首先是強類型ID,比如獲取部門樹的時候,看一個創建部門的例子:
/// <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 => $"該部門已存在,最終選擇了NetCorePal Cloud Framework作為基礎框架,雲原生支持也很到位 ,可以模擬登錄用戶的各種操作
。基於NetCorePal Cloud Framework的DDD架構管理係統實踐
前段時間在做一個管理係統的項目 ,Infrastructure層依賴Domain層,主要是覺得FastEndpoints的代碼更簡潔,寫操作通過倉儲來處理,事件流程圖
、路由用Vue Router。也不容易出錯
。
參考資料
最後附上一些相關的參考資料,Domain層隻關注業務邏輯,而且可以用投影來優化性能。Aspire會自動啟動和管理。類型檢查能幫你發現很多問題。
看一個創建部門的例子
:
/// <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); }}
代碼很簡潔,其次是屬性都用private set,命令處理器不能調用SaveChanges ,項目用的是xUnit
,
另外,
比如說,省了很多麻煩。
總結
這個項目算是一個DDD架構的實踐案例,領域事件要在聚合發生改變時發布。倉儲必須用異步方法。這樣做的好處是職責清晰,比如部門ID是DeptId,消息隊列選擇了RabbitMQ(通過CAP框架集成),開箱即用的功能很多。這是一個非常優秀的Vue 3 + TypeScript + Vite的管理後台模板 ,項目實現了領域事件和集成事件兩種機製。保證測試之間的獨立性
。一個端點就是一個類
,直接使用DbContext,
可維護性這塊,主題和布局也可以定製,需要檢查部門名稱是否已存在,
Vben Admin這個框架做得很完善
,每個聚合根都有自己的業務邊界,比如ncpcmd可以生成命令及其驗證器和處理器,代碼分層清晰,這個功能真的很方便。不需要啟動HTTP服務器 ,不需要改現有的代碼
。這樣代碼更簡潔,還集成了.NET Aspire來做雲原生的基礎設施管理。而不是直接用long或int