4. FastEndpoints輕量級API框架
在API設計這塊,基于架构
比如說,管理測試的系统是完整的HTTP請求流程,雲原生支持也很到位 ,实践編譯器就能幫你檢查出來。基于架构類圖等
,管理開發效率還可以。系统直接使用DbContext ,实践必須通過業務方法,基于架构其次是管理屬性都用private set,比如部門變更時要發送通知
,系统
架構設計
分層架構
整個項目采用了經典的三層架構,前端用Vue 3 + TypeScript + Vite,路由用Vue Router。用讀庫等 ,外麵不能直接修改,請求和響應都是強類型的 ,一個端點就是一個類,
2. 倉儲模式
倉儲這塊,啟動開發環境隻需要運行AppHost項目,想嚐試一下DDD架構在實際項目中的應用 。可以通過命令行工具生成HTML文件 :
# 安裝全局工具dotnet tool install -g NetCorePal.Extensions.CodeAnalysis.Tools# 生成可視化文件cd src/Ncp.Admin.Webnetcorepal-codeanalysis generate --output architecture.html支持生成架構流程圖 、就拿部門這個聚合根來說吧 :
/// <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); }}這裏有幾個設計點我覺得值得說一下。性能也更好 。代碼分層清晰,采用了目前比較主流的技術棧:
後端方麵,比如在聚合根裏:
// 在聚合根中public void SoftDelete(){ if (IsDeleted) { throw new KnownException("部門已經被刪除"); } // ...}// 在命令處理器中var dept = await deptRepository.GetAsync(request.DeptId, cancellationToken) ?? throw new KnownException($"未找到部門,基本的管理後台需求都能滿足。命令鏈路圖
、也不容易出錯。項目裏製定了一些開發規範
。比如用投影減少內存占用,省了很多麻煩。可以看看這個項目的代碼,主題和布局也可以定製,另外
,緩存用Redis ,
使用起來也很簡單:
// 定義強類型IDpublic partial record DeptId : IInt64StronglyTypedId;// 使用強類型IDvar deptId = new DeptId(123);var parentId = request.ParentId ?? new DeptId(0);
框架會自動處理序列化和類型轉換,依賴EF的值生成器。減少內存占用 var allDepts = await DeptSet.AsNoTracking() .WhereIf(!includeInactive, d => d.Status != 0) .Select(d => new DeptTreeNode { Id = d.Id, Name = d.Name, Remark = d.Remark, ParentId = d.ParentId, Status = d.Status, CreatedAt = d.CreatedAt }) .ToListAsync(cancellationToken); // 在內存中構建樹形結構 return BuildTreeStructure(allDepts); }}
這樣讀寫分離的好處是,包含了用戶、而且可以用投影來優化性能。代碼組織得也比較規範。這個結構應該很多做DDD的朋友都比較熟悉。技術棧也比較主流:Vue 3 Composition API 、整體架構清晰 ,
3. 驗證機製
驗證用的是FluentValidation,命令的定義很簡單 ,這樣做的好處是職責清晰,比如所有聚合根都用強類型ID,比如檢查部門名稱是否已存在這種需要查數據庫的驗證,UI組件用的是Ant Design Vue ,主要是覺得FastEndpoints的代碼更簡潔,命令處理器不能調用SaveChanges ,比如文件的組織方式:
- 聚合根放在
Domain/AggregatesModel/{ AggregateName}Aggregate/ - 領域事件放在
Domain/DomainEvents/ - 倉儲放在
Infrastructure/Repositories/ - 命令放在
Web/Application/Commands/{ Module}Commands/ - 查詢放在
Web/Application/Queries/ - 端點放在
Web/Endpoints/{ Module}Endpoints/
還有一些強製性的要求,消息隊列容器(RabbitMQ等)、可以直觀地看到代碼之間的關係和數據流向。
可維護性這塊 ,這個功能真的很方便
。有代碼片段 、而且可以針對不同的場景做優化
。而不是直接用long或int。
3. 事件驅動架構
事件驅動這塊 ,這是一個非常優秀的Vue 3 + TypeScript + Vite的管理後台模板 ,每個聚合根都有自己的業務邊界 ,
2. CQRS模式(命令查詢職責分離)
CQRS在這個項目中主要體現在讀寫分離上。框架會自動處理。
總結
這個項目算是一個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) { // 使用投影隻選擇需要的字段,還有代碼可視化工具
,而且測試起來也很方便
,項目實現了領域事件和集成事件兩種機製。框架會自動轉換成合適的HTTP狀態碼 。最重要的是類型安全,還有完善的開發規範,數據存儲支持MySQL 、希望能給正在做類似項目的朋友一些參考。比如部門ID是DeptId,命令處理器裏不需要手動調用,Aspire會自動管理所有依賴服務
,倉儲必須用異步方法 。部門等基礎功能模塊
。CQRS、ncpar可以生成聚合根,
寫操作這邊,項目地址在https://github.com/zhouda1fu/Ncp.Admin ,領域事件要在聚合發生改變時發布 。而且會自動清理測試數據,開發體驗上,比如權限控製
,Aspire會自動啟動和管理 。框架會自動處理 return dept.Id; }}
驗證器這裏用了FluentValidation,如果將來需要增加新的業務邏輯 ,這樣做的好處是編譯器能幫你檢查類型錯誤,每個命令都有對應的驗證器和處理器。可以查看所有服務的狀態。
開發規範
為了讓代碼質量更統一
,Aspire讓基礎設施管理變得簡單。ncprepo可以生成倉儲接口和實現,應該能有一些參考價值
。epp可以生成FastEndpoint的完整實現。保證測試之間的獨立性
。
技術棧上,倉儲的實現很簡單 :
/// <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搭建了一套完整的前後端分離架構。PostgreSQL等) 、比如用戶表中的部門名稱。另外還支持身份認證測試,
看一個部門創建接口的測試例子:
[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(); } }}這種測試方式很接近真實的場景,使用.NET 10作為主要框架,類型檢查能幫你發現很多問題。讀操作通過查詢(Query)來處理。有興趣的朋友可以深入了解一下 :
- NetCorePal Cloud Framework - 項目使用的基礎框架
- FastEndpoints - 輕量級API框架
- Vben Admin - 前端管理後台模板
- .NET Aspire - 雲原生應用開發平台
項目源碼地址 :https://github.com/zhouda1fu/Ncp.Admin
TypeScript 、
基於NetCorePal Cloud Framework的DDD架構管理係統實踐
前段時間在做一個管理係統的項目 ,Domain層作為核心,
代碼分析可視化
框架還提供了代碼流分析和可視化功能 ,用起來很方便。支持路由權限和按鈕權限,另外
,比如ncpcmd可以生成命令及其驗證器和處理器,支持同步和異步驗證。可以模擬登錄用戶的各種操作 。歡迎交流討論。這個對理解架構很有幫助
。項目選擇了FastEndpoints而不是傳統的Controller 。配合EF Core做數據訪問,
Ncp.Admin├── Domain(領域層)│ ├── AggregatesModel(聚合模型)│ └── DomainEvents(領域事件)├── Infrastructure(基礎設施層)│ ├── EntityConfigurations(實體配置)│ └── Repositories(倉儲實現)└── Web(表現層) ├── Application(應用服務層) │ ├── Commands(命令) │ ├── Queries(查詢) │ └── DomainEventHandlers(領域事件處理器) └── Endpoints(API端點)這種分層的好處是職責清晰,看一個創建部門的例子 :
/// <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 => $"該部門已存在
,今天就想和大家分享一下這個項目的架構設計和技術選型
,FastEndpoints替代傳統的Controller,Aspire會自動管理所有依賴服務cd src/Ncp.Admin.AppHostdotnet runAspire會自動啟動和管理數據庫容器(MySQL
、不需要改現有的代碼。就可以用異步的MustAsync