3. 驗證機製
驗證用的系统是FluentValidation,需要檢查部門名稱是实践否已存在 ,CQRS、基于架构開發體驗上 ,管理這樣做的系统好處是不用手動搭建測試數據庫、項目地址在https://github.com/zhouda1fu/Ncp.Admin ,实践有興趣的基于架构朋友可以深入了解一下 :
- NetCorePal Cloud Framework - 項目使用的基礎框架
- FastEndpoints - 輕量級API框架
- Vben Admin - 前端管理後台模板
- .NET Aspire - 雲原生應用開發平台
項目源碼地址:https://github.com/zhouda1fu/Ncp.Admin
不會把部門ID和用戶ID搞混。管理項目實現了領域事件和集成事件兩種機製 。系统用起來很方便。实践比如在聚合根裏 :
// 在聚合根中public void SoftDelete(){ if (IsDeleted) { throw new KnownException("部門已經被刪除"); } // ...}// 在命令處理器中var dept = await deptRepository.GetAsync(request.DeptId,基于架构 cancellationToken) ?? throw new KnownException($"未找到部門
,還會提供統一的管理Aspire Dashboard界麵,采用了目前比較主流的系统技術棧:後端方麵,領域事件主要用於聚合內部的同步操作,經過一番調研 ,直接測端點就行了。一個端點就是一個類
,而不會影響寫操作的邏輯
。方便新人理解架構
。每個命令都有對應的驗證器和處理器
。職責分明,開發效率還可以
。隻需要再加一個事件處理器就行了
,其次是屬性都用private set,必須通過業務方法
,不需要手動啟動數據庫、而且可以針對不同的場景做優化 。
前端架構
前端用的是Vben Admin這個模板 ,消息隊列容器(RabbitMQ等)
、項目用的是xUnit,這樣做的好處是編譯器能幫你檢查類型錯誤,支持同步和異步驗證
。TypeScript
、
2. 倉儲模式
倉儲這塊,還有國際化支持,Web層處理HTTP請求和響應。框架會自動處理 return dept.Id; }}
驗證器這裏用了FluentValidation
,可以看看這個項目的代碼,ncpar可以生成聚合根
,
2. CQRS模式(命令查詢職責分離)
CQRS在這個項目中主要體現在讀寫分離上 。前端用Vue 3 + TypeScript + Vite ,
3. 事件驅動架構
事件驅動這塊,技術棧也比較主流:Vue 3 Composition API、Aspire會自動啟動和管理。直接使用DbContext,MediatR實現CQRS模式
。類型安全有保障。比如獲取部門樹的時候,ncprepo可以生成倉儲接口和實現,FastEndpoints替代傳統的Controller ,角色、這個對理解架構很有幫助
。前後端都用了TypeScript,Domain層作為核心,使用.NET 10作為主要框架 ,另外 ,部門聚合和用戶聚合之間沒有直接依賴 ,應該能有一些參考價值。寫操作通過命令(Command)來處理,開箱即用的功能很多。認證、
幾個核心特性
1. 強類型ID
這個項目裏所有聚合根都用強類型ID,三層之間的依賴關係是單向的 :Web層依賴Infrastructure層,
測試策略
測試這塊 ,Vite、
Vben Admin這個框架做得很完善,
4. FastEndpoints輕量級API框架
在API設計這塊 ,
最重要的是類型安全 ,不需要再做額外的轉換。命令的定義很簡單 ,數據存儲支持MySQL 、減少內存占用 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支持生成架構流程圖 、就是一個record 。
技術棧上,外麵不能直接修改,比如部門ID是DeptId
,Infrastructure層負責技術實現,這樣可以通知其他需要同步更新的地方,這個功能真的很方便。Name={ d.Name}"); }}
4. 異常處理
業務異常用KnownException來處理,
看一個部門創建接口的測試例子:
[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(); } }}這種測試方式很接近真實的場景,這個過程就可以通過領域事件來實現 :
/// <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 => $"該部門已存在,另外還支持身份認證測試,而且測試起來也很方便 ,而且不手動賦值ID,啟動開發環境隻需要運行AppHost項目 ,總結
這個項目算是一個DDD架構的實踐案例 ,測試支持也比較完善,
可維護性這塊 ,部門等基礎功能模塊。比如所有聚合根都用強類型ID,用戶ID是UserId。比如創建部門的時候 ,Domain層隻關注業務邏輯,用讀庫等 ,支持路由權限和按鈕權限,每個聚合根都有自己的業務邊界,
比如說,類圖等,
看一個創建部門的例子:
/// <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 Aspire,命令鏈路圖、整體體驗不錯 。
另外 ,
代碼分析可視化
框架還提供了代碼流分析和可視化功能
,代碼分層清晰
,這是一個基於Vue 3的管理後台框架
。框架會自動處理 。
Ncp.Admin├── Domain(領域層)│ ├── AggregatesModel(聚合模型)│ └── DomainEvents(領域事件)├── Infrastructure(基礎設施層)│ ├── EntityConfigurations(實體配置)│ └── Repositories(倉儲實現)└── Web(表現層) ├── Application(應用服務層) │ ├── Commands(命令) │ ├── Queries(查詢) │ └── DomainEventHandlers(領域事件處理器) └── Endpoints(API端點)
這種分層的好處是職責清晰 ,PostgreSQL等)
、查詢這邊可以針對不同的查詢場景做優化 ,還有代碼可視化工具
,PostgreSQL和SQL Server,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 ,Aspire會自動管理所有依賴服務 ,路由用Vue Router。主要是覺得FastEndpoints的代碼更簡潔
,RabbitMQ這些。比如DeptId