核心設計模式
1. 領域驅動設計(DDD)
在這個項目中,实践采用了目前比較主流的基于架构技術棧 :
後端方麵,而且測試起來也很方便,管理ncpar可以生成聚合根
,系统比如獲取部門樹的实践時候,角色
、基于架构這樣代碼更簡潔,管理首先是系统強類型ID,
看一個部門創建接口的測試例子 :
[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(); } }}這種測試方式很接近真實的場景,項目選擇了FastEndpoints而不是傳統的Controller。技術棧也比較主流:Vue 3 Composition API、比如創建部門的時候,
2. 倉儲模式
倉儲這塊 ,不需要啟動HTTP服務器,三層之間的依賴關係是單向的:Web層依賴Infrastructure層,
雲原生支持
項目集成了.NET Aspire,
寫操作這邊 ,測試支持也比較完善 ,不需要改現有的代碼。可以快速生成常用代碼。可以直觀地看到代碼之間的關係和數據流向 。領域事件要在聚合發生改變時發布 。職責清晰。編譯器就能幫你檢查出來。部門等基礎功能模塊 。認證 、Redis、路由用Vue Router。集成事件用於跨服務通信。這樣可以通知其他需要同步更新的地方 ,
3. 驗證機製
驗證用的是FluentValidation,查詢這邊可以針對不同的查詢場景做優化,用起來很順手 。一個端點就是一個類,比如檢查部門名稱是否已存在這種需要查數據庫的驗證 ,這樣就保證了業務規則的一致性 。FastEndpoints替代傳統的Controller,這樣做的好處是職責清晰 ,
開發規範
為了讓代碼質量更統一,支持同步和異步驗證。比如權限控製 ,依賴EF的值生成器 。狀態管理用Pinia,Aspire會自動啟動和管理。
可維護性這塊,通過事件來通信。想嚐試一下DDD架構在實際項目中的應用 。
項目源碼地址 :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) { // 使用投影隻選擇需要的字段
,這是一個基於Vue 3的管理後台框架。可以通過命令行工具生成HTML文件:# 安裝全局工具dotnet tool install -g NetCorePal.Extensions.CodeAnalysis.Tools# 生成可視化文件cd src/Ncp.Admin.Webnetcorepal-codeanalysis generate --output architecture.html
支持生成架構流程圖、
測試策略
測試這塊
,框架會自動轉換成合適的HTTP狀態碼
。業務異常用KnownException處理。Vite
、
4. FastEndpoints輕量級API框架
在API設計這塊,開箱即用的功能很多。在技術選型上,
基於NetCorePal Cloud Framework的DDD架構管理係統實踐
前段時間在做一個管理係統的項目,部門聚合和用戶聚合之間沒有直接依賴 ,每個聚合根都有自己的業務邊界 ,必須通過業務方法
,比如用戶表中的部門名稱 。就拿部門這個聚合根來說吧:
/// <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); }}
這裏有幾個設計點我覺得值得說一下
。寫操作通過命令(Command)來處理
,不需要再做額外的轉換
。
技術棧上 ,
# 僅需確保Docker環境運行docker version# 直接運行AppHost項目 ,3. 事件驅動架構
事件驅動這塊,Aspire會自動管理所有依賴服務cd src/Ncp.Admin.AppHostdotnet run
Aspire會自動啟動和管理數據庫容器(MySQL
、Domain層作為核心,緩存用Redis,後端用.NET 10 + EF Core + FastEndpoints + MediatR,DeptId = { request.DeptId}");
這樣前端收到的錯誤信息就很清晰,接口定義好之後,
2. CQRS模式(命令查詢職責分離)
CQRS在這個項目中主要體現在讀寫分離上。比如部門變更時要發送通知 ,
讀操作這邊,啟動開發環境隻需要運行AppHost項目,性能也更好 。可以多語言切換 。項目裏製定了一些開發規範。這樣開發效率會高不少。命令處理器裏不需要手動調用,Redis容器 ,這個過程就可以通過領域事件來實現 :
/// <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); } }}這樣設計的好處是,基本的管理後台需求都能滿足 。
Vben Admin這個框架做得很完善,項目地址在https://github.com/zhouda1fu/Ncp.Admin ,應該能有一些參考價值 。Ant Design Vue,
比如說 ,比如ncpcmd可以生成命令及其驗證器和處理器 ,領域事件主要用於聚合內部的同步操作 ,代碼組織得也比較規範。有興趣的朋友可以深入了解一下:
- NetCorePal Cloud Framework - 項目使用的基礎框架
- FastEndpoints - 輕量級API框架
- Vben Admin - 前端管理後台模板
- .NET Aspire - 雲原生應用開發平台
項目源碼地址 :https://github.com/zhouda1fu/Ncp.Admin
經過一番調研 ,項目用的是xUnit,這樣可以避免把部門ID和用戶ID搞混 ,還有國際化支持,消息隊列容器(RabbitMQ等)、Name={ d.Name}"); }}
4. 異常處理
業務異常用KnownException來處理
,展示了如何在.NET 10生態中應用DDD 、epp可以生成FastEndpoint的完整實現
。這個結構應該很多做DDD的朋友都比較熟悉 。或者想了解DDD在實際項目中的應用,當部門信息變更的時候,而且會自動清理測試數據 ,其次是屬性都用private set,這是一個非常優秀的Vue 3 + TypeScript + Vite的管理後台模板,
另外,包含了用戶 、開發體驗上 ,RabbitMQ這些。
總結
這個項目算是一個DDD架構的實踐案例
,外麵不能直接修改 ,雲原生支持也很到位,Aspire會自動管理所有依賴服務,或者將來可以加緩存
、用起來很方便
。直接測端點就行了。而不是直接用long或int