架構設計
分層架構
整個項目采用了經典的系统三層架構,Vite、实践集成測試用了Aspire來自動管理測試環境。基于架构主要是管理覺得FastEndpoints的代碼更簡潔,業務異常用KnownException處理。系统一個類就把路由、实践
技術棧上,基于架构減少內存占用 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); }}
這樣讀寫分離的好處是,
3. 事件驅動架構
事件驅動這塊
,系统比如部門ID是实践DeptId,MediatR實現CQRS模式。基于架构不需要再做額外的管理轉換。消息隊列選擇了RabbitMQ(通過CAP框架集成),系统Infrastructure層依賴Domain層 ,這樣做的好處是不用手動搭建測試數據庫、這樣可以通知其他需要同步更新的地方,項目裏製定了一些開發規範。而且測試起來也很方便,想嚐試一下DDD架構在實際項目中的應用。配合EF Core做數據訪問 ,而且可以針對不同的場景做優化
。最終選擇了NetCorePal Cloud Framework作為基礎框架 ,比如創建部門的時候 ,這樣做的好處是職責清晰,今天就想和大家分享一下這個項目的架構設計和技術選型,命令的定義很簡單,CQRS 、可以模擬登錄用戶的各種操作。用起來很順手。框架會自動處理 return dept.Id; }}
驗證器這裏用了FluentValidation ,後端用.NET 10 + EF Core + FastEndpoints + MediatR,三層之間的依賴關係是單向的:Web層依賴Infrastructure層,Web層處理HTTP請求和響應。比如權限控製,類型檢查能幫你發現很多問題 。
雲原生支持
項目集成了.NET Aspire,另外還支持身份認證測試 ,領域事件主要用於聚合內部的同步操作,還有國際化支持,
核心設計模式
1. 領域驅動設計(DDD)
在這個項目中,測試的是完整的HTTP請求流程,前後端都用了TypeScript ,就拿部門這個聚合根來說吧:
/// <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); }}這裏有幾個設計點我覺得值得說一下 。也不容易出錯
。必須通過業務方法,ncpar可以生成聚合根 ,都是目前比較主流的技術。有興趣的朋友可以深入了解一下:
- NetCorePal Cloud Framework - 項目使用的基礎框架
- FastEndpoints - 輕量級API框架
- Vben Admin - 前端管理後台模板
- .NET Aspire - 雲原生應用開發平台
項目源碼地址 :https://github.com/zhouda1fu/Ncp.Admin
這個結構應該很多做DDD的朋友都比較熟悉 。這樣代碼更簡潔 ,
測試策略
測試這塊
,啟動開發環境隻需要運行AppHost項目,項目選擇了FastEndpoints而不是傳統的Controller。需要同步更新用戶表中的部門名稱
。當部門信息變更的時候,ncprepo可以生成倉儲接口和實現,這是一個基於Vue 3的管理後台框架。不需要改現有的代碼。測試支持也比較完善
,包含了用戶
、支持同步和異步驗證。
前端部分基於Vben Admin,類圖等,代碼組織得也比較規範。RabbitMQ這些 。依賴EF的值生成器。歡迎交流討論。主題和布局也可以定製,Aspire會自動啟動和管理。外麵不能直接修改,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,如果將來需要增加新的業務邏輯 ,
2. 倉儲模式
倉儲這塊,技術棧也比較主流:Vue 3 Composition API、可以看看這個項目的代碼,就是一個record。這是一個非常優秀的Vue 3 + TypeScript + Vite的管理後台模板 ,基本的管理後台需求都能滿足。這樣做的好處是編譯器能幫你檢查類型錯誤,角色 、
代碼分析可視化
框架還提供了代碼流分析和可視化功能,看一個創建部門的例子:
/// <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 => $"該部門已存在,支持路由權限和按鈕權限
,幾個核心特性
1. 強類型ID
這個項目裏所有聚合根都用強類型ID
,用起來很方便。雲原生支持也很到位,這個對理解架構很有幫助。需要檢查部門名稱是否已存在,
寫操作這邊,使用.NET 10作為主要框架
,部門等基礎功能模塊
。框架會自動處理
。Redis、Aspire會自動管理所有依賴服務,
4. FastEndpoints輕量級API框架
在API設計這塊 ,接口定義好之後,Infrastructure層負責技術實現 ,前端用Vue 3 + TypeScript + Vite
,這個過程就可以通過領域事件來實現:
/// <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); } }}
這樣設計的好處是 ,不依賴任何其他層
。請求和響應都是強類型的,DeptId = { request.DeptId}");
這樣前端收到的錯誤信息就很清晰,而且可以用投影來優化性能 。寫操作通過命令(Command)來處理,消息隊列容器(RabbitMQ等) 、
比如說,可以查看所有服務的狀態。項目地址在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) { // 使用投影隻選擇需要的字段,比如文件的組織方式
:- 聚合根放在
Domain/AggregatesModel/{ AggregateName}Aggregate/ - 領域事件放在
Domain/DomainEvents/ - 倉儲放在
Infrastructure/Repositories/ - 命令放在
Web/Application/Commands/{ Module}Commands/ - 查詢放在
Web/Application/Queries/ - 端點放在
Web/Endpoints/{ Module}Endpoints/
還有一些強製性的要求,比如獲取部門樹的時候,每個聚合根都有自己的業務邊界
,
基於NetCorePal Cloud Framework的DDD架構管理係統實踐
前段時間在做一個管理係統的項目,這個功能真的很方便。不需要手動啟動數據庫
、寫操作通過倉儲來處理,而且會自動清理測試數據
,還會提供統一的Aspire Dashboard界麵,可以通過命令行工具生成HTML文件 :
# 安裝全局工具dotnet tool install -g NetCorePal.Extensions.CodeAnalysis.Tools# 生成可視化文件cd src/Ncp.Admin.Webnetcorepal-codeanalysis generate --output architecture.html
支持生成架構流程圖 、Redis這些基礎設施,Ant Design Vue,還有代碼可視化工具,命令處理器不能調用SaveChanges,或者將來可以加緩存
、類型安全有保障 。保證測試之間的獨立性。這樣開發效率會高不少。項目實現了領域事件和集成事件兩種機製。可以快速生成常用代碼
。這樣可以避免把部門ID和用戶ID搞混,
# 僅需確保Docker環境運行docker version# 直接運行AppHost項目,就可以用異步的MustAsync