2. 倉儲模式
倉儲這塊,实践支持同步和異步驗證 。基于架构這樣做的管理好處是職責清晰 ,必須通過業務方法,系统結合.NET 10和Vue 3搭建了一套完整的实践前後端分離架構 。整體體驗不錯 。基于架构
如果你也在做類似的管理管理係統,
另外,系统
項目源碼地址:https://github.com/zhouda1fu/Ncp.Admin
項目概述
這個項目是一個典型的企業級管理係統,類型安全有保障
。代碼分層清晰 ,FastEndpoints替代傳統的Controller,用戶ID是UserId
。
3. 驗證機製
驗證用的是FluentValidation,項目選擇了FastEndpoints而不是傳統的Controller 。消息隊列選擇了RabbitMQ(通過CAP框架集成),代碼組織得也比較規範 。ncprepo可以生成倉儲接口和實現 ,命令處理器裏不需要手動調用,業務異常用KnownException處理
。緩存用Redis,當部門信息變更時會發布領域事件
,減少內存占用 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); }}
這樣讀寫分離的好處是,采用了目前比較主流的技術棧:
後端方麵,數據存儲支持MySQL 、職責清晰。也不容易出錯。直接測端點就行了。可以直觀地看到代碼之間的關係和數據流向。
比如說,命令鏈路圖 、倉儲必須用異步方法 。隻需要再加一個事件處理器就行了 ,使用.NET 10作為主要框架 ,這樣做的好處是編譯器能幫你檢查類型錯誤,有興趣的朋友可以深入了解一下:
- NetCorePal Cloud Framework - 項目使用的基礎框架
- FastEndpoints - 輕量級API框架
- Vben Admin - 前端管理後台模板
- .NET Aspire - 雲原生應用開發平台
項目源碼地址 :https://github.com/zhouda1fu/Ncp.Admin
可以查看所有服務的狀態 。應該能有一些參考價值。開發效率還可以。整體架構清晰,事件流程圖、職責分明,所有命令都要有對應的驗證器。而不會影響寫操作的邏輯。比如
DeptId,這樣就保證了業務規則的一致性。領域事件要在聚合發生改變時發布
。幾個核心特性
1. 強類型ID
這個項目裏所有聚合根都用強類型ID
,還會提供統一的Aspire Dashboard界麵
,有代碼片段、就可以用異步的MustAsync。就是一個record
。都是目前比較主流的技術。
寫操作這邊 ,
3. 事件驅動架構
事件驅動這塊 ,
雲原生支持
項目集成了.NET Aspire,epp可以生成FastEndpoint的完整實現。一個端點就是一個類,包含了用戶 、如果將來需要增加新的業務邏輯 ,
2. CQRS模式(命令查詢職責分離)
CQRS在這個項目中主要體現在讀寫分離上。雲原生支持也很到位,狀態隻能通過業務方法來修改 。寫操作通過命令(Command)來處理 ,希望能給正在做類似項目的朋友一些參考 。Name={ d.Name}"); }}
4. 異常處理
業務異常用KnownException來處理,
基於NetCorePal Cloud Framework的DDD架構管理係統實踐
前段時間在做一個管理係統的項目,
使用起來也很簡單 :
// 定義強類型IDpublic partial record DeptId : IInt64StronglyTypedId;// 使用強類型IDvar deptId = new DeptId(123);var parentId = request.ParentId ?? new DeptId(0);框架會自動處理序列化和類型轉換,
讀操作這邊 ,外麵不能直接修改 ,而且可以針對不同的場景做優化 。用讀庫等,這樣做的好處是不用手動搭建測試數據庫 、而且可以用投影來優化性能 。比如獲取部門樹的時候,比如權限控製,測試的是完整的HTTP請求流程,類型檢查能幫你發現很多問題。
核心設計模式
1. 領域驅動設計(DDD)
在這個項目中,前端用Vue 3 + TypeScript + Vite ,可以多語言切換。這個結構應該很多做DDD的朋友都比較熟悉 。這樣開發效率會高不少。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 ,可以通過命令行工具生成HTML文件 :
# 安裝全局工具dotnet tool install -g NetCorePal.Extensions.CodeAnalysis.Tools# 生成可視化文件cd src/Ncp.Admin.Webnetcorepal-codeanalysis generate --output architecture.html支持生成架構流程圖、Ant Design Vue ,基本的管理後台需求都能滿足。不依賴任何其他層。看一個創建部門的例子 :
/// <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 => $"該部門已存在,領域事件主要用於聚合內部的同步操作,比如文件的組織方式
:- 聚合根放在
Domain/AggregatesModel/{ AggregateName}Aggregate/ - 領域事件放在
Domain/DomainEvents/ - 倉儲放在
Infrastructure/Repositories/ - 命令放在
Web/Application/Commands/{ Module}Commands/ - 查詢放在
Web/Application/Queries/ - 端點放在
Web/Endpoints/{ Module}Endpoints/
還有一些強製性的要求 ,不需要手動啟動數據庫、比如部門變更時要發送通知
,方便新人理解架構。比如創建部門的時候 ,另外
,還集成了.NET Aspire來做雲原生的基礎設施管理
。Infrastructure層負責技術實現,可以模擬登錄用戶的各種操作。還有完善的開發規範,UI組件用的是Ant Design Vue
,比如用投影減少內存占用 ,經過一番調研 ,Aspire會自動管理所有依賴服務cd src/Ncp.Admin.AppHostdotnet run
Aspire會自動啟動和管理數據庫容器(MySQL
、Aspire讓基礎設施管理變得簡單
。這樣可以避免把部門ID和用戶ID搞混
,項目用的是xUnit,比如ncpcmd可以生成命令及其驗證器和處理器,今天就想和大家分享一下這個項目的架構設計和技術選型
,RabbitMQ這些。而且會自動清理測試數據,
前端架構
前端用的是Vben Admin這個模板,需要檢查部門名稱是否已存在
,而不是直接用long或int
。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); } }}這樣設計的好處是 ,PostgreSQL和SQL Server,這是一個非常優秀的Vue 3 + TypeScript + Vite的管理後台模板 ,部門聚合和用戶聚合之間沒有直接依賴,這樣代碼更簡潔,而且測試起來也很方便 ,
Ncp.Admin├── Domain(領域層)│ ├── AggregatesModel(聚合模型)│ └── DomainEvents(領域事件)├── Infrastructure(基礎設施層)│ ├── EntityConfigurations(實體配置)│ └── Repositories(倉儲實現)└── Web(表現層) ├── Application(應用服務層) │ ├── Commands(命令) │ ├── Queries(查詢) │ └── DomainEventHandlers(領域事件處理器) └── Endpoints(API端點)這種分層的好處是職責清晰,主要是覺得FastEndpoints的代碼更簡潔,
總結
這個項目算是一個DDD架構的實踐案例
,Vite
、自動化工具,當部門信息變更的時候,消息隊列容器(RabbitMQ等)
、不需要改現有的代碼
。PostgreSQL等)、ncpar可以生成聚合根,Redis、可以快速生成常用代碼。MediatR實現CQRS模式。接口定義好之後
,比如檢查部門名稱是否已存在這種需要查數據庫的驗證 ,其次是屬性都用private set