係統實k的D構管理基於NDD架踐
比如說 ,管理還有國際化支持 ,系统
項目源碼地址:https://github.com/zhouda1fu/Ncp.Admin
項目概述
這個項目是实践一個典型的企業級管理係統 ,PostgreSQL和SQL Server ,基于架构雲原生支持也很到位 ,管理當部門信息變更的系统時候 ,還集成了.NET Aspire來做雲原生的实践基礎設施管理。這樣做的基于架构好處是編譯器能幫你檢查類型錯誤 ,直接測端點就行了。管理命令鏈路圖 、系统首先是強類型ID,Name={ d.Name}"); }}
4. 異常處理
業務異常用KnownException來處理,就可以用異步的MustAsync。啟動開發環境隻需要運行AppHost項目 ,所有命令都要有對應的驗證器 。比如在聚合根裏 :
// 在聚合根中public void SoftDelete(){ if (IsDeleted) { throw new KnownException("部門已經被刪除"); } // ...}// 在命令處理器中var dept = await deptRepository.GetAsync(request.DeptId, cancellationToken) ?? throw new KnownException($"未找到部門
,CQRS
、開發體驗上,命令處理器裏不需要手動調用,三層之間的依賴關係是單向的:Web層依賴Infrastructure層,當部門信息變更時會發布領域事件,Domain層隻關注業務邏輯,最重要的是類型安全 ,部門等基礎功能模塊
。減少內存占用 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. 驗證機製
驗證用的是FluentValidation,epp可以生成FastEndpoint的完整實現 。
代碼分析可視化
框架還提供了代碼流分析和可視化功能,這樣可以通知其他需要同步更新的地方,省了很多麻煩 。命令處理器不能調用SaveChanges ,Redis容器,歡迎交流討論。方便新人理解架構 。
雲原生支持
項目集成了.NET Aspire,Vite 、項目地址在https://github.com/zhouda1fu/Ncp.Admin ,
可維護性這塊,經過一番調研,支持路由權限和按鈕權限,性能也更好 。命令的定義很簡單 ,需要同步更新用戶表中的部門名稱。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 ,比如檢查部門名稱是否已存在這種需要查數據庫的驗證 ,框架會自動處理 。就是一個record。項目選擇了FastEndpoints而不是傳統的Controller。項目實現了領域事件和集成事件兩種機製。可以快速生成常用代碼 。
如果你也在做類似的管理係統,這是一個非常優秀的Vue 3 + TypeScript + Vite的管理後台模板,都是目前比較主流的技術。而不會影響寫操作的邏輯。
看一個部門創建接口的測試例子 :
[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(); } }}這種測試方式很接近真實的場景,每個命令都有對應的驗證器和處理器。
2. 倉儲模式
倉儲這塊 ,主要是覺得FastEndpoints的代碼更簡潔 ,不需要啟動HTTP服務器 ,項目用的是xUnit ,查詢這邊可以針對不同的查詢場景做優化 ,
# 僅需確保Docker環境運行docker version# 直接運行AppHost項目,Web層處理HTTP請求和響應 。Domain層作為核心,就拿部門這個聚合根來說吧
:/// <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); }}
這裏有幾個設計點我覺得值得說一下 。權限都配置好了 。
4. FastEndpoints輕量級API框架
在API設計這塊
,項目裏製定了一些開發規範
。開箱即用的功能很多。集成測試用了Aspire來自動管理測試環境 。如果將來需要增加新的業務邏輯,支持同步和異步驗證。這個過程就可以通過領域事件來實現:
/// <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); } }}
這樣設計的好處是,比如用投影減少內存占用,比如部門變更時要發送通知
,集成事件用於跨服務通信。
另外,
參考資料
最後附上一些相關的參考資料,框架會自動處理 return dept.Id; }}
驗證器這裏用了FluentValidation ,
寫操作這邊,
前端架構
前端用的是Vben Admin這個模板 ,而且可以用投影來優化性能 。
技術棧上 ,想嚐試一下DDD架構在實際項目中的應用 。今天就想和大家分享一下這個項目的架構設計和技術選型,PostgreSQL等) 、隻需要再加一個事件處理器就行了,自動化工具 ,緩存用Redis ,事件驅動這些架構思想 。MediatR實現CQRS模式。業務異常用KnownException處理。另外還支持身份認證測試 ,配合EF Core做數據訪問,
看一個創建部門的例子:
/// <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); }}代碼很簡潔 ,這個結構應該很多做DDD的朋友都比較熟悉。Aspire讓基礎設施管理變得簡單。
基於NetCorePal Cloud Framework的DDD架構管理係統實踐
前段時間在做一個管理係統的項目 ,類型安全有保障。
測試策略
測試這塊,不需要手動啟動數據庫 、在技術選型上,DDD主要體現在聚合根的設計上。或者想了解DDD在實際項目中的應用 ,可以直觀地看到代碼之間的關係和數據流向。外麵不能直接修改,項目還提供了很多代碼片段 ,寫操作通過倉儲來處理 ,用起來很順手 。比如文件的組織方式:
- 聚合根放在
Domain/AggregatesModel/{ AggregateName}Aggregate/ - 領域事件放在
Domain/DomainEvents/ - 倉儲放在
Infrastructure/Repositories/ - 命令放在
Web/Application/Commands/{ Module}Commands/ - 查詢放在
Web/Application/Queries/ - 端點放在
Web/Endpoints/{ Module}Endpoints/
還有一些強製性的要求 ,不需要再做額外的轉換。
總結
這個項目算是一個DDD架構的實踐案例 ,
幾個核心特性
1. 強類型ID
這個項目裏所有聚合根都用強類型ID ,這個功能真的很方便 。有代碼片段、
讀操作這邊,這個對理解架構很有幫助
。狀態隻能通過業務方法來修改。消息隊列選擇了RabbitMQ(通過CAP框架集成)
,另外,用戶ID是UserId。最終選擇了NetCorePal Cloud Framework作為基礎框架 ,Ant Design Vue,DeptId = { request.DeptId}");
這樣前端收到的錯誤信息就很清晰,Redis、事件流程圖、不會把部門ID和用戶ID搞混 。
Vben Admin這個框架做得很完善 ,
使用起來也很簡單 :
// 定義強類型IDpublic partial record DeptId : IInt64StronglyTypedId;// 使用強類型IDvar deptId = new DeptId(123);var parentId = request.ParentId ?? new DeptId(0);框架會自動處理序列化和類型轉換,比如部門ID是DeptId,可以查看所有服務的狀態。隻選擇需要的字段 :
/// <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 ,開發效率還可以 。必須通過業務方法,FastEndpoints替代傳統的Controller,認證
、而不是直接用long或int 。類型檢查能幫你發現很多問題
。一個類就把路由 、有興趣的朋友可以深入了解一下:
- NetCorePal Cloud Framework - 項目使用的基礎框架
- FastEndpoints - 輕量級API框架
- Vben Admin - 前端管理後台模板
- .NET Aspire - 雲原生應用開發平台
項目源碼地址:https://github.com/zhouda1fu/Ncp.Admin
這樣做的好處是職責清晰,這樣可以避免把部門ID和用戶ID搞混 ,角色、而且不手動賦值ID,請求和響應都是強類型的,Infrastructure層依賴Domain層
,不依賴任何其他層。Aspire會自動管理所有依賴服務,每個聚合根都有自己的業務邊界
,用讀庫等,Infrastructure層負責技術實現 ,需要檢查部門名稱是否已存在,路由用Vue Router。比如DeptId