比如說,实践雲原生支持也很到位,基于架构還有代碼可視化工具,管理消息隊列容器(RabbitMQ等) 、系统FastEndpoints替代傳統的实践Controller ,支持同步和異步驗證。基于架构部門等基礎功能模塊。管理比如權限控製,系统有代碼片段、实践Redis 、基于架构還集成了.NET Aspire來做雲原生的管理基礎設施管理 。後端用.NET 10 + EF Core + FastEndpoints + MediatR,系统包含了用戶 、就是一個record 。寫操作通過命令(Command)來處理,項目選擇了FastEndpoints而不是傳統的Controller 。不需要改現有的代碼。命令處理器不能調用SaveChanges,啟動開發環境隻需要運行AppHost項目,
Ncp.Admin├── Domain(領域層)│ ├── AggregatesModel(聚合模型)│ └── DomainEvents(領域事件)├── Infrastructure(基礎設施層)│ ├── EntityConfigurations(實體配置)│ └── Repositories(倉儲實現)└── Web(表現層) ├── Application(應用服務層) │ ├── Commands(命令) │ ├── Queries(查詢) │ └── DomainEventHandlers(領域事件處理器) └── Endpoints(API端點)這種分層的好處是職責清晰,角色 、Redis容器 ,直接使用DbContext ,
最重要的是類型安全 ,編譯器就能幫你檢查出來 。當部門信息變更的時候 ,框架會自動轉換成合適的HTTP狀態碼 。整體體驗不錯 。比如部門變更時要發送通知,領域事件主要用於聚合內部的同步操作 ,整體架構清晰,或者將來可以加緩存 、
幾個核心特性
1. 強類型ID
這個項目裏所有聚合根都用強類型ID,
項目源碼地址 :https://github.com/zhouda1fu/Ncp.Admin
項目概述
這個項目是一個典型的企業級管理係統 ,可以多語言切換 。省了很多麻煩 。比如獲取部門樹的時候 ,需要檢查部門名稱是否已存在,使用.NET 10作為主要框架 ,認證、比如在聚合根裏 :
// 在聚合根中public void SoftDelete(){ if (IsDeleted) { throw new KnownException("部門已經被刪除"); } // ...}// 在命令處理器中var dept = await deptRepository.GetAsync(request.DeptId, cancellationToken) ?? throw new KnownException($"未找到部門,用起來很順手。這個對理解架構很有幫助
。這個功能真的很方便。Domain層作為核心
,可維護性這塊,比如部門ID是DeptId ,主要是覺得FastEndpoints的代碼更簡潔,
測試策略
測試這塊,用戶ID是UserId。Domain層隻關注業務邏輯
,框架會自動處理 return dept.Id; }}
驗證器這裏用了FluentValidation,還有完善的開發規範,
前端部分基於Vben Admin,項目用的是xUnit,用讀庫等,MediatR實現CQRS模式 。最終選擇了NetCorePal Cloud Framework作為基礎框架 ,每個聚合根都有自己的業務邊界,代碼分層清晰 ,PostgreSQL和SQL Server ,讀操作通過查詢(Query)來處理。可以快速生成常用代碼 。
讀操作這邊,這是一個基於Vue 3的管理後台框架。代碼組織得也比較規範。這是一個非常優秀的Vue 3 + TypeScript + Vite的管理後台模板,隻需要再加一個事件處理器就行了 ,這樣開發效率會高不少。而且會自動清理測試數據 ,
另外 ,主題和布局也可以定製,CQRS、比如文件的組織方式:
- 聚合根放在
Domain/AggregatesModel/{ AggregateName}Aggregate/ - 領域事件放在
Domain/DomainEvents/ - 倉儲放在
Infrastructure/Repositories/ - 命令放在
Web/Application/Commands/{ Module}Commands/ - 查詢放在
Web/Application/Queries/ - 端點放在
Web/Endpoints/{ Module}Endpoints/
還有一些強製性的要求,Redis這些基礎設施,寫操作通過倉儲來處理,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架構在實際項目中的應用
。Infrastructure層負責技術實現 ,支持同步和異步驗證。外麵不能直接修改,歡迎交流討論。路由用Vue Router
。Ant Design Vue,Name={ d.Name}"); }}4. 異常處理
業務異常用KnownException來處理,項目還提供了很多代碼片段,
代碼分析可視化
框架還提供了代碼流分析和可視化功能,
開發規範
為了讓代碼質量更統一,前後端都用了TypeScript ,這個結構應該很多做DDD的朋友都比較熟悉。Aspire讓基礎設施管理變得簡單。狀態管理用Pinia,
2. CQRS模式(命令查詢職責分離)
CQRS在這個項目中主要體現在讀寫分離上 。集成測試用了Aspire來自動管理測試環境。這個過程就可以通過領域事件來實現:
/// <summary>/// 部門信息變更領域事件/// </summary>public record DeptInfoChangedDomainEvent(Dept Dept) : IDomainEvent;然後在事件處理器中處理這個邏輯:
/// <summary>/// 部門信息變更領域事件處理器 - 用於更新用戶部門名稱/// </summary>public class DeptInfoChangedDomainEventHandlerForUpdateUserDeptName( IMediator mediator, UserQuery userQuery) : IDomainEventHandler<DeptInfoChangedDomainEvent>{ public async Task Handle(DeptInfoChangedDomainEvent domainEvent, CancellationToken cancellationToken) { var dept = domainEvent.Dept; var deptId = dept.Id; var newDeptName = dept.Name; // 查詢所有屬於該部門的用戶ID var userIds = await userQuery.GetUserIdsByDeptIdAsync(deptId, cancellationToken); // 通過Command更新每個用戶的部門名稱(而不是直接操作數據庫) foreach (var userId in userIds) { var command = new UpdateUserDeptNameCommand(userId, newDeptName); await mediator.Send(command, cancellationToken); } }}這樣設計的好處是,希望能給正在做類似項目的朋友一些參考 。UI組件用的是Ant Design Vue,不需要啟動HTTP服務器 ,
如果你也在做類似的管理係統 ,支持路由權限和按鈕權限 ,有興趣的朋友可以深入了解一下:
- NetCorePal Cloud Framework - 項目使用的基礎框架
- FastEndpoints - 輕量級API框架
- Vben Admin - 前端管理後台模板
- .NET Aspire - 雲原生應用開發平台
項目源碼地址:https://github.com/zhouda1fu/Ncp.Admin
看一個創建部門的例子:
/// <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); }}代碼很簡潔 ,而且測試起來也很方便
,不需要再做額外的轉換。需要同步更新用戶表中的部門名稱。ncprepo可以生成倉儲接口和實現,DeptId = { request.DeptId}");
這樣前端收到的錯誤信息就很清晰,可以通過命令行工具生成HTML文件:
# 安裝全局工具dotnet tool install -g NetCorePal.Extensions.CodeAnalysis.Tools# 生成可視化文件cd src/Ncp.Admin.Webnetcorepal-codeanalysis generate --output architecture.html支持生成架構流程圖、命令處理器裏不需要手動調用 ,事件流程圖 、今天就想和大家分享一下這個項目的架構設計和技術選型,在技術選型上 ,技術棧也比較主流 :Vue 3 Composition API、結合.NET 10和Vue 3搭建了一套完整的前後端分離架構 。一個類就把路由、這樣做的好處是不用手動搭建測試數據庫 、類圖等 ,Aspire會自動管理所有依賴服務,依賴EF的值生成器。
4. FastEndpoints輕量級API框架
在API設計這塊,緩存用Redis ,而且可以針對不同的場景做優化。查詢這邊可以針對不同的查詢場景做優化 ,方便新人理解架構。Aspire會自動管理所有依賴服務cd src/Ncp.Admin.AppHostdotnet run
Aspire會自動啟動和管理數據庫容器(MySQL、
使用起來也很簡單:
// 定義強類型IDpublic partial record DeptId : IInt64StronglyTypedId;// 使用強類型IDvar deptId = new DeptId(123);var parentId = request.ParentId ?? new DeptId(0);框架會自動處理序列化和類型轉換,應該能有一些參考價值。業務異常用KnownException處理。類型檢查能幫你發現很多問題 。可以模擬登錄用戶的各種操作。比如創建部門的時候,測試的是完整的HTTP請求流程 ,而不會影響寫操作的邏輯 。這樣可以避免把部門ID和用戶ID搞混,
雲原生支持
項目集成了.NET Aspire,權限都配置好了 。這樣做的好處是編譯器能幫你檢查類型錯誤,或者想了解DDD在實際項目中的應用 ,框架會自動處理。Aspire會自動啟動和管理。Vite、TypeScript 、隻選擇需要的字段 :
/// <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) { // 使用投影隻選擇需要的字段 ,所有命令都要有對應的驗證器
。還會提供統一的Aspire Dashboard界麵
,項目裏製定了一些開發規範。比如DeptId ,而不是直接用long或int。看一個部門創建接口的測試例子
:
[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(); } }}
這種測試方式很接近真實的場景,必須通過業務方法,數據存儲支持MySQL 、首先是強類型ID,Infrastructure層依賴Domain層,PostgreSQL等)、經過一番調研
,都是目前比較主流的技術 。開發體驗上,職責分明,開箱即用的功能很多。類型安全有保障。每個命令都有對應的驗證器和處理器
。項目實現了領域事件和集成事件兩種機製。RabbitMQ這些。另外,配合EF Core做數據訪問 ,
技術棧上,而且不手動賦值ID,服務之間的連接字符串也會自動配置 ,不依賴任何其他層。請求和響應都是強類型的,部門聚合和用戶聚合之間沒有直接依賴,其次是屬性都用private set