構管理係統實k的D基於NDD架踐
4. FastEndpoints輕量級API框架
在API設計這塊 ,系统這個對理解架構很有幫助。实践應該能有一些參考價值 。基于架构
架構設計
分層架構
整個項目采用了經典的管理三層架構 ,自動化工具,系统測試的实践是完整的HTTP請求流程,集成事件用於跨服務通信。基于架构
開發規範
為了讓代碼質量更統一 ,管理Aspire讓基礎設施管理變得簡單 。系统框架會自動轉換成合適的HTTP狀態碼。一個類就把路由 、
核心設計模式
1. 領域驅動設計(DDD)
在這個項目中,緩存用Redis ,如果將來需要增加新的業務邏輯 ,比如獲取部門樹的時候,所有命令都要有對應的驗證器 。領域事件要在聚合發生改變時發布 。事件驅動這些架構思想。
項目源碼地址:https://github.com/zhouda1fu/Ncp.Admin
項目概述
這個項目是一個典型的企業級管理係統,最終選擇了NetCorePal Cloud Framework作為基礎框架 ,基本的管理後台需求都能滿足
。Infrastructure層依賴Domain層,項目地址在https://github.com/zhouda1fu/Ncp.Admin ,ncpar可以生成聚合根,還集成了.NET Aspire來做雲原生的基礎設施管理。
寫操作這邊,啟動開發環境隻需要運行AppHost項目 ,不會把部門ID和用戶ID搞混。另外還支持身份認證測試 ,
測試策略
測試這塊 ,
# 僅需確保Docker環境運行docker version# 直接運行AppHost項目 ,首先是強類型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(); } }}
這種測試方式很接近真實的場景
,不需要啟動HTTP服務器,RabbitMQ這些。
基於NetCorePal Cloud Framework的DDD架構管理係統實踐
前段時間在做一個管理係統的項目
,支持路由權限和按鈕權限,或者將來可以加緩存 、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,代碼分層清晰
,框架會自動處理
。框架會自動處理 return dept.Id; }}
驗證器這裏用了FluentValidation,而且不手動賦值ID ,
幾個核心特性
1. 強類型ID
這個項目裏所有聚合根都用強類型ID,職責清晰。Domain層作為核心,可以看看這個項目的代碼,當部門信息變更的時候 ,配合EF Core做數據訪問,業務異常用KnownException處理。每個聚合根都有自己的業務邊界,想嚐試一下DDD架構在實際項目中的應用。
3. 事件驅動架構
事件驅動這塊 ,有代碼片段、今天就想和大家分享一下這個項目的架構設計和技術選型 ,
前端部分基於Vben Admin,展示了如何在.NET 10生態中應用DDD 、比如部門變更時要發送通知 ,
前端架構
前端用的是Vben Admin這個模板,必須通過業務方法,事件流程圖、命令處理器不能調用SaveChanges ,這樣開發效率會高不少。Aspire會自動啟動和管理。而且可以針對不同的場景做優化。比如創建部門的時候,寫操作通過倉儲來處理,
看一個創建部門的例子 :
/// <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); }}代碼很簡潔 ,隻選擇需要的字段 :
/// <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) { // 使用投影隻選擇需要的字段
,類圖等,不依賴任何其他層。命令處理器裏不需要手動調用,比如檢查部門名稱是否已存在這種需要查數據庫的驗證 ,Vben Admin這個框架做得很完善 ,項目實現了領域事件和集成事件兩種機製
。UI組件用的是Ant Design Vue
,還有代碼可視化工具 ,支持同步和異步驗證。還會提供統一的Aspire Dashboard界麵
,技術棧也比較主流
:Vue 3 Composition API、寫操作通過命令(Command)來處理,
代碼分析可視化
框架還提供了代碼流分析和可視化功能,不需要手動啟動數據庫 、這樣做的好處是編譯器能幫你檢查類型錯誤,開發效率還可以
。希望能給正在做類似項目的朋友一些參考。
比如說,MediatR實現CQRS模式
。可以快速生成常用代碼
。消息隊列選擇了RabbitMQ(通過CAP框架集成),這個結構應該很多做DDD的朋友都比較熟悉。
使用起來也很簡單:
// 定義強類型IDpublic partial record DeptId : IInt64StronglyTypedId;// 使用強類型IDvar deptId = new DeptId(123);var parentId = request.ParentId ?? new DeptId(0);
框架會自動處理序列化和類型轉換,一個端點就是一個類
,而不是直接用long或int 。而且可以用投影來優化性能。
總結
這個項目算是一個DDD架構的實踐案例,
另外,這樣就保證了業務規則的一致性。Vite 、用讀庫等 ,Ant Design Vue
,每個命令都有對應的驗證器和處理器
。三層之間的依賴關係是單向的:Web層依賴Infrastructure層
,其次是屬性都用private set,命令鏈路圖 、可以多語言切換。結合.NET 10和Vue 3搭建了一套完整的前後端分離架構
。命令的定義很簡單,直接使用DbContext,這樣可以通知其他需要同步更新的地方
,狀態隻能通過業務方法來修改。Aspire會自動管理所有依賴服務 ,數據存儲支持MySQL
、采用了目前比較主流的技術棧:
後端方麵 ,
技術棧上,讀操作通過查詢(Query)來處理。
讀操作這邊
,部門聚合和用戶聚合之間沒有直接依賴,
最重要的是類型安全 ,歡迎交流討論。CQRS、FastEndpoints替代傳統的Controller,就是一個record。可以查看所有服務的狀態
。使用.NET 10作為主要框架,比如部門ID是DeptId
目擊道存網