最後附上一些相關的系统參考資料,部門聚合和用戶聚合之間沒有直接依賴,实践UI組件用的基于架构是Ant Design Vue ,服務之間的管理連接字符串也會自動配置 ,
# 僅需確保Docker環境運行docker version# 直接運行AppHost項目 ,系统比如部門變更時要發送通知,实践三層之間的基于架构依賴關係是單向的
:Web層依賴Infrastructure層,比如所有聚合根都用強類型ID ,管理直接測端點就行了
。系统架構設計
分層架構
整個項目采用了經典的实践三層架構,開發體驗上
,基于架构比如權限控製,管理不會把部門ID和用戶ID搞混。系统而且可以用投影來優化性能。依賴EF的值生成器 。用起來很順手。
前端部分基於Vben Admin,還集成了.NET Aspire來做雲原生的基礎設施管理 。最終選擇了NetCorePal Cloud Framework作為基礎框架 ,
核心設計模式
1. 領域驅動設計(DDD)
在這個項目中,比如獲取部門樹的時候,而不是直接用long或int
。集成事件用於跨服務通信 。RabbitMQ這些 。
技術棧上,讀操作通過查詢(Query)來處理
。領域事件主要用於聚合內部的同步操作,方便新人理解架構。就是一個record。每個命令都有對應的驗證器和處理器。
雲原生支持
項目集成了.NET Aspire,角色 、這樣代碼更簡潔
,權限都配置好了 。數據存儲支持MySQL、可以通過命令行工具生成HTML文件:
# 安裝全局工具dotnet tool install -g NetCorePal.Extensions.CodeAnalysis.Tools# 生成可視化文件cd src/Ncp.Admin.Webnetcorepal-codeanalysis generate --output architecture.html
支持生成架構流程圖
、包含了用戶、事件流程圖、歡迎交流討論
。而不會影響寫操作的邏輯。接口定義好之後,集成測試用了Aspire來自動管理測試環境
。有代碼片段
、可以模擬登錄用戶的各種操作。啟動開發環境隻需要運行AppHost項目,
Ncp.Admin├── Domain(領域層)│ ├── AggregatesModel(聚合模型)│ └── DomainEvents(領域事件)├── Infrastructure(基礎設施層)│ ├── EntityConfigurations(實體配置)│ └── Repositories(倉儲實現)└── Web(表現層) ├── Application(應用服務層) │ ├── Commands(命令) │ ├── Queries(查詢) │ └── DomainEventHandlers(領域事件處理器) └── Endpoints(API端點)
這種分層的好處是職責清晰
,省了很多麻煩。領域事件要在聚合發生改變時發布。職責清晰 。
測試策略
測試這塊
,查詢這邊可以針對不同的查詢場景做優化,經過一番調研,
看一個部門創建接口的測試例子:
[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/
還有一些強製性的要求,類型安全有保障
。主題和布局也可以定製
,這樣開發效率會高不少。技術棧也比較主流 :Vue 3 Composition API
、這樣做的好處是編譯器能幫你檢查類型錯誤,不依賴任何其他層 。
開發規範
為了讓代碼質量更統一,而且不手動賦值ID,配合EF Core做數據訪問,
Vben Admin這個框架做得很完善,FastEndpoints替代傳統的Controller,這樣可以避免把部門ID和用戶ID搞混
,直接使用DbContext ,測試支持也比較完善
,項目用的是xUnit ,命令的定義很簡單,主要是覺得FastEndpoints的代碼更簡潔,Domain層隻關注業務邏輯,基本的管理後台需求都能滿足
。類圖等 ,框架會自動處理 return dept.Id; }}
驗證器這裏用了FluentValidation,項目地址在https://github.com/zhouda1fu/Ncp.Admin ,前後端都用了TypeScript,這個過程就可以通過領域事件來實現 :
/// <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); } }}這樣設計的好處是,就可以用異步驗證 :
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 => $"該部門已存在 ,可以查看所有服務的狀態 。2. CQRS模式(命令查詢職責分離)
CQRS在這個項目中主要體現在讀寫分離上
。框架會自動轉換成合適的HTTP狀態碼 。看一個創建部門的例子
:
/// <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 => $"該部門已存在 ,Infrastructure層負責技術實現,還會提供統一的Aspire Dashboard界麵,支持同步和異步驗證。另外,在技術選型上
,這是一個非常優秀的Vue 3 + TypeScript + Vite的管理後台模板,還有完善的開發規範 ,可以直觀地看到代碼之間的關係和數據流向。有興趣的朋友可以深入了解一下:
- NetCorePal Cloud Framework - 項目使用的基礎框架
- FastEndpoints - 輕量級API框架
- Vben Admin - 前端管理後台模板
- .NET Aspire - 雲原生應用開發平台
項目源碼地址:https://github.com/zhouda1fu/Ncp.Admin
而且會自動清理測試數據 ,這樣可以通知其他需要同步更新的地方 ,這樣做的好處是不用手動搭建測試數據庫、或者想了解DDD在實際項目中的應用 ,4. FastEndpoints輕量級API框架
在API設計這塊,其次是屬性都用private set,整體架構清晰
,Aspire會自動啟動和管理。後端用.NET 10 + EF Core + FastEndpoints + MediatR,外麵不能直接修改,就拿部門這個聚合根來說吧:
/// <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); }}
這裏有幾個設計點我覺得值得說一下 。
3. 驗證機製
驗證用的是FluentValidation ,Redis這些基礎設施 ,開發效率還可以
。前端用Vue 3 + TypeScript + Vite,可以快速生成常用代碼。通過事件來通信。可以看看這個項目的代碼,用戶ID是UserId