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