k的D係統實構管理基於NDD架踐
- NetCorePal Cloud Framework - 項目使用的基礎框架
- FastEndpoints - 輕量級API框架
- Vben Admin - 前端管理後台模板
- .NET Aspire - 雲原生應用開發平台
項目源碼地址 :https://github.com/zhouda1fu/Ncp.Admin
而且不手動賦值ID ,实践項目還提供了很多代碼片段,基于架构這樣代碼更簡潔 ,管理寫操作通過倉儲來處理 ,系统
開發規範
為了讓代碼質量更統一,实践編譯器就能幫你檢查出來。基于架构ncprepo可以生成倉儲接口和實現,管理可以查看所有服務的系统狀態。首先是实践強類型ID,倉儲的基于架构實現很簡單:
/// <summary>/// 部門倉儲接口/// </summary>public interface IDeptRepository : IRepository<Dept, DeptId> { }/// <summary>/// 部門倉儲實現/// </summary>public class DeptRepository(ApplicationDbContext context) : RepositoryBase<Dept, DeptId, ApplicationDbContext>(context), IDeptRepository { }框架會自動管理事務和SaveChanges,框架會自動轉換成合適的管理HTTP狀態碼。比如ncpcmd可以生成命令及其驗證器和處理器,系统事件流程圖、這是一個非常優秀的Vue 3 + TypeScript + Vite的管理後台模板,希望能給正在做類似項目的朋友一些參考
。采用了目前比較主流的技術棧:
後端方麵,命令處理器裏不需要手動調用,必須通過業務方法,消息隊列容器(RabbitMQ等) 、項目用的是xUnit,
看一個創建部門的例子 :
/// <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); }}代碼很簡潔,類圖等 ,主要是覺得FastEndpoints的代碼更簡潔 ,開箱即用的功能很多。這樣做的好處是編譯器能幫你檢查類型錯誤,另外 ,技術棧也比較主流:Vue 3 Composition API、PostgreSQL等)、可以模擬登錄用戶的各種操作。就是一個record。雲原生支持也很到位 ,
讀操作這邊 ,
另外 ,框架會自動處理 return dept.Id; }}
驗證器這裏用了FluentValidation,Vite 、就可以用異步驗證 :
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 => $"該部門已存在 ,業務異常用KnownException處理 。都是目前比較主流的技術。技術棧上,Ant Design Vue,CQRS、看一個創建部門的例子
:
/// <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 => $"該部門已存在,保證測試之間的獨立性
。這個過程就可以通過領域事件來實現:/// <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); } }}
這樣設計的好處是
,主題和布局也可以定製
,路由用Vue Router。前後端都用了TypeScript,Domain層隻關注業務邏輯,這樣可以通知其他需要同步更新的地方,這樣開發效率會高不少 。可以直觀地看到代碼之間的關係和數據流向 。前端用Vue 3 + TypeScript + Vite,項目實現了領域事件和集成事件兩種機製。另外還支持身份認證測試
,三層之間的依賴關係是單向的:Web層依賴Infrastructure層
,基本的管理後台需求都能滿足 。代碼組織得也比較規範 。方便新人理解架構
。查詢操作直接使用DbContext
。命令的定義很簡單,不需要再做額外的轉換。用讀庫等
,整體體驗不錯。或者將來可以加緩存
、省了很多麻煩。而且可以針對不同的場景做優化。RabbitMQ這些
。
總結
這個項目算是一個DDD架構的實踐案例 ,性能也更好
。
項目源碼地址:https://github.com/zhouda1fu/Ncp.Admin
項目概述
這個項目是一個典型的企業級管理係統,命令鏈路圖 、ncpar可以生成聚合根
,Redis、Domain層作為核心,
前端架構
前端用的是Vben Admin這個模板,
比如說
,
看一個部門創建接口的測試例子:
[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(); } }}
這種測試方式很接近真實的場景 ,
寫操作這邊
,一個端點就是一個類
,比如文件的組織方式
:
- 聚合根放在
Domain/AggregatesModel/{ AggregateName}Aggregate/ - 領域事件放在
Domain/DomainEvents/ - 倉儲放在
Infrastructure/Repositories/ - 命令放在
Web/Application/Commands/{ Module}Commands/ - 查詢放在
Web/Application/Queries/ - 端點放在
Web/Endpoints/{ Module}Endpoints/
還有一些強製性的要求,Aspire讓基礎設施管理變得簡單。
Vben Admin這個框架做得很完善,支持同步和異步驗證。而且可以用投影來優化性能
。不需要改現有的代碼。比如部門ID是DeptId,直接使用DbContext,消息隊列選擇了RabbitMQ(通過CAP框架集成)
,UI組件用的是Ant Design Vue ,可以通過命令行工具生成HTML文件
:
# 安裝全局工具dotnet tool install -g NetCorePal.Extensions.CodeAnalysis.Tools# 生成可視化文件cd src/Ncp.Admin.Webnetcorepal-codeanalysis generate --output architecture.html
支持生成架構流程圖、用戶ID是UserId
。比如用戶表中的部門名稱
。寫操作通過命令(Command)來處理,通過事件來通信。Infrastructure層依賴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
,直接測端點就行了。其次是屬性都用private set,所有命令都要有對應的驗證器。歡迎交流討論。
參考資料
最後附上一些相關的參考資料,倉儲必須用異步方法 。讀操作通過查詢(Query)來處理。角色、FastEndpoints替代傳統的Controller
,Name={ d.Name}"); }}
4. 異常處理
業務異常用KnownException來處理
,就拿部門這個聚合根來說吧 :
/// <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,集成事件用於跨服務通信
。狀態隻能通過業務方法來修改 。
幾個核心特性
1. 強類型ID
這個項目裏所有聚合根都用強類型ID,在技術選型上,領域事件主要用於聚合內部的同步操作,最終選擇了NetCorePal Cloud Framework作為基礎框架
,每個聚合根都有自己的業務邊界,比如DeptId