/// <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); }}這裏有幾個設計點我覺得值得說一下 。有興趣的管理朋友可以深入了解一下 :
- NetCorePal Cloud Framework - 項目使用的基礎框架
- FastEndpoints - 輕量級API框架
- Vben Admin - 前端管理後台模板
- .NET Aspire - 雲原生應用開發平台
項目源碼地址:https://github.com/zhouda1fu/Ncp.Admin
最重要的系统是類型安全,
4. FastEndpoints輕量級API框架
在API設計這塊 ,实践所有命令都要有對應的基于架构驗證器。用起來很順手。管理就可以用異步的系统MustAsync。就是实践一個record。希望能給正在做類似項目的基于架构朋友一些參考。比如所有聚合根都用強類型ID,管理外麵不能直接修改
,系统可以看看這個項目的实践代碼
,
架構設計
分層架構
整個項目采用了經典的基于架构三層架構 ,項目選擇了FastEndpoints而不是管理傳統的Controller 。另外 ,系统就可以用異步驗證 :
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 => $"該部門已存在,Infrastructure層負責技術實現
,比如在聚合根裏:// 在聚合根中public void SoftDelete(){ if (IsDeleted) { throw new KnownException("部門已經被刪除"); } // ...}// 在命令處理器中var dept = await deptRepository.GetAsync(request.DeptId, cancellationToken) ?? throw new KnownException($"未找到部門,經過一番調研,需要檢查部門名稱是否已存在,這樣做的好處是編譯器能幫你檢查類型錯誤,Web層處理HTTP請求和響應。不需要再做額外的轉換。MediatR實現CQRS模式
。測試的是完整的HTTP請求流程,epp可以生成FastEndpoint的完整實現。首先是強類型ID,開箱即用的功能很多
。緩存用Redis ,讀操作這邊
,ncprepo可以生成倉儲接口和實現 ,
看一個部門創建接口的測試例子
:
[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(); } }}
這種測試方式很接近真實的場景 ,可以快速生成常用代碼。集成測試用了Aspire來自動管理測試環境 。使用.NET 10作為主要框架,DDD主要體現在聚合根的設計上 。
看一個創建部門的例子
:
/// <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); }}
代碼很簡潔,支持同步和異步驗證。框架會自動轉換成合適的HTTP狀態碼。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,而且測試起來也很方便,PostgreSQL等) 、一個類就把路由
、比如權限控製,前端用Vue 3 + TypeScript + Vite,認證、整體體驗不錯。命令處理器裏不需要手動調用 ,比如文件的組織方式:
- 聚合根放在
Domain/AggregatesModel/{ AggregateName}Aggregate/ - 領域事件放在
Domain/DomainEvents/ - 倉儲放在
Infrastructure/Repositories/ - 命令放在
Web/Application/Commands/{ Module}Commands/ - 查詢放在
Web/Application/Queries/ - 端點放在
Web/Endpoints/{ Module}Endpoints/
還有一些強製性的要求,
測試策略
測試這塊
,
開發規範
為了讓代碼質量更統一
,代碼分層清晰,而且不手動賦值ID,這個過程就可以通過領域事件來實現 :
/// <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); } }}
這樣設計的好處是
,可以查看所有服務的狀態。TypeScript、支持路由權限和按鈕權限 ,項目實現了領域事件和集成事件兩種機製。用讀庫等,技術棧也比較主流
:Vue 3 Composition API、包含了用戶、代碼組織得也比較規範 。整體架構清晰,
代碼分析可視化
框架還提供了代碼流分析和可視化功能,隻選擇需要的字段:
/// <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) { // 使用投影隻選擇需要的字段,狀態隻能通過業務方法來修改 。直接使用DbContext,Aspire會自動管理所有依賴服務cd src/Ncp.Admin.AppHostdotnet run
Aspire會自動啟動和管理數據庫容器(MySQL、需要同步更新用戶表中的部門名稱。
# 僅需確保Docker環境運行docker version# 直接運行AppHost項目
,Redis容器,DeptId = { request.DeptId}");
這樣前端收到的錯誤信息就很清晰
,事件驅動這些架構思想 。在技術選型上,比如部門變更時要發送通知 ,
3. 事件驅動架構
事件驅動這塊
,另外還支持身份認證測試
,查詢這邊可以針對不同的查詢場景做優化,Infrastructure層依賴Domain層,FastEndpoints替代傳統的Controller,編譯器就能幫你檢查出來
。Aspire會自動管理所有依賴服務
,省了很多麻煩。Redis、可以直觀地看到代碼之間的關係和數據流向。保證測試之間的獨立性。每個聚合根都有自己的業務邊界,角色、Vite 、通過事件來通信
。配合EF Core做數據訪問,寫操作通過命令(Command)來處理,用起來很方便。應該能有一些參考價值 。當部門信息變更時會發布領域事件,最終選擇了NetCorePal Cloud Framework作為基礎框架,請求和響應都是強類型的,
Vben Admin這個框架做得很完善 ,用戶ID是UserId