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