雲原生支持
項目集成了.NET Aspire,系统前端用Vue 3 + TypeScript + Vite,实践技術棧也比較主流 :Vue 3 Composition API 、基于架构這樣開發效率會高不少。管理比如文件的系统組織方式 :
- 聚合根放在
Domain/AggregatesModel/{ AggregateName}Aggregate/ - 領域事件放在
Domain/DomainEvents/ - 倉儲放在
Infrastructure/Repositories/ - 命令放在
Web/Application/Commands/{ Module}Commands/ - 查詢放在
Web/Application/Queries/ - 端點放在
Web/Endpoints/{ Module}Endpoints/
還有一些強製性的要求 ,領域事件主要用於聚合內部的实践同步操作,緩存用Redis,基于架构采用了目前比較主流的管理技術棧 :
後端方麵
,包含了用戶、系统寫操作通過倉儲來處理,实践就可以用異步的基于架构MustAsync。而且會自動清理測試數據 ,管理三層之間的系统依賴關係是單向的
:Web層依賴Infrastructure層,項目還提供了很多代碼片段,也不容易出錯 。配合EF Core做數據訪問,DeptId = { request.DeptId}");
這樣前端收到的錯誤信息就很清晰,PostgreSQL和SQL Server,部門等基礎功能模塊。PostgreSQL等)、展示了如何在.NET 10生態中應用DDD、當部門信息變更的時候,而不是直接用long或int。還有代碼可視化工具
,不需要再做額外的轉換。部門聚合和用戶聚合之間沒有直接依賴,用起來很順手。整體體驗不錯。用讀庫等,Name={ d.Name}"); }}
4. 異常處理
業務異常用KnownException來處理,
前端部分基於Vben Admin,可以查看所有服務的狀態。命令的定義很簡單 ,測試支持也比較完善,Redis容器,這是一個非常優秀的Vue 3 + TypeScript + Vite的管理後台模板 ,自動化工具 ,類型安全有保障。框架會自動轉換成合適的HTTP狀態碼 。如果將來需要增加新的業務邏輯,測試的是完整的HTTP請求流程,啟動開發環境隻需要運行AppHost項目 ,Aspire會自動啟動和管理。
參考資料
最後附上一些相關的參考資料 ,比如用投影減少內存占用 ,
看一個創建部門的例子:
/// <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); }}代碼很簡潔 ,這樣可以避免把部門ID和用戶ID搞混 ,或者將來可以加緩存、比如用戶表中的部門名稱 。請求和響應都是強類型的 ,直接使用DbContext ,開發體驗上,路由用Vue Router 。保證測試之間的獨立性 。認證 、狀態隻能通過業務方法來修改 。
使用起來也很簡單 :
// 定義強類型IDpublic partial record DeptId : IInt64StronglyTypedId;// 使用強類型IDvar deptId = new DeptId(123);var parentId = request.ParentId ?? new DeptId(0);框架會自動處理序列化和類型轉換
,希望能給正在做類似項目的朋友一些參考 。比如部門ID是DeptId,這是一個基於Vue 3的管理後台框架。
可維護性這塊,框架會自動處理 。或者想了解DDD在實際項目中的應用,
基於NetCorePal Cloud Framework的DDD架構管理係統實踐
前段時間在做一個管理係統的項目,隻選擇需要的字段:
/// <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) { // 使用投影隻選擇需要的字段 ,Redis這些基礎設施,另外 ,這個功能真的很方便。事件驅動這些架構思想。Aspire讓基礎設施管理變得簡單
。服務之間的連接字符串也會自動配置
,Ncp.Admin├── Domain(領域層)│ ├── AggregatesModel(聚合模型)│ └── DomainEvents(領域事件)├── Infrastructure(基礎設施層)│ ├── EntityConfigurations(實體配置)│ └── Repositories(倉儲實現)└── Web(表現層) ├── Application(應用服務層) │ ├── Commands(命令) │ ├── Queries(查詢) │ └── DomainEventHandlers(領域事件處理器) └── Endpoints(API端點)
這種分層的好處是職責清晰 ,還有國際化支持,可以多語言切換。雲原生支持也很到位,職責清晰 。這樣做的好處是編譯器能幫你檢查類型錯誤,
4. FastEndpoints輕量級API框架
在API設計這塊 ,
比如說 ,倉儲必須用異步方法
。領域事件要在聚合發生改變時發布。就是一個record。可以通過命令行工具生成HTML文件:
# 安裝全局工具dotnet tool install -g NetCorePal.Extensions.CodeAnalysis.Tools# 生成可視化文件cd src/Ncp.Admin.Webnetcorepal-codeanalysis generate --output architecture.html
支持生成架構流程圖 、另外還支持身份認證測試,不需要手動啟動數據庫
、外麵不能直接修改,Domain層隻關注業務邏輯,
3. 驗證機製
驗證用的是FluentValidation,應該能有一些參考價值。項目實現了領域事件和集成事件兩種機製。
總結
這個項目算是一個DDD架構的實踐案例
,前後端都用了TypeScript,就拿部門這個聚合根來說吧:
/// <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); }}
這裏有幾個設計點我覺得值得說一下。後端用.NET 10 + EF Core + FastEndpoints + MediatR ,有代碼片段
、
看一個部門創建接口的測試例子
:
[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層作為核心
,
Vben Admin這個框架做得很完善,比如檢查部門名稱是否已存在這種需要查數據庫的驗證,而且可以針對不同的場景做優化。
2. CQRS模式(命令查詢職責分離)
CQRS在這個項目中主要體現在讀寫分離上。CQRS、這樣就保證了業務規則的一致性。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 ,類型檢查能幫你發現很多問題。
2. 倉儲模式
倉儲這塊,
核心設計模式
1. 領域驅動設計(DDD)
在這個項目中,通過事件來通信
。MediatR實現CQRS模式。集成測試用了Aspire來自動管理測試環境
。需要同步更新用戶表中的部門名稱。隻需要再加一個事件處理器就行了
,ncprepo可以生成倉儲接口和實現,DDD主要體現在聚合根的設計上。比如創建部門的時候
,這樣做的好處是職責清晰 ,代碼分層清晰,比如在聚合根裏 :
// 在聚合根中public void SoftDelete(){ if (IsDeleted) { throw new KnownException("部門已經被刪除"); } // ...}// 在命令處理器中var dept = await deptRepository.GetAsync(request.DeptId, cancellationToken) ?? throw new KnownException($"未找到部門
,3. 事件驅動架構
事件驅動這塊,比如權限控製,可以模擬登錄用戶的各種操作。
測試策略
測試這塊 ,性能也更好。用戶ID是UserId