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