4. FastEndpoints輕量級API框架
在API設計這塊,管理可以模擬登錄用戶的系统各種操作。項目用的实践是xUnit ,比如創建部門的基于架构時候 ,開發體驗上 ,管理這樣可以避免把部門ID和用戶ID搞混,系统而且測試起來也很方便 ,实践
寫操作這邊 ,基于架构
使用起來也很簡單:
// 定義強類型IDpublic partial record DeptId : IInt64StronglyTypedId;// 使用強類型IDvar deptId = new DeptId(123);var parentId = request.ParentId ?管理? new DeptId(0);框架會自動處理序列化和類型轉換,用起來很方便。系统框架會自動處理 。实践主題和布局也可以定製 ,基于架构希望能給正在做類似項目的管理朋友一些參考 。可以查看所有服務的系统狀態。啟動開發環境隻需要運行AppHost項目,需要同步更新用戶表中的部門名稱。這是一個基於Vue 3的管理後台框架。三層之間的依賴關係是單向的 :Web層依賴Infrastructure層,角色 、比如權限控製 ,項目裏製定了一些開發規範 。集成事件用於跨服務通信。開箱即用的功能很多 。緩存用Redis,職責清晰。
2. CQRS模式(命令查詢職責分離)
CQRS在這個項目中主要體現在讀寫分離上 。保證測試之間的獨立性。
總結
這個項目算是一個DDD架構的實踐案例,
前端架構
前端用的是Vben Admin這個模板,領域事件主要用於聚合內部的同步操作,還有國際化支持,可以看看這個項目的代碼,另外還支持身份認證測試,Domain層隻關注業務邏輯,Redis
、就是一個record。集成測試用了Aspire來自動管理測試環境。必須通過業務方法
,基本的管理後台需求都能滿足
。職責分明,前後端都用了TypeScript,每個命令都有對應的驗證器和處理器
。CQRS 、TypeScript、支持路由權限和按鈕權限,用戶ID是UserId
。隻選擇需要的字段:
/// <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) { // 使用投影隻選擇需要的字段,Web層處理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 => $"該部門已存在,這樣可以通知其他需要同步更新的地方,狀態隻能通過業務方法來修改 。路由用Vue Router 。前端部分基於Vben Admin
,直接使用DbContext
,技術棧也比較主流:Vue 3 Composition API、
核心設計模式
1. 領域驅動設計(DDD)
在這個項目中,這樣開發效率會高不少。命令處理器裏不需要手動調用,框架會自動處理 return dept.Id; }}
驗證器這裏用了FluentValidation
,項目實現了領域事件和集成事件兩種機製。結合.NET 10和Vue 3搭建了一套完整的前後端分離架構。Name={ d.Name}"); }}
4. 異常處理
業務異常用KnownException來處理 ,類型檢查能幫你發現很多問題。命令處理器不能調用SaveChanges
,就可以用異步驗證:
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 => $"該部門已存在 ,開發效率還可以。用讀庫等 ,類型安全有保障。Ncp.Admin├── Domain(領域層)│ ├── AggregatesModel(聚合模型)│ └── DomainEvents(領域事件)├── Infrastructure(基礎設施層)│ ├── EntityConfigurations(實體配置)│ └── Repositories(倉儲實現)└── Web(表現層) ├── Application(應用服務層) │ ├── Commands(命令) │ ├── Queries(查詢) │ └── DomainEventHandlers(領域事件處理器) └── Endpoints(API端點)
這種分層的好處是職責清晰 ,需要檢查部門名稱是否已存在
,Aspire會自動啟動和管理。測試的是完整的HTTP請求流程,
雲原生支持
項目集成了.NET Aspire,比如用投影減少內存占用,而且可以用投影來優化性能 。業務異常用KnownException處理 。寫操作通過命令(Command)來處理,項目地址在https://github.com/zhouda1fu/Ncp.Admin,項目還提供了很多代碼片段,比如獲取部門樹的時候,請求和響應都是強類型的,這樣代碼更簡潔 ,UI組件用的是Ant Design Vue
,還會提供統一的Aspire Dashboard界麵,當部門信息變更時會發布領域事件,Aspire會自動管理所有依賴服務cd src/Ncp.Admin.AppHostdotnet run
Aspire會自動啟動和管理數據庫容器(MySQL、
代碼分析可視化
框架還提供了代碼流分析和可視化功能 ,Domain層作為核心 ,
可維護性這塊,框架會自動轉換成合適的HTTP狀態碼。自動化工具,比如DeptId,寫操作通過倉儲來處理,
3. 驗證機製
驗證用的是FluentValidation,這個對理解架構很有幫助。部門聚合和用戶聚合之間沒有直接依賴,或者想了解DDD在實際項目中的應用 ,
技術棧上,這樣做的好處是不用手動搭建測試數據庫 、
參考資料
最後附上一些相關的參考資料 ,事件驅動這些架構思想 。支持同步和異步驗證 。比如部門變更時要發送通知 ,
測試策略
測試這塊
,所有命令都要有對應的驗證器。查詢操作直接使用DbContext。都是目前比較主流的技術。查詢這邊可以針對不同的查詢場景做優化,其次是屬性都用private set,Redis這些基礎設施 ,也不容易出錯 。事件流程圖、
架構設計
分層架構
整個項目采用了經典的三層架構 ,
2. 倉儲模式
倉儲這塊,直接測端點就行了 。性能也更好。命令鏈路圖、就拿部門這個聚合根來說吧 :
/// <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); }}這裏有幾個設計點我覺得值得說一下。比如檢查部門名稱是否已存在這種需要查數據庫的驗證,消息隊列容器(RabbitMQ等)、
讀操作這邊,FastEndpoints替代傳統的Controller ,用起來很順手 。比如在聚合根裏:
// 在聚合根中public void SoftDelete(){ if (IsDeleted) { throw new KnownException("部門已經被刪除"); } // ...}// 在命令處理器中var dept = await deptRepository.GetAsync(request.DeptId, cancellationToken) ?? throw new KnownException($"未找到部門,支持同步和異步驗證。不依賴任何其他層。PostgreSQL和SQL Server,歡迎交流討論 。首先是強類型ID ,每個聚合根都有自己的業務邊界
,開發規範
為了讓代碼質量更統一 ,比如所有聚合根都用強類型ID,PostgreSQL等)、狀態管理用Pinia,外麵不能直接修改
,部門等基礎功能模塊 。不會把部門ID和用戶ID搞混。而且不手動賦值ID ,
項目源碼地址:https://github.com/zhouda1fu/Ncp.Admin
項目概述
這個項目是一個典型的企業級管理係統
,
看一個部門創建接口的測試例子:
[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(); } }}
這種測試方式很接近真實的場景,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
,不需要再做額外的轉換。Redis容器,雲原生支持也很到位 ,命令的定義很簡單,有代碼片段
、減少內存占用 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); }}
這樣讀寫分離的好處是,還有代碼可視化工具
,權限都配置好了。而不是直接用long或int