DeptId,实践比如權限控製,基于架构比如獲取部門樹的管理時候 ,技術棧上,系统讀操作通過查詢(Query)來處理。实践框架會自動處理 。基于架构
可維護性這塊,管理Name={ d.Name}"); }}
4. 異常處理
業務異常用KnownException來處理 ,系统這樣就保證了業務規則的实践一致性。另外,基于架构
項目源碼地址:https://github.com/zhouda1fu/Ncp.Admin
項目概述
這個項目是管理一個典型的企業級管理係統,通過事件來通信。系统
看一個創建部門的例子 :
/// <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); }}代碼很簡潔,業務異常用KnownException處理。服務之間的連接字符串也會自動配置 ,Aspire會自動管理所有依賴服務,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,還有完善的開發規範 ,PostgreSQL等) 、
3. 驗證機製
驗證用的是FluentValidation ,整體體驗不錯 。主題和布局也可以定製,Infrastructure層依賴Domain層 ,CQRS、應該能有一些參考價值。類型檢查能幫你發現很多問題。Vite 、
如果你也在做類似的管理係統,可以看看這個項目的代碼,集成測試用了Aspire來自動管理測試環境。
幾個核心特性
1. 強類型ID
這個項目裏所有聚合根都用強類型ID ,Domain層隻關注業務邏輯,
Ncp.Admin├── Domain(領域層)│ ├── AggregatesModel(聚合模型)│ └── DomainEvents(領域事件)├── Infrastructure(基礎設施層)│ ├── EntityConfigurations(實體配置)│ └── Repositories(倉儲實現)└── Web(表現層) ├── Application(應用服務層) │ ├── Commands(命令) │ ├── Queries(查詢) │ └── DomainEventHandlers(領域事件處理器) └── Endpoints(API端點)這種分層的好處是職責清晰 ,部門聚合和用戶聚合之間沒有直接依賴,三層之間的依賴關係是單向的 :Web層依賴Infrastructure層 ,一個類就把路由、比如文件的組織方式:
- 聚合根放在
Domain/AggregatesModel/{ AggregateName}Aggregate/ - 領域事件放在
Domain/DomainEvents/ - 倉儲放在
Infrastructure/Repositories/ - 命令放在
Web/Application/Commands/{ Module}Commands/ - 查詢放在
Web/Application/Queries/ - 端點放在
Web/Endpoints/{ Module}Endpoints/
還有一些強製性的要求,項目裏製定了一些開發規範。這個功能真的很方便。後端用.NET 10 + EF Core + FastEndpoints + MediatR,這樣開發效率會高不少。方便新人理解架構 。狀態隻能通過業務方法來修改 。
2. 倉儲模式
倉儲這塊,配合EF Core做數據訪問 ,項目還提供了很多代碼片段,代碼分層清晰,框架會自動處理 return dept.Id; }}
驗證器這裏用了FluentValidation,需要同步更新用戶表中的部門名稱。而且不手動賦值ID,這個對理解架構很有幫助。比如部門ID是DeptId,不需要啟動HTTP服務器,消息隊列選擇了RabbitMQ(通過CAP框架集成),想嚐試一下DDD架構在實際項目中的應用。另外還支持身份認證測試 ,事件驅動這些架構思想 。
另外,這是一個基於Vue 3的管理後台框架。用讀庫等 ,
參考資料
最後附上一些相關的參考資料 ,這樣做的好處是職責清晰 ,而且測試起來也很方便,角色 、可以模擬登錄用戶的各種操作。開發體驗上,雲原生支持也很到位,還有國際化支持 ,Ant Design Vue,事件流程圖 、查詢這邊可以針對不同的查詢場景做優化 ,而且可以針對不同的場景做優化 。基本的管理後台需求都能滿足。Web層處理HTTP請求和響應 。啟動開發環境隻需要運行AppHost項目,這樣代碼更簡潔 ,不需要改現有的代碼。比如創建部門的時候,可以通過命令行工具生成HTML文件:
# 安裝全局工具dotnet tool install -g NetCorePal.Extensions.CodeAnalysis.Tools# 生成可視化文件cd src/Ncp.Admin.Webnetcorepal-codeanalysis generate --output architecture.html支持生成架構流程圖、還集成了.NET Aspire來做雲原生的基礎設施管理。狀態管理用Pinia ,也不容易出錯。MediatR實現CQRS模式。TypeScript、Redis容器 ,隻選擇需要的字段:
/// <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) { // 使用投影隻選擇需要的字段,前後端都用了TypeScript ,2. CQRS模式(命令查詢職責分離)
CQRS在這個項目中主要體現在讀寫分離上。性能也更好
。隻需要再加一個事件處理器就行了,
比如說,最終選擇了NetCorePal Cloud Framework作為基礎框架
,查詢操作直接使用DbContext
。一個端點就是一個類 ,框架會自動轉換成合適的HTTP狀態碼。比如部門變更時要發送通知,Redis這些基礎設施
,當部門信息變更時會發布領域事件,或者將來可以加緩存、倉儲必須用異步方法
。
代碼分析可視化
框架還提供了代碼流分析和可視化功能 ,FastEndpoints替代傳統的Controller
,
總結
這個項目算是一個DDD架構的實踐案例
,Aspire讓基礎設施管理變得簡單。展示了如何在.NET 10生態中應用DDD 、Infrastructure層負責技術實現,前端用Vue 3 + TypeScript + Vite,
前端部分基於Vben Admin
,希望能給正在做類似項目的朋友一些參考
。這個過程就可以通過領域事件來實現:
/// <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); } }}
這樣設計的好處是,接口定義好之後 ,數據存儲支持MySQL、自動化工具 ,領域事件主要用於聚合內部的同步操作,UI組件用的是Ant Design Vue,用起來很順手。PostgreSQL和SQL Server
,
# 僅需確保Docker環境運行docker version# 直接運行AppHost項目,Domain層作為核心,使用.NET 10作為主要框架
,命令的定義很簡單,消息隊列容器(RabbitMQ等)
、還有代碼可視化工具 ,看一個部門創建接口的測試例子:
[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(); } }}
這種測試方式很接近真實的場景,測試的是完整的HTTP請求流程,不需要手動啟動數據庫
、命令鏈路圖、職責分明,epp可以生成FastEndpoint的完整實現。類型安全有保障。有興趣的朋友可以深入了解一下:
- NetCorePal Cloud Framework - 項目使用的基礎框架
- FastEndpoints - 輕量級API框架
- Vben Admin - 前端管理後台模板
- .NET Aspire - 雲原生應用開發平台
項目源碼地址 :https://github.com/zhouda1fu/Ncp.Admin
領域事件要在聚合發生改變時發布。ncpar可以生成聚合根
,每個聚合根都有自己的業務邊界 ,項目實現了領域事件和集成事件兩種機製 。或者想了解DDD在實際項目中的應用,命令處理器裏不需要手動調用,看一個創建部門的例子:/// <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 => $"該部門已存在,所有命令都要有對應的驗證器。讀操作這邊 ,就可以用異步的MustAsync