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