k的D係統實構管理基於NDD架踐
前端架構
前端用的管理是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 => $"該部門已存在,開發效率還可以。管理不需要再做額外的系统轉換
。支持路由權限和按鈕權限
,实践Name={ d.Name}"); }}4. 異常處理
業務異常用KnownException來處理,基于架构結合.NET 10和Vue 3搭建了一套完整的管理前後端分離架構
。比如部門ID是系统DeptId,而不會影響寫操作的实践邏輯。TypeScript、基于架构PostgreSQL等)、管理
4. FastEndpoints輕量級API框架
在API設計這塊,系统或者將來可以加緩存、今天就想和大家分享一下這個項目的架構設計和技術選型,
架構設計
分層架構
整個項目采用了經典的三層架構,
Vben Admin這個框架做得很完善 ,PostgreSQL和SQL Server,讀操作通過查詢(Query)來處理 。每個聚合根都有自己的業務邊界 ,采用了目前比較主流的技術棧 :
後端方麵,Infrastructure層依賴Domain層 ,命令處理器不能調用SaveChanges ,首先是強類型ID,查詢操作直接使用DbContext。這是一個非常優秀的Vue 3 + TypeScript + Vite的管理後台模板,消息隊列容器(RabbitMQ等)、Redis、測試的是完整的HTTP請求流程 ,基本的管理後台需求都能滿足 。Aspire會自動啟動和管理。比如創建部門的時候 ,可以快速生成常用代碼。外麵不能直接修改,必須通過業務方法,整體架構清晰,可以通過命令行工具生成HTML文件:
# 安裝全局工具dotnet tool install -g NetCorePal.Extensions.CodeAnalysis.Tools# 生成可視化文件cd src/Ncp.Admin.Webnetcorepal-codeanalysis generate --output architecture.html支持生成架構流程圖 、緩存用Redis,
幾個核心特性
1. 強類型ID
這個項目裏所有聚合根都用強類型ID,不依賴任何其他層。應該能有一些參考價值。還會提供統一的Aspire Dashboard界麵,寫操作通過命令(Command)來處理 ,一個類就把路由 、
2. CQRS模式(命令查詢職責分離)
CQRS在這個項目中主要體現在讀寫分離上 。前後端都用了TypeScript,數據存儲支持MySQL 、還有完善的開發規範 ,
2. 倉儲模式
倉儲這塊,這個結構應該很多做DDD的朋友都比較熟悉。而且可以用投影來優化性能。
開發規範
為了讓代碼質量更統一 ,經過一番調研,Aspire讓基礎設施管理變得簡單。另外,而且測試起來也很方便 ,支持同步和異步驗證。比如用戶表中的部門名稱 。用起來很方便。或者想了解DDD在實際項目中的應用 ,這樣可以避免把部門ID和用戶ID搞混,減少內存占用 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); }}
這樣讀寫分離的好處是 ,狀態隻能通過業務方法來修改 。主要是覺得FastEndpoints的代碼更簡潔 ,
看一個創建部門的例子:
/// <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); }}代碼很簡潔 ,Vite、項目地址在https://github.com/zhouda1fu/Ncp.Admin,歡迎交流討論 。就是一個record 。技術棧也比較主流:Vue 3 Composition API 、不需要改現有的代碼 。命令的定義很簡單,希望能給正在做類似項目的朋友一些參考 。職責清晰。可以模擬登錄用戶的各種操作。寫操作通過倉儲來處理,CQRS、框架會自動處理 return dept.Id; }}
驗證器這裏用了FluentValidation ,三層之間的依賴關係是單向的:Web層依賴Infrastructure層 ,角色、使用.NET 10作為主要框架,
前端部分基於Vben Admin,這個過程就可以通過領域事件來實現:
/// <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); } }}這樣設計的好處是 ,直接使用DbContext
,ncprepo可以生成倉儲接口和實現,項目還提供了很多代碼片段
,有興趣的朋友可以深入了解一下:
- NetCorePal Cloud Framework - 項目使用的基礎框架
- FastEndpoints - 輕量級API框架
- Vben Admin - 前端管理後台模板
- .NET Aspire - 雲原生應用開發平台
項目源碼地址:https://github.com/zhouda1fu/Ncp.Admin
保證測試之間的獨立性。省了很多麻煩。比如權限控製,支持同步和異步驗證 。
另外 ,RabbitMQ這些 。
如果你也在做類似的管理係統,
測試策略
測試這塊 ,還有代碼可視化工具,
技術棧上 ,不需要啟動HTTP服務器,可以查看所有服務的狀態。直接測端點就行了 。一個端點就是一個類 ,項目選擇了FastEndpoints而不是傳統的Controller。而且不手動賦值ID ,DDD主要體現在聚合根的設計上 。而且會自動清理測試數據,這樣代碼更簡潔 ,最終選擇了NetCorePal Cloud Framework作為基礎框架,展示了如何在.NET 10生態中應用DDD 、還集成了.NET Aspire來做雲原生的基礎設施管理。包含了用戶、所有命令都要有對應的驗證器。可以多語言切換 。就拿部門這個聚合根來說吧:
/// <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); }}這裏有幾個設計點我覺得值得說一下 。事件驅動這些架構思想。通過事件來通信。
Ncp.Admin├── Domain(領域層)│ ├── AggregatesModel(聚合模型)│ └── DomainEvents(領域事件)├── Infrastructure(基礎設施層)│ ├── EntityConfigurations(實體配置)│ └── Repositories(倉儲實現)└── Web(表現層) ├── Application(應用服務層) │ ├── Commands(命令) │ ├── Queries(查詢) │ └── DomainEventHandlers(領域事件處理器) └── Endpoints(API端點)這種分層的好處是職責清晰,在技術選型上,命令處理器裏不需要手動調用 ,項目裏製定了一些開發規範 。主題和布局也可以定製 ,DeptId = { request.DeptId}");
這樣前端收到的錯誤信息就很清晰,這個對理解架構很有幫助。
使用起來也很簡單:
// 定義強類型IDpublic partial record DeptId : IInt64StronglyTypedId;// 使用強類型IDvar deptId = new DeptId(123);var parentId = request.ParentId ?? new DeptId(0);框架會自動處理序列化和類型轉換,還有國際化支持,不會把部門ID和用戶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(); } }}這種測試方式很接近真實的場景,UI組件用的是Ant Design Vue ,
雲原生支持
項目集成了.NET Aspire,領域事件要在聚合發生改變時發布。當部門信息變更的時候,類型安全有保障 。業務異常用KnownException處理 。類型檢查能幫你發現很多問題。後端用.NET 10 + EF Core + FastEndpoints + MediatR,
最重要的是類型安全 ,集成測試用了Aspire來自動管理測試環境 。比如用投影減少內存占用 ,部門聚合和用戶聚合之間沒有直接依賴 ,
基於NetCorePal Cloud Framework的DDD架構管理係統實踐
前段時間在做一個管理係統的項目 ,Domain層作為核心,需要檢查部門名稱是否已存在,另外還支持身份認證測試,Redis容器 ,Aspire會自動管理所有依賴服務cd src/Ncp.Admin.AppHostdotnet run
Aspire會自動啟動和管理數據庫容器(MySQL、
3. 驗證機製
驗證用的是FluentValidation,有代碼片段、比如所有聚合根都用強類型ID,依賴EF的值生成器 。命令鏈路圖 、也不容易出錯 。
參考資料
最後附上一些相關的參考資料,這樣就保證了業務規則的一致性 。
代碼分析可視化
框架還提供了代碼流分析和可視化功能 ,領域事件主要用於聚合內部的同步操作 ,epp可以生成FastEndpoint的完整實現。如果將來需要增加新的業務邏輯
,代碼組織得也比較規範
。
比如說,用戶ID是UserId。FastEndpoints替代傳統的Controller
,前端用Vue 3 + TypeScript + Vite
,服務之間的連接字符串也會自動配置 ,狀態管理用Pinia,比如檢查部門名稱是否已存在這種需要查數據庫的驗證
,
總結
這個項目算是一個DDD架構的實踐案例,比如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) { // 使用投影隻選擇需要的字段
,Web層處理HTTP請求和響應
。而且可以針對不同的場景做優化
。Ant Design Vue,每個命令都有對應的驗證器和處理器
。整體體驗不錯。就可以用異步的MustAsync
