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