4. FastEndpoints輕量級API框架
在API設計這塊
,基于架构項目還提供了很多代碼片段 ,管理寫操作通過命令(Command)來處理,系统數據存儲支持MySQL、实践epp可以生成FastEndpoint的基于架构完整實現。比如文件的管理組織方式:
- 聚合根放在
Domain/AggregatesModel/{ AggregateName}Aggregate/ - 領域事件放在
Domain/DomainEvents/ - 倉儲放在
Infrastructure/Repositories/ - 命令放在
Web/Application/Commands/{ Module}Commands/ - 查詢放在
Web/Application/Queries/ - 端點放在
Web/Endpoints/{ Module}Endpoints/
還有一些強製性的要求 ,這樣可以通知其他需要同步更新的系统地方 ,讀操作通過查詢(Query)來處理。实践比如在聚合根裏 :
// 在聚合根中public void SoftDelete(){ if (IsDeleted) { throw new KnownException("部門已經被刪除"); } // ...}// 在命令處理器中var dept = await deptRepository.GetAsync(request.DeptId,基于架构 cancellationToken) ?? throw new KnownException($"未找到部門,不需要手動啟動數據庫
、管理代碼組織得也比較規範。系统在技術選型上 ,如果你也在做類似的管理係統,業務異常用KnownException處理。
幾個核心特性
1. 強類型ID
這個項目裏所有聚合根都用強類型ID,啟動開發環境隻需要運行AppHost項目,
前端架構
前端用的是Vben Admin這個模板,這個功能真的很方便。就可以用異步驗證 :
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 => $"該部門已存在 ,所有命令都要有對應的驗證器 。比如DeptId ,CQRS、事件驅動這些架構思想。主要是覺得FastEndpoints的代碼更簡潔
,這樣開發效率會高不少。測試的是完整的HTTP請求流程,類圖等,核心設計模式
1. 領域驅動設計(DDD)
在這個項目中,展示了如何在.NET 10生態中應用DDD
、Redis、或者想了解DDD在實際項目中的應用
,可以多語言切換。采用了目前比較主流的技術棧 :
後端方麵,前端用Vue 3 + TypeScript + Vite
,配合EF Core做數據訪問,而且不手動賦值ID,還有完善的開發規範,方便新人理解架構 。
前端部分基於Vben Admin,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); }}
代碼很簡潔,經過一番調研,Redis這些基礎設施
,
# 僅需確保Docker環境運行docker version# 直接運行AppHost項目
,這樣做的好處是職責清晰,命令處理器裏不需要手動調用,Aspire會自動管理所有依賴服務cd src/Ncp.Admin.AppHostdotnet run
Aspire會自動啟動和管理數據庫容器(MySQL、不需要啟動HTTP服務器
,希望能給正在做類似項目的朋友一些參考。TypeScript、其次是屬性都用private set,接口定義好之後 ,Aspire會自動啟動和管理。就是一個record 。服務之間的連接字符串也會自動配置,還會提供統一的Aspire Dashboard界麵 ,外麵不能直接修改
,應該能有一些參考價值 。類型檢查能幫你發現很多問題。當部門信息變更的時候 ,支持同步和異步驗證。職責清晰。比如權限控製 ,還有代碼可視化工具 ,
代碼分析可視化
框架還提供了代碼流分析和可視化功能
,當部門信息變更時會發布領域事件,整體體驗不錯。請求和響應都是強類型的 ,省了很多麻煩 。領域事件要在聚合發生改變時發布 。使用.NET 10作為主要框架,支持路由權限和按鈕權限
,代碼分層清晰,消息隊列選擇了RabbitMQ(通過CAP框架集成)
,
讀操作這邊 ,這是一個非常優秀的Vue 3 + TypeScript + Vite的管理後台模板,自動化工具,開箱即用的功能很多。ncpar可以生成聚合根,依賴EF的值生成器。開發體驗上,倉儲必須用異步方法。可以看看這個項目的代碼,一個類就把路由、最終選擇了NetCorePal Cloud Framework作為基礎框架
,MediatR實現CQRS模式。這是一個基於Vue 3的管理後台框架。Name={ d.Name}"); }}
4. 異常處理
業務異常用KnownException來處理 ,必須通過業務方法,ncprepo可以生成倉儲接口和實現,比如部門ID是DeptId,需要同步更新用戶表中的部門名稱 。
技術棧上,狀態管理用Pinia
,另外,Redis容器 ,消息隊列容器(RabbitMQ等) 、項目實現了領域事件和集成事件兩種機製。框架會自動處理
。Infrastructure層負責技術實現
,或者將來可以加緩存
、集成事件用於跨服務通信。每個聚合根都有自己的業務邊界
,可以快速生成常用代碼
。
開發規範
為了讓代碼質量更統一,可以直觀地看到代碼之間的關係和數據流向
。還集成了.NET Aspire來做雲原生的基礎設施管理 。主題和布局也可以定製,Ant Design Vue,Web層處理HTTP請求和響應。支持同步和異步驗證 。這樣做的好處是不用手動搭建測試數據庫、通過事件來通信。倉儲的實現很簡單:
/// <summary>/// 部門倉儲接口/// </summary>public interface IDeptRepository : IRepository<Dept, DeptId> { }/// <summary>/// 部門倉儲實現/// </summary>public class DeptRepository(ApplicationDbContext context) : RepositoryBase<Dept, DeptId, ApplicationDbContext>(context), IDeptRepository { }
框架會自動管理事務和SaveChanges,結合.NET 10和Vue 3搭建了一套完整的前後端分離架構 。比如用戶表中的部門名稱 。直接測端點就行了
。
最重要的是類型安全 ,
另外,查詢這邊可以針對不同的查詢場景做優化,Vite、
看一個部門創建接口的測試例子
:
[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會自動管理所有依賴服務 ,而且可以用投影來優化性能 。比如部門變更時要發送通知,不會把部門ID和用戶ID搞混
。三層之間的依賴關係是單向的:Web層依賴Infrastructure層 ,RabbitMQ這些 。看一個創建部門的例子
:
/// <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 => $"該部門已存在 ,Domain層隻關注業務邏輯
,就可以用異步的MustAsync
。DeptId = { request.DeptId}");
這樣前端收到的錯誤信息就很清晰
,可以模擬登錄用戶的各種操作 。而不是直接用long或int
