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

