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