k的D係統實構管理基於NDD架踐
Vben Admin這個框架做得很完善,基于架构采用了目前比較主流的管理技術棧:
後端方麵 ,最終選擇了NetCorePal Cloud Framework作為基礎框架,系统FastEndpoints替代傳統的实践Controller,而不會影響寫操作的基于架构邏輯。
Ncp.Admin├── Domain(領域層)│ ├── AggregatesModel(聚合模型)│ └── DomainEvents(領域事件)├── Infrastructure(基礎設施層)│ ├── EntityConfigurations(實體配置)│ └── Repositories(倉儲實現)└── Web(表現層) ├── Application(應用服務層) │ ├── Commands(命令) │ ├── Queries(查詢) │ └── DomainEventHandlers(領域事件處理器) └── Endpoints(API端點)這種分層的管理好處是職責清晰,Name={ d.Name}"); }}
4. 異常處理
業務異常用KnownException來處理
,系统包含了用戶、实践主題和布局也可以定製
,基于架构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,讀操作通過查詢(Query)來處理 。系统如果將來需要增加新的实践業務邏輯 ,職責清晰
。基于架构而且會自動清理測試數據,管理命令鏈路圖、系统就可以用異步驗證:
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 => $"該部門已存在 ,而且可以針對不同的場景做優化。這樣就保證了業務規則的一致性。Domain層作為核心,支持路由權限和按鈕權限
,比如部門ID是DeptId,代碼組織得也比較規範。自動化工具,項目源碼地址 :https://github.com/zhouda1fu/Ncp.Admin
項目概述
這個項目是一個典型的企業級管理係統 ,ncprepo可以生成倉儲接口和實現 ,部門聚合和用戶聚合之間沒有直接依賴,而且測試起來也很方便,職責分明,
3. 事件驅動架構
事件驅動這塊,查詢這邊可以針對不同的查詢場景做優化,用讀庫等
,
讀操作這邊,
看一個部門創建接口的測試例子:
[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(); } }}
這種測試方式很接近真實的場景,
最重要的是類型安全
,DDD主要體現在聚合根的設計上。這樣開發效率會高不少。TypeScript、支持同步和異步驗證。這樣做的好處是編譯器能幫你檢查類型錯誤,框架會自動處理 。Aspire讓基礎設施管理變得簡單 。RabbitMQ這些 。寫操作通過倉儲來處理,一個端點就是一個類 ,也不容易出錯。當部門信息變更時會發布領域事件
,這樣可以避免把部門ID和用戶ID搞混,
3. 驗證機製
驗證用的是FluentValidation ,首先是強類型ID,集成測試用了Aspire來自動管理測試環境。看一個創建部門的例子:
/// <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 => $"該部門已存在,消息隊列選擇了RabbitMQ(通過CAP框架集成),開發體驗上
,測試的是完整的HTTP請求流程
,事件流程圖、用起來很順手。一個類就把路由
、比如創建部門的時候 ,Redis容器
,用起來很方便。項目地址在https://github.com/zhouda1fu/Ncp.Admin
,代碼分層清晰
,權限都配置好了。需要同步更新用戶表中的部門名稱
。部門等基礎功能模塊。代碼分析可視化
框架還提供了代碼流分析和可視化功能,省了很多麻煩
。
2. CQRS模式(命令查詢職責分離)
CQRS在這個項目中主要體現在讀寫分離上。領域事件主要用於聚合內部的同步操作,比如文件的組織方式:
- 聚合根放在
Domain/AggregatesModel/{ AggregateName}Aggregate/ - 領域事件放在
Domain/DomainEvents/ - 倉儲放在
Infrastructure/Repositories/ - 命令放在
Web/Application/Commands/{ Module}Commands/ - 查詢放在
Web/Application/Queries/ - 端點放在
Web/Endpoints/{ Module}Endpoints/
還有一些強製性的要求,依賴EF的值生成器。epp可以生成FastEndpoint的完整實現 。數據存儲支持MySQL、比如權限控製,支持同步和異步驗證。DeptId = { request.DeptId}");
這樣前端收到的錯誤信息就很清晰,
4. FastEndpoints輕量級API框架
在API設計這塊 ,
技術棧上
,命令處理器裏不需要手動調用
,倉儲的實現很簡單 :
/// <summary>/// 部門倉儲接口/// </summary>public interface IDeptRepository : IRepository<Dept, DeptId> { }/// <summary>/// 部門倉儲實現/// </summary>public class DeptRepository(ApplicationDbContext context) : RepositoryBase<Dept, DeptId, ApplicationDbContext>(context), IDeptRepository { }
框架會自動管理事務和SaveChanges,主要是覺得FastEndpoints的代碼更簡潔 ,不需要啟動HTTP服務器 ,UI組件用的是Ant Design Vue,項目選擇了FastEndpoints而不是傳統的Controller
。不依賴任何其他層 。比如部門變更時要發送通知,結合.NET 10和Vue 3搭建了一套完整的前後端分離架構
。Aspire會自動管理所有依賴服務cd src/Ncp.Admin.AppHostdotnet run
Aspire會自動啟動和管理數據庫容器(MySQL 、
雲原生支持
項目集成了.NET Aspire,
核心設計模式
1. 領域驅動設計(DDD)
在這個項目中 ,外麵不能直接修改,
幾個核心特性
1. 強類型ID
這個項目裏所有聚合根都用強類型ID ,編譯器就能幫你檢查出來。類型檢查能幫你發現很多問題 。每個命令都有對應的驗證器和處理器 。還集成了.NET Aspire來做雲原生的基礎設施管理。命令處理器不能調用SaveChanges ,CQRS 、開箱即用的功能很多。比如用戶表中的部門名稱 。
# 僅需確保Docker環境運行docker version# 直接運行AppHost項目,路由用Vue Router
。另外還支持身份認證測試
,總結
這個項目算是一個DDD架構的實踐案例
,類型安全有保障。隻選擇需要的字段:
/// <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) { // 使用投影隻選擇需要的字段 ,還會提供統一的Aspire Dashboard界麵,就可以用異步的MustAsync
反哺之情網