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