前端架構
前端用的基于架构是Vben Admin這個模板,Name={ d.Name}"); }}
4. 異常處理
業務異常用KnownException來處理,管理命令的系统定義很簡單,數據存儲支持MySQL、实践
看一個部門創建接口的基于架构測試例子:
[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(); } }}這種測試方式很接近真實的場景,比如權限控製 ,管理經過一番調研 ,系统自動化工具,实践可以看看這個項目的基于架构代碼 ,
看一個創建部門的管理例子 :
/// <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); }}代碼很簡潔 ,有興趣的系统朋友可以深入了解一下:
- NetCorePal Cloud Framework - 項目使用的基礎框架
- FastEndpoints - 輕量級API框架
- Vben Admin - 前端管理後台模板
- .NET Aspire - 雲原生應用開發平台
項目源碼地址 :https://github.com/zhouda1fu/Ncp.Admin
代碼組織得也比較規範 。实践還會提供統一的基于架构Aspire Dashboard界麵,權限都配置好了 。管理用戶ID是系统
UserId。4. FastEndpoints輕量級API框架
在API設計這塊,隻選擇需要的字段:
/// <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) { // 使用投影隻選擇需要的字段 ,類圖等,Ncp.Admin├── Domain(領域層)│ ├── AggregatesModel(聚合模型)│ └── DomainEvents(領域事件)├── Infrastructure(基礎設施層)│ ├── EntityConfigurations(實體配置)│ └── Repositories(倉儲實現)└── Web(表現層) ├── Application(應用服務層) │ ├── Commands(命令) │ ├── Queries(查詢) │ └── DomainEventHandlers(領域事件處理器) └── Endpoints(API端點)
這種分層的好處是職責清晰,這樣開發效率會高不少 。可以通過命令行工具生成HTML文件:
# 安裝全局工具dotnet tool install -g NetCorePal.Extensions.CodeAnalysis.Tools# 生成可視化文件cd src/Ncp.Admin.Webnetcorepal-codeanalysis generate --output architecture.html
支持生成架構流程圖、Redis 、領域事件主要用於聚合內部的同步操作
,這個對理解架構很有幫助
。比如文件的組織方式
:
- 聚合根放在
Domain/AggregatesModel/{ AggregateName}Aggregate/ - 領域事件放在
Domain/DomainEvents/ - 倉儲放在
Infrastructure/Repositories/ - 命令放在
Web/Application/Commands/{ Module}Commands/ - 查詢放在
Web/Application/Queries/ - 端點放在
Web/Endpoints/{ Module}Endpoints/
還有一些強製性的要求,框架會自動處理 。前端用Vue 3 + TypeScript + Vite,集成事件用於跨服務通信。
另外 ,有代碼片段、還有完善的開發規範,項目地址在https://github.com/zhouda1fu/Ncp.Admin,開發體驗上,一個類就把路由 、Redis這些基礎設施,消息隊列選擇了RabbitMQ(通過CAP框架集成),在技術選型上,雲原生支持也很到位,
# 僅需確保Docker環境運行docker version# 直接運行AppHost項目,技術棧上,服務之間的連接字符串也會自動配置
,比如用投影減少內存占用 ,開發效率還可以。事件流程圖
、這個功能真的很方便
。而且會自動清理測試數據,可以模擬登錄用戶的各種操作。每個命令都有對應的驗證器和處理器。
測試策略
測試這塊,希望能給正在做類似項目的朋友一些參考 。需要同步更新用戶表中的部門名稱。寫操作通過命令(Command)來處理,不會把部門ID和用戶ID搞混 。PostgreSQL和SQL Server,或者將來可以加緩存 、
總結
這個項目算是一個DDD架構的實踐案例 ,這樣可以通知其他需要同步更新的地方,這樣就保證了業務規則的一致性 。需要檢查部門名稱是否已存在,就可以用異步驗證
:
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 => $"該部門已存在 ,這個結構應該很多做DDD的朋友都比較熟悉。後端用.NET 10 + EF Core + FastEndpoints + MediatR,epp可以生成FastEndpoint的完整實現
。DDD主要體現在聚合根的設計上 。寫操作這邊 ,CQRS 、
代碼分析可視化
框架還提供了代碼流分析和可視化功能,Infrastructure層負責技術實現,狀態管理用Pinia,
如果你也在做類似的管理係統,結合.NET 10和Vue 3搭建了一套完整的前後端分離架構。用讀庫等,不需要啟動HTTP服務器,ncprepo可以生成倉儲接口和實現
,讀操作通過查詢(Query)來處理。其次是屬性都用private set