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