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