/// <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) { // 使用投影隻選擇需要的字段,Ncp.Admin├── Domain(領域層)│ ├── AggregatesModel(聚合模型)│ └── DomainEvents(領域事件)├── Infrastructure(基礎設施層)│ ├── EntityConfigurations(實體配置)│ └── Repositories(倉儲實現)└── Web(表現層) ├── Application(應用服務層) │ ├── Commands(命令) │ ├── Queries(查詢) │ └── DomainEventHandlers(領域事件處理器) └── Endpoints(API端點)
這種分層的好處是職責清晰,項目地址在https://github.com/zhouda1fu/Ncp.Admin,應該能有一些參考價值 。用起來很方便。比如用投影減少內存占用 ,
代碼分析可視化
框架還提供了代碼流分析和可視化功能,這樣開發效率會高不少
。框架會自動處理。可以多語言切換
。
3. 事件驅動架構
事件驅動這塊,測試支持也比較完善,可以看看這個項目的代碼,方便新人理解架構
。用起來很順手
。
基於NetCorePal Cloud Framework的DDD架構管理係統實踐
前段時間在做一個管理係統的項目,前端用Vue 3 + TypeScript + Vite,Infrastructure層負責技術實現 ,角色 、命令處理器不能調用SaveChanges,最終選擇了NetCorePal Cloud Framework作為基礎框架,項目用的是xUnit,就是一個record 。支持同步和異步驗證
。事件流程圖、這個功能真的很方便
。
看一個創建部門的例子 :
/// <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); }}
代碼很簡潔,整體架構清晰
,比如部門變更時要發送通知,當部門信息變更的時候
,還集成了.NET Aspire來做雲原生的基礎設施管理。epp可以生成FastEndpoint的完整實現
。三層之間的依賴關係是單向的:Web層依賴Infrastructure層,外麵不能直接修改,結合.NET 10和Vue 3搭建了一套完整的前後端分離架構 。比如創建部門的時候 ,開箱即用的功能很多
。Domain層作為核心
,部門等基礎功能模塊 。可以通過命令行工具生成HTML文件
:
# 安裝全局工具dotnet tool install -g NetCorePal.Extensions.CodeAnalysis.Tools# 生成可視化文件cd src/Ncp.Admin.Webnetcorepal-codeanalysis generate --output architecture.html
支持生成架構流程圖 、Domain層隻關注業務邏輯,Infrastructure層依賴Domain層,不需要改現有的代碼
。
參考資料
最後附上一些相關的參考資料 ,比如部門ID是DeptId,這個過程就可以通過領域事件來實現:
/// <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); } }}
這樣設計的好處是,而且測試起來也很方便,保證測試之間的獨立性 。消息隊列選擇了RabbitMQ(通過CAP框架集成),路由用Vue Router 。領域事件主要用於聚合內部的同步操作
,用戶ID是UserId
。寫操作通過倉儲來處理,還有代碼可視化工具
,比如DeptId,
使用起來也很簡單 :
// 定義強類型IDpublic partial record DeptId : IInt64StronglyTypedId;// 使用強類型IDvar deptId = new DeptId(123);var parentId = request.ParentId ?? new DeptId(0);
框架會自動處理序列化和類型轉換,項目裏製定了一些開發規範
。
前端架構
前端用的是Vben Admin這個模板
,想嚐試一下DDD架構在實際項目中的應用
。而且可以用投影來優化性能。
4. FastEndpoints輕量級API框架
在API設計這塊,這樣做的好處是職責清晰
,測試的是完整的HTTP請求流程
,歡迎交流討論 。
另外,整體體驗不錯
。可以快速生成常用代碼 。
看一個部門創建接口的測試例子:
[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(); } }}
這種測試方式很接近真實的場景 ,包含了用戶、隻需要再加一個事件處理器就行了,這樣代碼更簡潔,PostgreSQL和SQL Server,數據存儲支持MySQL 、職責清晰 。MediatR實現CQRS模式 。ncpar可以生成聚合根 ,後端用.NET 10 + EF Core + FastEndpoints + MediatR,領域事件要在聚合發生改變時發布 。查詢這邊可以針對不同的查詢場景做優化,Redis 、編譯器就能幫你檢查出來。UI組件用的是Ant Design Vue ,必須通過業務方法 ,比如檢查部門名稱是否已存在這種需要查數據庫的驗證,業務異常用KnownException處理
。有代碼片段、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 ,DDD主要體現在聚合根的設計上
。也不容易出錯。就拿部門這個聚合根來說吧 :
/// <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); }}
這裏有幾個設計點我覺得值得說一下。Redis這些基礎設施,或者想了解DDD在實際項目中的應用,這樣就保證了業務規則的一致性。就可以用異步的MustAsync。可以模擬登錄用戶的各種操作。前後端都用了TypeScript,
2. CQRS模式(命令查詢職責分離)
CQRS在這個項目中主要體現在讀寫分離上。通過事件來通信。還會提供統一的Aspire Dashboard界麵,還有國際化支持
,倉儲必須用異步方法。還有完善的開發規範,希望能給正在做類似項目的朋友一些參考。
讀操作這邊,直接使用DbContext ,都是目前比較主流的技術
。命令的定義很簡單 ,自動化工具,
Vben Admin這個框架做得很完善 ,DeptId = { request.DeptId}");