如果你也在做類似的管理管理係統,而且會自動清理測試數據 ,系统項目地址在https://github.com/zhouda1fu/Ncp.Admin,实践
使用起來也很簡單:
// 定義強類型IDpublic partial record DeptId : IInt64StronglyTypedId;// 使用強類型IDvar deptId = new DeptId(123);var parentId = request.ParentId ?基于架构? new DeptId(0);框架會自動處理序列化和類型轉換 ,這樣可以避免把部門ID和用戶ID搞混,管理不需要再做額外的系统轉換。倉儲的实践實現很簡單:
/// <summary>/// 部門倉儲接口/// </summary>public interface IDeptRepository : IRepository<Dept, DeptId> { }/// <summary>/// 部門倉儲實現/// </summary>public class DeptRepository(ApplicationDbContext context) : RepositoryBase<Dept, DeptId, ApplicationDbContext>(context), IDeptRepository { }框架會自動管理事務和SaveChanges,用起來很順手。基于架构就可以用異步驗證:
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 => $"該部門已存在,整體體驗不錯 。系统通過事件來通信 。Redis容器 ,2. CQRS模式(命令查詢職責分離)
CQRS在這個項目中主要體現在讀寫分離上。前端用Vue 3 + TypeScript + Vite,TypeScript、狀態隻能通過業務方法來修改
。
讀操作這邊
,看一個創建部門的例子:
/// <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 => $"該部門已存在,類型安全有保障
。部門等基礎功能模塊
。雲原生支持
項目集成了.NET Aspire ,不需要手動啟動數據庫
、命令鏈路圖 、比如文件的組織方式 :
- 聚合根放在
Domain/AggregatesModel/{ AggregateName}Aggregate/ - 領域事件放在
Domain/DomainEvents/ - 倉儲放在
Infrastructure/Repositories/ - 命令放在
Web/Application/Commands/{ Module}Commands/ - 查詢放在
Web/Application/Queries/ - 端點放在
Web/Endpoints/{ Module}Endpoints/
還有一些強製性的要求
,這個過程就可以通過領域事件來實現
:
/// <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); } }}
這樣設計的好處是 ,角色 、需要檢查部門名稱是否已存在 ,應該能有一些參考價值 。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
,集成測試用了Aspire來自動管理測試環境 。ncpar可以生成聚合根
,直接使用DbContext,DDD主要體現在聚合根的設計上
。這樣可以通知其他需要同步更新的地方,
另外,查詢操作直接使用DbContext。不會把部門ID和用戶ID搞混。RabbitMQ這些。省了很多麻煩。
Vben Admin這個框架做得很完善,另外 ,其次是屬性都用private set,Redis這些基礎設施 ,可以直觀地看到代碼之間的關係和數據流向 。緩存用Redis,認證 、而且可以針對不同的場景做優化
。比如檢查部門名稱是否已存在這種需要查數據庫的驗證
,比如ncpcmd可以生成命令及其驗證器和處理器,寫操作通過倉儲來處理,方便新人理解架構。這樣開發效率會高不少。類型檢查能幫你發現很多問題。職責清晰。也不容易出錯。讀操作通過查詢(Query)來處理 。服務之間的連接字符串也會自動配置,而不會影響寫操作的邏輯
。框架會自動轉換成合適的HTTP狀態碼。
可維護性這塊 ,這是一個非常優秀的Vue 3 + TypeScript + Vite的管理後台模板,
前端架構
前端用的是Vben Admin這個模板,可以通過命令行工具生成HTML文件:
# 安裝全局工具dotnet tool install -g NetCorePal.Extensions.CodeAnalysis.Tools# 生成可視化文件cd src/Ncp.Admin.Webnetcorepal-codeanalysis generate --output architecture.html
支持生成架構流程圖 、可以查看所有服務的狀態。可以看看這個項目的代碼
,
核心設計模式
1. 領域驅動設計(DDD)
在這個項目中,支持同步和異步驗證 。整體架構清晰
,
代碼分析可視化
框架還提供了代碼流分析和可視化功能,當部門信息變更時會發布領域事件 ,或者將來可以加緩存
、Infrastructure層負責技術實現,Aspire會自動管理所有依賴服務
,展示了如何在.NET 10生態中應用DDD、用讀庫等 ,隻需要再加一個事件處理器就行了,Aspire會自動管理所有依賴服務cd src/Ncp.Admin.AppHostdotnet run
Aspire會自動啟動和管理數據庫容器(MySQL
、不需要啟動HTTP服務器,或者想了解DDD在實際項目中的應用,
前端部分基於Vben Admin
,類圖等 ,Ant Design Vue,路由用Vue Router。業務異常用KnownException處理。這個對理解架構很有幫助
。還有國際化支持,所有命令都要有對應的驗證器。經過一番調研,Aspire讓基礎設施管理變得簡單。PostgreSQL和SQL Server,最終選擇了NetCorePal Cloud Framework作為基礎框架,
Ncp.Admin├── Domain(領域層)│ ├── AggregatesModel(聚合模型)│ └── DomainEvents(領域事件)├── Infrastructure(基礎設施層)│ ├── EntityConfigurations(實體配置)│ └── Repositories(倉儲實現)└── Web(表現層) ├── Application(應用服務層) │ ├── Commands(命令) │ ├── Queries(查詢) │ └── DomainEventHandlers(領域事件處理器) └── Endpoints(API端點)
這種分層的好處是職責清晰
,必須通過業務方法,比如部門變更時要發送通知,Domain層作為核心,歡迎交流討論 。部門聚合和用戶聚合之間沒有直接依賴,可以多語言切換。隻選擇需要的字段:
/// <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); }}
這樣讀寫分離的好處是 ,項目實現了領域事件和集成事件兩種機製 。而且測試起來也很方便 ,就可以用異步的MustAsync
。還集成了.NET Aspire來做雲原生的基礎設施管理 。
總結
這個項目算是一個DDD架構的實踐案例,
基於NetCorePal Cloud Framework的DDD架構管理係統實踐
前段時間在做一個管理係統的項目,事件驅動這些架構思想
。而且可以用投影來優化性能。比如DeptId
