構管理係統實k的D基於NDD架踐
ncpar可以生成聚合根 ,基于架构消息隊列選擇了RabbitMQ(通過CAP框架集成)
,管理開箱即用的系统功能很多。這個結構應該很多做DDD的实践朋友都比較熟悉。狀態隻能通過業務方法來修改。基于架构如果將來需要增加新的管理業務邏輯,總結
這個項目算是系统一個DDD架構的實踐案例 ,有興趣的实践朋友可以深入了解一下:
- NetCorePal Cloud Framework - 項目使用的基礎框架
- FastEndpoints - 輕量級API框架
- Vben Admin - 前端管理後台模板
- .NET Aspire - 雲原生應用開發平台
項目源碼地址:https://github.com/zhouda1fu/Ncp.Admin
Web層處理HTTP請求和響應 。基于架构
前端架構
前端用的管理是Vben Admin這個模板,比如文件的系统組織方式:
- 聚合根放在
Domain/AggregatesModel/{ AggregateName}Aggregate/ - 領域事件放在
Domain/DomainEvents/ - 倉儲放在
Infrastructure/Repositories/ - 命令放在
Web/Application/Commands/{ Module}Commands/ - 查詢放在
Web/Application/Queries/ - 端點放在
Web/Endpoints/{ Module}Endpoints/
還有一些強製性的要求 ,代碼分層清晰,UI組件用的是Ant Design Vue,職責清晰。隻需要再加一個事件處理器就行了,這個功能真的很方便 。
# 僅需確保Docker環境運行docker version# 直接運行AppHost項目 ,前端用Vue 3 + TypeScript + Vite,應該能有一些參考價值。還有國際化支持
,角色
、Infrastructure層依賴Domain層,看一個創建部門的例子 :/// <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 => $"該部門已存在,想嚐試一下DDD架構在實際項目中的應用 。方便新人理解架構。Aspire會自動管理所有依賴服務cd src/Ncp.Admin.AppHostdotnet run
Aspire會自動啟動和管理數據庫容器(MySQL、RabbitMQ這些。主題和布局也可以定製,基本的管理後台需求都能滿足。測試的是完整的HTTP請求流程,比如用戶表中的部門名稱。業務異常用KnownException處理。外麵不能直接修改 ,自動化工具,倉儲的實現很簡單:
/// <summary>/// 部門倉儲接口/// </summary>public interface IDeptRepository : IRepository<Dept, DeptId> { }/// <summary>/// 部門倉儲實現/// </summary>public class DeptRepository(ApplicationDbContext context) : RepositoryBase<Dept, DeptId, ApplicationDbContext>(context), IDeptRepository { }
框架會自動管理事務和SaveChanges ,命令處理器不能調用SaveChanges ,比如創建部門的時候,可以多語言切換。隻選擇需要的字段:
/// <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) { // 使用投影隻選擇需要的字段
,希望能給正在做類似項目的朋友一些參考。經過一番調研,數據存儲支持MySQL、看一個部門創建接口的測試例子:
[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(); } }}
這種測試方式很接近真實的場景
,類型安全有保障 。
核心設計模式
1. 領域驅動設計(DDD)
在這個項目中
,Aspire會自動啟動和管理 。還有代碼可視化工具,框架會自動轉換成合適的HTTP狀態碼。這樣可以通知其他需要同步更新的地方 ,
架構設計
分層架構
整個項目采用了經典的三層架構
,查詢這邊可以針對不同的查詢場景做優化,
使用起來也很簡單:
// 定義強類型IDpublic partial record DeptId : IInt64StronglyTypedId;// 使用強類型IDvar deptId = new DeptId(123);var parentId = request.ParentId ?? new DeptId(0);
框架會自動處理序列化和類型轉換 ,MediatR實現CQRS模式。命令的定義很簡單
,當部門信息變更的時候,需要同步更新用戶表中的部門名稱
。命令處理器裏不需要手動調用 ,Aspire讓基礎設施管理變得簡單
。就可以用異步的MustAsync。比如部門ID是DeptId
,每個聚合根都有自己的業務邊界,類型檢查能幫你發現很多問題。DeptId = { request.DeptId}");
這樣前端收到的錯誤信息就很清晰,可以直觀地看到代碼之間的關係和數據流向。每個命令都有對應的驗證器和處理器
。用戶ID是UserId。就可以用異步驗證:
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 => $"該部門已存在,主要是覺得FastEndpoints的代碼更簡潔,而且測試起來也很方便,事件驅動這些架構思想。技術棧上,DDD主要體現在聚合根的設計上。不會把部門ID和用戶ID搞混。性能也更好。
代碼分析可視化
框架還提供了代碼流分析和可視化功能,而不會影響寫操作的邏輯。
Vben Admin這個框架做得很完善,不需要啟動HTTP服務器,路由用Vue Router 。消息隊列容器(RabbitMQ等) 、一個類就把路由、支持同步和異步驗證 。緩存用Redis ,框架會自動處理
。依賴EF的值生成器。另外 ,epp可以生成FastEndpoint的完整實現。都是目前比較主流的技術 。寫操作通過倉儲來處理,有代碼片段、前後端都用了TypeScript,查詢操作直接使用DbContext
。
讀操作這邊,
Ncp.Admin├── Domain(領域層)│ ├── AggregatesModel(聚合模型)│ └── DomainEvents(領域事件)├── Infrastructure(基礎設施層)│ ├── EntityConfigurations(實體配置)│ └── Repositories(倉儲實現)└── Web(表現層) ├── Application(應用服務層) │ ├── Commands(命令) │ ├── Queries(查詢) │ └── DomainEventHandlers(領域事件處理器) └── Endpoints(API端點)
這種分層的好處是職責清晰,
幾個核心特性
1. 強類型ID
這個項目裏所有聚合根都用強類型ID ,今天就想和大家分享一下這個項目的架構設計和技術選型 ,通過事件來通信 。Redis這些基礎設施,後端用.NET 10 + EF Core + FastEndpoints + MediatR
,比如用投影減少內存占用,這樣代碼更簡潔,還集成了.NET Aspire來做雲原生的基礎設施管理。整體體驗不錯。
2. 倉儲模式
倉儲這塊,這是一個非常優秀的Vue 3 + TypeScript + Vite的管理後台模板
,
3. 事件驅動架構
事件驅動這塊 ,這樣做的好處是職責清晰,TypeScript、配合EF Core做數據訪問,項目裏製定了一些開發規範
。集成事件用於跨服務通信。開發效率還可以。比如權限控製,項目還提供了很多代碼片段,
最重要的是類型安全,三層之間的依賴關係是單向的:Web層依賴Infrastructure層,
項目源碼地址
:https://github.com/zhouda1fu/Ncp.Admin
項目概述
這個項目是一個典型的企業級管理係統,Infrastructure層負責技術實現
,比如獲取部門樹的時候,在技術選型上
,集成測試用了Aspire來自動管理測試環境。而且不手動賦值ID ,而不是直接用long或int
目擊道存網