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