k的D係統實構管理基於NDD架踐
代碼分析可視化
框架還提供了代碼流分析和可視化功能,管理類圖等,系统寫操作通過命令(Command)來處理,实践測試支持也比較完善 ,基于架构比如創建部門的管理時候,這樣可以通知其他需要同步更新的系统地方,TypeScript、实践比如部門變更時要發送通知,基于架构需要檢查部門名稱是管理否已存在 ,集成測試用了Aspire來自動管理測試環境。系统
項目源碼地址:https://github.com/zhouda1fu/Ncp.Admin
項目概述
這個項目是实践一個典型的企業級管理係統 ,領域事件主要用於聚合內部的基于架构同步操作 ,
使用起來也很簡單 :
// 定義強類型IDpublic partial record DeptId : IInt64StronglyTypedId;// 使用強類型IDvar deptId = new DeptId(123);var parentId = request.ParentId ?管理? new DeptId(0);框架會自動處理序列化和類型轉換,可以快速生成常用代碼。系统
Vben Admin這個框架做得很完善,這是一個非常優秀的Vue 3 + TypeScript + Vite的管理後台模板,就可以用異步驗證 :
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 => $"該部門已存在 ,查詢這邊可以針對不同的查詢場景做優化,每個命令都有對應的驗證器和處理器 。整體體驗不錯
。一個類就把路由、架構設計
分層架構
整個項目采用了經典的三層架構
,三層之間的依賴關係是單向的:Web層依賴Infrastructure層 ,查詢操作直接使用DbContext。項目實現了領域事件和集成事件兩種機製。服務之間的連接字符串也會自動配置,直接測端點就行了
。外麵不能直接修改,如果將來需要增加新的業務邏輯
,Aspire會自動管理所有依賴服務,而且測試起來也很方便
,這個過程就可以通過領域事件來實現:
/// <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); } }}
這樣設計的好處是 ,
核心設計模式
1. 領域驅動設計(DDD)
在這個項目中 ,而且可以用投影來優化性能。代碼組織得也比較規範 。可以查看所有服務的狀態 。Infrastructure層負責技術實現,部門聚合和用戶聚合之間沒有直接依賴,後端用.NET 10 + EF Core + FastEndpoints + MediatR,
測試策略
測試這塊
,比如所有聚合根都用強類型ID ,另外還支持身份認證測試,Redis這些基礎設施,而且會自動清理測試數據 ,
技術棧上,比如檢查部門名稱是否已存在這種需要查數據庫的驗證,部門等基礎功能模塊。集成事件用於跨服務通信。
2. CQRS模式(命令查詢職責分離)
CQRS在這個項目中主要體現在讀寫分離上
。就是一個record。
比如說 ,比如文件的組織方式:
- 聚合根放在
Domain/AggregatesModel/{ AggregateName}Aggregate/ - 領域事件放在
Domain/DomainEvents/ - 倉儲放在
Infrastructure/Repositories/ - 命令放在
Web/Application/Commands/{ Module}Commands/ - 查詢放在
Web/Application/Queries/ - 端點放在
Web/Endpoints/{ Module}Endpoints/
還有一些強製性的要求,基本的管理後台需求都能滿足。一個端點就是一個類 ,有代碼片段、就拿部門這個聚合根來說吧:
/// <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 + TypeScript + Vite
,這是一個基於Vue 3的管理後台框架。省了很多麻煩。Aspire會自動管理所有依賴服務cd src/Ncp.Admin.AppHostdotnet run
Aspire會自動啟動和管理數據庫容器(MySQL、當部門信息變更的時候 ,另外 ,CQRS、還有代碼可視化工具,可以多語言切換。還集成了.NET Aspire來做雲原生的基礎設施管理 。可以看看這個項目的代碼 ,結合.NET 10和Vue 3搭建了一套完整的前後端分離架構。命令的定義很簡單,PostgreSQL和SQL Server ,這樣做的好處是職責清晰 ,Redis、認證、框架會自動轉換成合適的HTTP狀態碼。雲原生支持也很到位 ,支持路由權限和按鈕權限,可以模擬登錄用戶的各種操作。隻選擇需要的字段:
/// <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) { // 使用投影隻選擇需要的字段 ,經過一番調研 ,事件驅動這些架構思想。自動化工具,開箱即用的功能很多。職責分明 ,減少內存占用 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); }}這樣讀寫分離的好處是 ,
最重要的是類型安全,項目裏製定了一些開發規範。這個功能真的很方便。項目選擇了FastEndpoints而不是傳統的Controller。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 ,
基於NetCorePal Cloud Framework的DDD架構管理係統實踐
前段時間在做一個管理係統的項目,
寫操作這邊 ,狀態隻能通過業務方法來修改。采用了目前比較主流的技術棧:
後端方麵,啟動開發環境隻需要運行AppHost項目 ,命令鏈路圖 、
讀操作這邊,狀態管理用Pinia ,配合EF Core做數據訪問,而且不手動賦值ID,這樣就保證了業務規則的一致性。支持同步和異步驗證。保證測試之間的獨立性。最終選擇了NetCorePal Cloud Framework作為基礎框架 ,
開發規範
為了讓代碼質量更統一,用戶ID是UserId。類型安全有保障
。比如權限控製
,使用.NET 10作為主要框架,權限都配置好了 。有興趣的朋友可以深入了解一下:
- NetCorePal Cloud Framework - 項目使用的基礎框架
- FastEndpoints - 輕量級API框架
- Vben Admin - 前端管理後台模板
- .NET Aspire - 雲原生應用開發平台
項目源碼地址:https://github.com/zhouda1fu/Ncp.Admin
主要是覺得FastEndpoints的代碼更簡潔 ,用起來很順手。請求和響應都是強類型的,代碼分層清晰 ,事件流程圖 、用讀庫等,Web層處理HTTP請求和響應 。Infrastructure層依賴Domain層 ,看一個創建部門的例子:
/// <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 => $"該部門已存在,數據存儲支持MySQL
、希望能給正在做類似項目的朋友一些參考
。參考資料
最後附上一些相關的參考資料,epp可以生成FastEndpoint的完整實現。緩存用Redis,比如ncpcmd可以生成命令及其驗證器和處理器,Aspire讓基礎設施管理變得簡單。框架會自動處理。測試的是完整的HTTP請求流程
,這樣做的好處是編譯器能幫你檢查類型錯誤,
另外 ,ncpar可以生成聚合根,不會把部門ID和用戶ID搞混。項目用的是xUnit,項目還提供了很多代碼片段,Domain層作為核心
,或者想了解DDD在實際項目中的應用,Aspire會自動啟動和管理 。PostgreSQL等)
、整體架構清晰,Vite、比如用戶表中的部門名稱。在技術選型上
,角色
、接口定義好之後 ,技術棧也比較主流
:Vue 3 Composition API
、而不是直接用long或int
