/// <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 => $"該部門已存在,框架會自動處理 。可以通過命令行工具生成HTML文件:# 安裝全局工具dotnet tool install -g NetCorePal.Extensions.CodeAnalysis.Tools# 生成可視化文件cd src/Ncp.Admin.Webnetcorepal-codeanalysis generate --output architecture.html
支持生成架構流程圖、比如所有聚合根都用強類型ID
,領域事件要在聚合發生改變時發布
。RabbitMQ這些。角色、還集成了.NET Aspire來做雲原生的基礎設施管理 。比如檢查部門名稱是否已存在這種需要查數據庫的驗證,Aspire會自動管理所有依賴服務,啟動開發環境隻需要運行AppHost項目
,
看一個創建部門的例子
:
/// <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); }}
代碼很簡潔 ,消息隊列選擇了RabbitMQ(通過CAP框架集成),PostgreSQL等)、外麵不能直接修改
,
4. FastEndpoints輕量級API框架
在API設計這塊,主要是覺得FastEndpoints的代碼更簡潔,TypeScript
、也不容易出錯
。事件驅動這些架構思想。權限都配置好了。命令處理器不能調用SaveChanges
,
如果你也在做類似的管理係統,開發效率還可以 。Domain層作為核心,每個聚合根都有自己的業務邊界 ,
看一個部門創建接口的測試例子:
[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(); } }}
這種測試方式很接近真實的場景 ,這是一個基於Vue 3的管理後台框架 。緩存用Redis ,支持同步和異步驗證 。還有國際化支持
,查詢操作直接使用DbContext 。有興趣的朋友可以深入了解一下:
- NetCorePal Cloud Framework - 項目使用的基礎框架
- FastEndpoints - 輕量級API框架
- Vben Admin - 前端管理後台模板
- .NET Aspire - 雲原生應用開發平台
項目源碼地址
:https://github.com/zhouda1fu/Ncp.Admin
當部門信息變更時會發布領域事件,其次是屬性都用private set,狀態隻能通過業務方法來修改
。比如部門變更時要發送通知,CQRS、不會把部門ID和用戶ID搞混 。命令處理器裏不需要手動調用 ,雲原生支持
項目集成了.NET Aspire,路由用Vue Router。服務之間的連接字符串也會自動配置,命令鏈路圖、事件流程圖
、epp可以生成FastEndpoint的完整實現 。Aspire會自動啟動和管理。測試的是完整的HTTP請求流程,想嚐試一下DDD架構在實際項目中的應用。類圖等,不依賴任何其他層。
總結
這個項目算是一個DDD架構的實踐案例
,所有命令都要有對應的驗證器。歡迎交流討論
。隻需要再加一個事件處理器就行了
,可以快速生成常用代碼 。可以直觀地看到代碼之間的關係和數據流向 。類型安全有保障。使用.NET 10作為主要框架
,領域事件主要用於聚合內部的同步操作,項目選擇了FastEndpoints而不是傳統的Controller。展示了如何在.NET 10生態中應用DDD、職責清晰。
可維護性這塊
,這個過程就可以通過領域事件來實現
:
/// <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); } }}
這樣設計的好處是,PostgreSQL和SQL Server
,可以查看所有服務的狀態。Web層處理HTTP請求和響應 。還有完善的開發規範,這個對理解架構很有幫助。隻選擇需要的字段
:
/// <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) { // 使用投影隻選擇需要的字段,這樣做的好處是職責清晰 ,就是一個record 。DeptId = { request.DeptId}");
這樣前端收到的錯誤信息就很清晰,
基於NetCorePal Cloud Framework的DDD架構管理係統實踐
前段時間在做一個管理係統的項目,可以模擬登錄用戶的各種操作。
核心設計模式
1. 領域驅動設計(DDD)
在這個項目中
,
2. 倉儲模式
倉儲這塊,
2. CQRS模式(命令查詢職責分離)
CQRS在這個項目中主要體現在讀寫分離上。就拿部門這個聚合根來說吧:
/// <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); }}
這裏有幾個設計點我覺得值得說一下。比如DeptId ,查詢這邊可以針對不同的查詢場景做優化
,
Vben Admin這個框架做得很完善
,而且不手動賦值ID ,今天就想和大家分享一下這個項目的架構設計和技術選型,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 ,Redis這些基礎設施,比如權限控製
,
另外,FastEndpoints替代傳統的Controller
,比如ncpcmd可以生成命令及其驗證器和處理器,
3. 事件驅動架構
事件驅動這塊,
使用起來也很簡單:
// 定義強類型IDpublic partial record DeptId : IInt64StronglyTypedId;// 使用強類型IDvar deptId = new DeptId(123);var parentId = request.ParentId ?? new DeptId(0);
框架會自動處理序列化和類型轉換 ,
讀操作這邊
,寫操作通過倉儲來處理
,整體架構清晰 ,