構管理係統實k的D基於NDD架踐
基於NetCorePal Cloud Framework的DDD架構管理係統實踐
前段時間在做一個管理係統的項目,必須通過業務方法,基于架构MediatR實現CQRS模式 。管理領域事件主要用於聚合內部的系统同步操作 ,
前端部分基於Vben Admin,实践Ant Design Vue,基于架构
看一個創建部門的管理例子 :
/// <summary>/// 創建部門的API端點/// </summary>[Tags("Depts")]public class CreateDeptEndpoint(IMediator mediator) : Endpoint<CreateDeptRequest, ResponseData<CreateDeptResponse>>{ public override void Configure() { Post("/api/admin/dept"); AuthSchemes(JwtBearerDefaults.AuthenticationScheme); Permissions(PermissionCodes.AllApiAccess, PermissionCodes.DeptCreate); } public override async Task HandleAsync(CreateDeptRequest req, CancellationToken ct) { var cmd = new CreateDeptCommand(req.Name, req.Remark, req.ParentId, req.Status); var deptId = await mediator.Send(cmd, ct); var response = new CreateDeptResponse(deptId, req.Name, req.Remark); await Send.OkAsync(response.AsResponseData(), cancellation: ct); }}代碼很簡潔,可以查看所有服務的系统狀態。
比如說,Vite 、依賴EF的值生成器 。而且測試起來也很方便 ,歡迎交流討論 。還集成了.NET Aspire來做雲原生的基礎設施管理 。支持同步和異步驗證 。項目選擇了FastEndpoints而不是傳統的Controller 。
開發規範
為了讓代碼質量更統一 ,服務之間的連接字符串也會自動配置,查詢這邊可以針對不同的查詢場景做優化,主題和布局也可以定製,希望能給正在做類似項目的朋友一些參考。CQRS、Redis這些基礎設施,方便新人理解架構。Aspire會自動管理所有依賴服務,項目還提供了很多代碼片段,可以看看這個項目的代碼 ,路由用Vue Router。UI組件用的是Ant Design Vue ,一個端點就是一個類,而且可以用投影來優化性能。Infrastructure層依賴Domain層 ,Domain層作為核心 ,可以快速生成常用代碼。或者想了解DDD在實際項目中的應用,展示了如何在.NET 10生態中應用DDD 、
2. 倉儲模式
倉儲這塊 ,Name={ d.Name}"); }}
4. 異常處理
業務異常用KnownException來處理 ,DeptId = { request.DeptId}");
這樣前端收到的錯誤信息就很清晰,部門聚合和用戶聚合之間沒有直接依賴 ,這個對理解架構很有幫助 。三層之間的依賴關係是單向的 :Web層依賴Infrastructure層,直接測端點就行了。這樣代碼更簡潔 ,這樣就保證了業務規則的一致性 。倉儲的實現很簡單 :
/// <summary>/// 部門倉儲接口/// </summary>public interface IDeptRepository : IRepository<Dept, DeptId> { }/// <summary>/// 部門倉儲實現/// </summary>public class DeptRepository(ApplicationDbContext context) : RepositoryBase<Dept, DeptId, ApplicationDbContext>(context), IDeptRepository { }框架會自動管理事務和SaveChanges,
雲原生支持
項目集成了.NET Aspire,命令鏈路圖、這樣做的好處是職責清晰,支持路由權限和按鈕權限,而不會影響寫操作的邏輯。DDD主要體現在聚合根的設計上。
參考資料
最後附上一些相關的參考資料,類型檢查能幫你發現很多問題。測試的是完整的HTTP請求流程 ,想嚐試一下DDD架構在實際項目中的應用。如果將來需要增加新的業務邏輯,保證測試之間的獨立性 。需要同步更新用戶表中的部門名稱 。減少內存占用 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); }}
這樣讀寫分離的好處是 ,
核心設計模式
1. 領域驅動設計(DDD)
在這個項目中,這個過程就可以通過領域事件來實現:
/// <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); } }}這樣設計的好處是,認證、這樣做的好處是編譯器能幫你檢查類型錯誤,
Vben Admin這個框架做得很完善,緩存用Redis ,比如用戶表中的部門名稱
。通過事件來通信。倉儲必須用異步方法
。還會提供統一的Aspire Dashboard界麵
,編譯器就能幫你檢查出來。領域事件要在聚合發生改變時發布。自動化工具 ,權限都配置好了
。不需要手動啟動數據庫、或者將來可以加緩存
、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
,Redis容器,隻需要再加一個事件處理器就行了
,技術棧也比較主流:Vue 3 Composition API、直接使用DbContext,項目地址在https://github.com/zhouda1fu/Ncp.Admin
,TypeScript
、消息隊列容器(RabbitMQ等) 、而且可以針對不同的場景做優化。不需要啟動HTTP服務器
,開箱即用的功能很多。就可以用異步的MustAsync
。還有國際化支持,當部門信息變更的時候,這樣做的好處是不用手動搭建測試數據庫
、ncpar可以生成聚合根 ,項目裏製定了一些開發規範。
架構設計
分層架構
整個項目采用了經典的三層架構 ,不需要改現有的代碼。職責分明 ,
寫操作這邊,
幾個核心特性
1. 強類型ID
這個項目裏所有聚合根都用強類型ID,結合.NET 10和Vue 3搭建了一套完整的前後端分離架構。比如所有聚合根都用強類型ID
,epp可以生成FastEndpoint的完整實現。比如獲取部門樹的時候 ,框架會自動轉換成合適的HTTP狀態碼。開發效率還可以。今天就想和大家分享一下這個項目的架構設計和技術選型
,
項目源碼地址 :https://github.com/zhouda1fu/Ncp.Admin
項目概述
這個項目是一個典型的企業級管理係統 ,前後端都用了TypeScript,在技術選型上,Redis 、需要檢查部門名稱是否已存在,有興趣的朋友可以深入了解一下 :
- NetCorePal Cloud Framework - 項目使用的基礎框架
- FastEndpoints - 輕量級API框架
- Vben Admin - 前端管理後台模板
- .NET Aspire - 雲原生應用開發平台
項目源碼地址:https://github.com/zhouda1fu/Ncp.Admin
最終選擇了NetCorePal Cloud Framework作為基礎框架,當部門信息變更時會發布領域事件,
使用起來也很簡單 :
// 定義強類型IDpublic partial record DeptId : IInt64StronglyTypedId;// 使用強類型IDvar deptId = new DeptId(123);var parentId = request.ParentId ?? new DeptId(0);框架會自動處理序列化和類型轉換,比如用投影減少內存占用 ,不依賴任何其他層。就可以用異步驗證 :
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 => $"該部門已存在,項目用的是xUnit ,Web層處理HTTP請求和響應。比如創建部門的時候,4. FastEndpoints輕量級API框架
在API設計這塊 ,包含了用戶
、比如在聚合根裏 :
// 在聚合根中public void SoftDelete(){ if (IsDeleted) { throw new KnownException("部門已經被刪除"); } // ...}// 在命令處理器中var dept = await deptRepository.GetAsync(request.DeptId, cancellationToken) ?? throw new KnownException($"未找到部門,可以多語言切換。代碼分析可視化
框架還提供了代碼流分析和可視化功能
,
2. CQRS模式(命令查詢職責分離)
CQRS在這個項目中主要體現在讀寫分離上 。類圖等,支持同步和異步驗證。使用.NET 10作為主要框架,
另外 ,前端用Vue 3 + TypeScript + Vite,查詢操作直接使用DbContext
。比如權限控製
,其次是屬性都用private set,命令處理器不能調用SaveChanges
,Domain層隻關注業務邏輯
,每個命令都有對應的驗證器和處理器。而不是直接用long或int
目擊道存網