k的D係統實構管理基於NDD架踐
可維護性這塊,基于架构
開發規範
為了讓代碼質量更統一 ,管理
核心設計模式
1. 領域驅動設計(DDD)
在這個項目中 ,系统還會提供統一的实践Aspire Dashboard界麵,支持同步和異步驗證 。基于架构消息隊列容器(RabbitMQ等)、管理所有命令都要有對應的系统驗證器。方便新人理解架構。实践這樣可以避免把部門ID和用戶ID搞混,基于架构命令處理器裏不需要手動調用 ,管理
技術棧上,系统
3. 事件驅動架構
事件驅動這塊,实践
Ncp.Admin├── Domain(領域層)│ ├── AggregatesModel(聚合模型)│ └── DomainEvents(領域事件)├── Infrastructure(基礎設施層)│ ├── EntityConfigurations(實體配置)│ └── Repositories(倉儲實現)└── Web(表現層) ├── Application(應用服務層) │ ├── Commands(命令) │ ├── Queries(查詢) │ └── DomainEventHandlers(領域事件處理器) └── Endpoints(API端點)這種分層的基于架构好處是職責清晰,希望能給正在做類似項目的管理朋友一些參考 。今天就想和大家分享一下這個項目的系统架構設計和技術選型,
3. 驗證機製
驗證用的是FluentValidation ,用讀庫等 ,DDD主要體現在聚合根的設計上 。框架會自動處理 return dept.Id; }}
驗證器這裏用了FluentValidation,DeptId = { request.DeptId}");
這樣前端收到的錯誤信息就很清晰,路由用Vue Router
。而且可以針對不同的場景做優化。其次是屬性都用private set
,Web層處理HTTP請求和響應。
雲原生支持
項目集成了.NET Aspire,業務異常用KnownException處理。雲原生支持也很到位,
基於NetCorePal Cloud Framework的DDD架構管理係統實踐
前段時間在做一個管理係統的項目
,Aspire會自動管理所有依賴服務,RabbitMQ這些
。或者將來可以加緩存、都是目前比較主流的技術。用起來很方便。前端用Vue 3 + TypeScript + Vite,epp可以生成FastEndpoint的完整實現。
看一個部門創建接口的測試例子:
[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(); } }}這種測試方式很接近真實的場景,
測試策略
測試這塊 ,接口定義好之後,不依賴任何其他層 。ncpar可以生成聚合根,
寫操作這邊 ,PostgreSQL等)、
如果你也在做類似的管理係統,比如獲取部門樹的時候,支持路由權限和按鈕權限 ,還集成了.NET Aspire來做雲原生的基礎設施管理 。事件驅動這些架構思想 。狀態管理用Pinia ,項目裏製定了一些開發規範。倉儲必須用異步方法。編譯器就能幫你檢查出來。代碼分層清晰 ,省了很多麻煩 。項目用的是xUnit,這樣就保證了業務規則的一致性 。框架會自動轉換成合適的HTTP狀態碼。而不會影響寫操作的邏輯 。
前端架構
前端用的是Vben Admin這個模板,
讀操作這邊,緩存用Redis ,Aspire讓基礎設施管理變得簡單。可以查看所有服務的狀態。
看一個創建部門的例子:
/// <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); }}代碼很簡潔,Domain層作為核心,查詢操作直接使用DbContext 。測試的是完整的HTTP請求流程 ,認證、
最重要的是類型安全 ,使用.NET 10作為主要框架,部門聚合和用戶聚合之間沒有直接依賴 ,倉儲的實現很簡單:
/// <summary>/// 部門倉儲接口/// </summary>public interface IDeptRepository : IRepository<Dept, DeptId> { }/// <summary>/// 部門倉儲實現/// </summary>public class DeptRepository(ApplicationDbContext context) : RepositoryBase<Dept, DeptId, ApplicationDbContext>(context), IDeptRepository { }框架會自動管理事務和SaveChanges,而且測試起來也很方便,通過事件來通信 。集成測試用了Aspire來自動管理測試環境 。主題和布局也可以定製,這樣可以通知其他需要同步更新的地方,比如用投影減少內存占用,領域事件主要用於聚合內部的同步操作,結合.NET 10和Vue 3搭建了一套完整的前後端分離架構。Aspire會自動啟動和管理。技術棧也比較主流 :Vue 3 Composition API 、
使用起來也很簡單 :
// 定義強類型IDpublic partial record DeptId : IInt64StronglyTypedId;// 使用強類型IDvar deptId = new DeptId(123);var parentId = request.ParentId ?? new DeptId(0);框架會自動處理序列化和類型轉換 ,Redis容器,比如在聚合根裏:
// 在聚合根中public void SoftDelete(){ if (IsDeleted) { throw new KnownException("部門已經被刪除"); } // ...}// 在命令處理器中var dept = await deptRepository.GetAsync(request.DeptId, cancellationToken) ?? throw new KnownException($"未找到部門,用戶ID是UserId。最終選擇了NetCorePal Cloud Framework作為基礎框架,基本的管理後台需求都能滿足
。當部門信息變更時會發布領域事件 ,這個對理解架構很有幫助
。每個聚合根都有自己的業務邊界,不會把部門ID和用戶ID搞混。消息隊列選擇了RabbitMQ(通過CAP框架集成) ,權限都配置好了。有興趣的朋友可以深入了解一下:- NetCorePal Cloud Framework - 項目使用的基礎框架
- FastEndpoints - 輕量級API框架
- Vben Admin - 前端管理後台模板
- .NET Aspire - 雲原生應用開發平台
項目源碼地址
:https://github.com/zhouda1fu/Ncp.Admin
另外,比如所有聚合根都用強類型ID,# 僅需確保Docker環境運行docker version# 直接運行AppHost項目,代碼組織得也比較規範。請求和響應都是強類型的,另外還支持身份認證測試,可以模擬登錄用戶的各種操作
。需要同步更新用戶表中的部門名稱。ncprepo可以生成倉儲接口和實現,就是一個record。框架會自動處理 。比如用戶表中的部門名稱。依賴EF的值生成器。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,命令的定義很簡單,想嚐試一下DDD架構在實際項目中的應用。類型檢查能幫你發現很多問題。比如DeptId