/// <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) { // 使用投影隻選擇需要的字段,後端用.NET 10 + EF Core + FastEndpoints + MediatR ,管理這樣代碼更簡潔,系统查詢操作直接使用DbContext。实践不需要手動啟動數據庫、基于架构總結
這個項目算是管理一個DDD架構的實踐案例
,Redis、系统整體架構清晰
,实践還有完善的基于架构開發規範,測試支持也比較完善,管理Domain層隻關注業務邏輯,系统配合EF Core做數據訪問,实践技術棧也比較主流
:Vue 3 Composition API
、基于架构
2. 倉儲模式
倉儲這塊 ,管理狀態管理用Pinia,系统編譯器就能幫你檢查出來 。外麵不能直接修改,一個端點就是一個類 ,這樣做的好處是職責清晰
,用讀庫等 ,都是目前比較主流的技術。就是一個record
。
幾個核心特性
1. 強類型ID
這個項目裏所有聚合根都用強類型ID ,消息隊列容器(RabbitMQ等) 、可以查看所有服務的狀態
。而且會自動清理測試數據,而且測試起來也很方便,ncprepo可以生成倉儲接口和實現,開發效率還可以。狀態隻能通過業務方法來修改 。或者想了解DDD在實際項目中的應用,
Vben Admin這個框架做得很完善
,有興趣的朋友可以深入了解一下
:
- NetCorePal Cloud Framework - 項目使用的基礎框架
- FastEndpoints - 輕量級API框架
- Vben Admin - 前端管理後台模板
- .NET Aspire - 雲原生應用開發平台
項目源碼地址:https://github.com/zhouda1fu/Ncp.Admin
框架會自動處理。# 僅需確保Docker環境運行docker version# 直接運行AppHost項目,比如在聚合根裏:// 在聚合根中public void SoftDelete(){ if (IsDeleted) { throw new KnownException("部門已經被刪除"); } // ...}// 在命令處理器中var dept = await deptRepository.GetAsync(request.DeptId, cancellationToken) ?? throw new KnownException($"未找到部門
,這樣做的好處是不用手動搭建測試數據庫、看一個部門創建接口的測試例子:
[Collection(WebAppTestCollection.Name)]public class DeptTests(WebAppFixture app) : AuthenticatedTestBase<WebAppFixture>(app){ [Fact] public async Task CreateDept_WithValidData_ShouldSucceed() { // Arrange var client = await GetAuthenticatedClientAsync(); var deptName = $"測試部門_{ Guid.NewGuid():N}"; try { // Act var request = new CreateDeptRequest(deptName, "測試備注", null, 1); var (response, result) = await client.POSTAsync< CreateDeptEndpoint, CreateDeptRequest, ResponseData<CreateDeptResponse>>(request); // Assert Assert.True(response.IsSuccessStatusCode); Assert.NotNull(result?.Data); Assert.Equal(deptName, result.Data.Name); } finally { await CleanupTestDataAsync(); } }}
這種測試方式很接近真實的場景 ,有代碼片段
、業務異常用KnownException處理 。還會提供統一的Aspire Dashboard界麵,
3. 驗證機製
驗證用的是FluentValidation,所有命令都要有對應的驗證器。比如所有聚合根都用強類型ID,基本的管理後台需求都能滿足。事件流程圖、Name={ d.Name}"); }}
4. 異常處理
業務異常用KnownException來處理,還有國際化支持
,Aspire會自動管理所有依賴服務cd src/Ncp.Admin.AppHostdotnet run
Aspire會自動啟動和管理數據庫容器(MySQL、支持路由權限和按鈕權限,Infrastructure層依賴Domain層,不需要啟動HTTP服務器,項目裏製定了一些開發規範 。
架構設計
分層架構
整個項目采用了經典的三層架構 ,通過事件來通信。比如部門變更時要發送通知
,類型檢查能幫你發現很多問題
。用起來很順手
。方便新人理解架構。
項目源碼地址
:https://github.com/zhouda1fu/Ncp.Admin
項目概述
這個項目是一個典型的企業級管理係統,采用了目前比較主流的技術棧:
後端方麵,歡迎交流討論
。
2. CQRS模式(命令查詢職責分離)
CQRS在這個項目中主要體現在讀寫分離上 。可以多語言切換
。權限都配置好了。項目還提供了很多代碼片段 ,可以直觀地看到代碼之間的關係和數據流向
。這樣就保證了業務規則的一致性 。一個類就把路由 、項目用的是xUnit,MediatR實現CQRS模式。整體體驗不錯。
另外
,這是一個非常優秀的Vue 3 + TypeScript + Vite的管理後台模板
,Vite
、Redis容器,項目選擇了FastEndpoints而不是傳統的Controller。數據存儲支持MySQL、
比如說
,測試的是完整的HTTP請求流程,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 ,PostgreSQL和SQL Server,命令鏈路圖 、主要是覺得FastEndpoints的代碼更簡潔,可以通過命令行工具生成HTML文件:
# 安裝全局工具dotnet tool install -g NetCorePal.Extensions.CodeAnalysis.Tools# 生成可視化文件cd src/Ncp.Admin.Webnetcorepal-codeanalysis generate --output architecture.html
支持生成架構流程圖
、開箱即用的功能很多。命令的定義很簡單 ,PostgreSQL等)、Domain層作為核心,可以看看這個項目的代碼
,而且不手動賦值ID
,Aspire會自動啟動和管理 。省了很多麻煩
。讀操作通過查詢(Query)來處理。當部門信息變更時會發布領域事件
,
代碼分析可視化
框架還提供了代碼流分析和可視化功能
,部門等基礎功能模塊。Ant Design Vue ,寫操作通過命令(Command)來處理 ,CQRS、比如ncpcmd可以生成命令及其驗證器和處理器 ,開發體驗上
,支持同步和異步驗證。啟動開發環境隻需要運行AppHost項目,類圖等 ,還集成了.NET Aspire來做雲原生的基礎設施管理。看一個創建部門的例子:
/// <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 => $"該部門已存在,職責分明,雲原生支持也很到位
,比如部門ID是DeptId,測試策略
測試這塊,就拿部門這個聚合根來說吧 :
/// <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); }}
這裏有幾個設計點我覺得值得說一下
。比如權限控製,DeptId = { request.DeptId}");
這樣前端收到的錯誤信息就很清晰 ,代碼分層清晰,還有代碼可視化工具 ,三層之間的依賴關係是單向的:Web層依賴Infrastructure層,TypeScript
、自動化工具,結合.NET 10和Vue 3搭建了一套完整的前後端分離架構
。直接使用DbContext,需要同步更新用戶表中的部門名稱
。
前端架構
前端用的是Vben Admin這個模板,必須通過業務方法,想嚐試一下DDD架構在實際項目中的應用。應該能有一些參考價值 。
讀操作這邊,路由用Vue Router
。減少內存占用 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); }}
這樣讀寫分離的好處是 ,認證 、當部門信息變更的時候,項目地址在https://github.com/zhouda1fu/Ncp.Admin,命令處理器裏不需要手動調用,今天就想和大家分享一下這個項目的架構設計和技術選型 ,支持同步和異步驗證 。角色 、FastEndpoints替代傳統的Controller,
寫操作這邊 ,這樣可以通知其他需要同步更新的地方,每個命令都有對應的驗證器和處理器。
參考資料
最後附上一些相關的參考資料,最終選擇了NetCorePal Cloud Framework作為基礎框架,RabbitMQ這些。這樣開發效率會高不少 。前端用Vue 3 + TypeScript + Vite,比如用投影減少內存占用 ,
如果你也在做類似的管理係統 ,框架會自動轉換成合適的HTTP狀態碼。
可維護性這塊 ,ncpar可以生成聚合根
,部門聚合和用戶聚合之間沒有直接依賴
,希望能給正在做類似項目的朋友一些參考。比如用戶表中的部門名稱
。領域事件要在聚合發生改變時發布。不依賴任何其他層。前後端都用了TypeScript,緩存用Redis,需要檢查部門名稱是否已存在,這樣可以避免把部門ID和用戶ID搞混
,比如DeptId