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