|
今天就想和大家分享一下這個項目的基于架构架構設計和技術選型,整體體驗不錯。管理Aspire會自動管理所有依賴服務cd src/Ncp.Admin.AppHostdotnet run Aspire會自動啟動和管理數據庫容器(MySQL
、系统 比如說,实践雲原生支持也很到位 ,基于架构 幾個核心特性1. 強類型ID這個項目裏所有聚合根都用強類型ID,管理比如檢查部門名稱是系统否已存在這種需要查數據庫的驗證,主題和布局也可以定製,实践集成測試用了Aspire來自動管理測試環境
。基于架构 Vben Admin這個框架做得很完善,管理認證
、系统項目裏製定了一些開發規範。实践這樣代碼更簡潔 ,基于架构或者將來可以加緩存、管理外麵不能直接修改,系统狀態隻能通過業務方法來修改 。部門聚合和用戶聚合之間沒有直接依賴 ,這是一個基於Vue 3的管理後台框架
。可以多語言切換。比如用戶表中的部門名稱。權限都配置好了。或者想了解DDD在實際項目中的應用,需要同步更新用戶表中的部門名稱
。而不會影響寫操作的邏輯
。這樣做的好處是不用手動搭建測試數據庫、寫操作通過倉儲來處理,PostgreSQL和SQL Server,TypeScript
、不需要啟動HTTP服務器,配合EF Core做數據訪問 , 前端架構前端用的是Vben Admin這個模板,這個對理解架構很有幫助。 如果你也在做類似的管理係統,當部門信息變更時會發布領域事件,Domain層隻關注業務邏輯
,整體架構清晰,Redis容器 ,還有代碼可視化工具,命令處理器裏不需要手動調用 ,結合.NET 10和Vue 3搭建了一套完整的前後端分離架構
。Domain層作為核心 ,領域事件主要用於聚合內部的同步操作,類型檢查能幫你發現很多問題
。 使用起來也很簡單
: // 定義強類型IDpublic partial record DeptId : IInt64StronglyTypedId;// 使用強類型IDvar deptId = new DeptId(123);var parentId = request.ParentId ?? new DeptId(0);
框架會自動處理序列化和類型轉換 ,而且不手動賦值ID
,項目地址在https://github.com/zhouda1fu/Ncp.Admin,不需要手動啟動數據庫、而且測試起來也很方便,項目實現了領域事件和集成事件兩種機製。DDD主要體現在聚合根的設計上
。 核心設計模式1. 領域驅動設計(DDD)在這個項目中,也不容易出錯。ncprepo可以生成倉儲接口和實現 , # 僅需確保Docker環境運行docker version# 直接運行AppHost項目
,用戶ID是UserId。比如用投影減少內存占用,比如DeptId,比如文件的組織方式:- 聚合根放在
Domain/AggregatesModel/{ AggregateName}Aggregate/ - 領域事件放在
Domain/DomainEvents/ - 倉儲放在
Infrastructure/Repositories/ - 命令放在
Web/Application/Commands/{ Module}Commands/ - 查詢放在
Web/Application/Queries/ - 端點放在
Web/Endpoints/{ Module}Endpoints/
還有一些強製性的要求,還有完善的開發規範,這個功能真的很方便。這樣做的好處是職責清晰, 4. FastEndpoints輕量級API框架在API設計這塊 ,類型安全有保障
。 2. CQRS模式(命令查詢職責分離)CQRS在這個項目中主要體現在讀寫分離上。倉儲的實現很簡單 : /// <summary>/// 部門倉儲接口/// </summary>public interface IDeptRepository : IRepository<Dept, DeptId> { }/// <summary>/// 部門倉儲實現/// </summary>public class DeptRepository(ApplicationDbContext context) : RepositoryBase<Dept, DeptId, ApplicationDbContext>(context), IDeptRepository { }
框架會自動管理事務和SaveChanges,服務之間的連接字符串也會自動配置
,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,三層之間的依賴關係是單向的 :Web層依賴Infrastructure層
,Infrastructure層負責技術實現,還會提供統一的Aspire Dashboard界麵,職責分明 ,基本的管理後台需求都能滿足。啟動開發環境隻需要運行AppHost項目
,DeptId = { request.DeptId}");
這樣前端收到的錯誤信息就很清晰,這個結構應該很多做DDD的朋友都比較熟悉。每個命令都有對應的驗證器和處理器。 Ncp.Admin├── Domain(領域層)│ ├── AggregatesModel(聚合模型)│ └── DomainEvents(領域事件)├── Infrastructure(基礎設施層)│ ├── EntityConfigurations(實體配置)│ └── Repositories(倉儲實現)└── Web(表現層) ├── Application(應用服務層) │ ├── Commands(命令) │ ├── Queries(查詢) │ └── DomainEventHandlers(領域事件處理器) └── Endpoints(API端點)
這種分層的好處是職責清晰,經過一番調研,代碼分層清晰, 前端部分基於Vben 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(); } }}
這種測試方式很接近真實的場景 ,比如獲取部門樹的時候
,不會把部門ID和用戶ID搞混。Infrastructure層依賴Domain層,這樣做的好處是編譯器能幫你檢查類型錯誤, 看一個創建部門的例子
: /// <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); }}
代碼很簡潔 ,需要檢查部門名稱是否已存在 , 3. 事件驅動架構事件驅動這塊,框架會自動轉換成合適的HTTP狀態碼
。隻需要再加一個事件處理器就行了,最終選擇了NetCorePal Cloud Framework作為基礎框架,查詢操作直接使用DbContext。接口定義好之後,用起來很順手。數據存儲支持MySQL、請求和響應都是強類型的,Redis這些基礎設施,可以快速生成常用代碼。消息隊列容器(RabbitMQ等)
、就可以用異步驗證: 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架構的實踐案例,支持同步和異步驗證。就可以用異步的MustAsync
|