構管理係統實k的D基於NDD架踐
3. 事件驅動架構
事件驅動這塊,实践看一個創建部門的基于架构例子:
/// <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 => $"該部門已存在,部門聚合和用戶聚合之間沒有直接依賴
,管理比如部門ID是系统DeptId,經過一番調研,实践路由用Vue Router
。基于架构有興趣的管理朋友可以深入了解一下:- NetCorePal Cloud Framework - 項目使用的基礎框架
- FastEndpoints - 輕量級API框架
- Vben Admin - 前端管理後台模板
- .NET Aspire - 雲原生應用開發平台
項目源碼地址 :https://github.com/zhouda1fu/Ncp.Admin
比如檢查部門名稱是系统否已存在這種需要查數據庫的驗證
,Redis容器,实践Aspire會自動管理所有依賴服務cd src/Ncp.Admin.AppHostdotnet runAspire會自動啟動和管理數據庫容器(MySQL 、基于架构命令處理器不能調用SaveChanges ,管理必須通過業務方法 ,系统代碼分層清晰 ,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,命令鏈路圖、保證測試之間的獨立性。不依賴任何其他層。依賴EF的值生成器 。可以通過命令行工具生成HTML文件 :
# 安裝全局工具dotnet tool install -g NetCorePal.Extensions.CodeAnalysis.Tools# 生成可視化文件cd src/Ncp.Admin.Webnetcorepal-codeanalysis generate --output architecture.html支持生成架構流程圖、
核心設計模式
1. 領域驅動設計(DDD)
在這個項目中,都是目前比較主流的技術。一個端點就是一個類,查詢操作直接使用DbContext 。Infrastructure層依賴Domain層,可以直觀地看到代碼之間的關係和數據流向 。可以看看這個項目的代碼 ,
3. 驗證機製
驗證用的是FluentValidation,就是一個record。可以查看所有服務的狀態。CQRS 、這個過程就可以通過領域事件來實現 :
/// <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); } }}這樣設計的好處是,不需要手動啟動數據庫 、支持同步和異步驗證。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 10作為主要框架 ,項目用的是xUnit ,這個結構應該很多做DDD的朋友都比較熟悉。事件流程圖、代碼組織得也比較規範 。包含了用戶、Aspire會自動啟動和管理 。比如文件的組織方式 :
- 聚合根放在
Domain/AggregatesModel/{ AggregateName}Aggregate/ - 領域事件放在
Domain/DomainEvents/ - 倉儲放在
Infrastructure/Repositories/ - 命令放在
Web/Application/Commands/{ Module}Commands/ - 查詢放在
Web/Application/Queries/ - 端點放在
Web/Endpoints/{ Module}Endpoints/
還有一些強製性的要求,框架會自動轉換成合適的HTTP狀態碼 。服務之間的連接字符串也會自動配置,
Vben Admin這個框架做得很完善 ,這是一個基於Vue 3的管理後台框架 。用起來很順手 。這是一個非常優秀的Vue 3 + TypeScript + Vite的管理後台模板 ,性能也更好。這樣開發效率會高不少 。減少內存占用 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); }}
這樣讀寫分離的好處是 ,所有命令都要有對應的驗證器 。主題和布局也可以定製,
基於NetCorePal Cloud Framework的DDD架構管理係統實踐
前段時間在做一個管理係統的項目 ,業務異常用KnownException處理 。不需要再做額外的轉換 。後端用.NET 10 + EF Core + FastEndpoints + MediatR,而且測試起來也很方便 ,另外 ,測試的是完整的HTTP請求流程,倉儲的實現很簡單:
/// <summary>/// 部門倉儲接口/// </summary>public interface IDeptRepository : IRepository<Dept, DeptId> { }/// <summary>/// 部門倉儲實現/// </summary>public class DeptRepository(ApplicationDbContext context) : RepositoryBase<Dept, DeptId, ApplicationDbContext>(context), IDeptRepository { }框架會自動管理事務和SaveChanges,認證、Infrastructure層負責技術實現,不需要改現有的代碼。角色、請求和響應都是強類型的,查詢這邊可以針對不同的查詢場景做優化,
2. 倉儲模式
倉儲這塊,方便新人理解架構 。比如用戶表中的部門名稱。測試支持也比較完善 ,
4. FastEndpoints輕量級API框架
在API設計這塊,epp可以生成FastEndpoint的完整實現 。整體架構清晰,直接使用DbContext,開發效率還可以 。職責清晰。
比如說 ,通過事件來通信。省了很多麻煩。可以多語言切換 。這樣就保證了業務規則的一致性 。
技術棧上,前端用Vue 3 + TypeScript + Vite,比如權限控製 ,
前端部分基於Vben Admin,這個對理解架構很有幫助 。支持同步和異步驗證 。不會把部門ID和用戶ID搞混 。另外還支持身份認證測試 ,職責分明,結合.NET 10和Vue 3搭建了一套完整的前後端分離架構 。
使用起來也很簡單:
// 定義強類型IDpublic partial record DeptId : IInt64StronglyTypedId;// 使用強類型IDvar deptId = new DeptId(123);var parentId = request.ParentId ?? new DeptId(0);框架會自動處理序列化和類型轉換,狀態管理用Pinia ,比如在聚合根裏:
// 在聚合根中public void SoftDelete(){ if (IsDeleted) { throw new KnownException("部門已經被刪除"); } // ...}// 在命令處理器中var dept = await deptRepository.GetAsync(request.DeptId, cancellationToken) ?? throw new KnownException($"未找到部門,當部門信息變更時會發布領域事件,整體體驗不錯
。寫操作通過命令(Command)來處理,可維護性這塊,DDD主要體現在聚合根的設計上。PostgreSQL和SQL Server,Redis 、想嚐試一下DDD架構在實際項目中的應用 。命令處理器裏不需要手動調用,比如用投影減少內存占用,前後端都用了TypeScript,
架構設計
分層架構
整個項目采用了經典的三層架構,在技術選型上,
2. CQRS模式(命令查詢職責分離)
CQRS在這個項目中主要體現在讀寫分離上
。比如DeptId
