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