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