構管理係統實k的D基於NDD架踐
long或int 。Vite
、管理測試策略
測試這塊,系统比如ncpcmd可以生成命令及其驗證器和處理器 ,实践
開發規範
為了讓代碼質量更統一,基于架构集成事件用於跨服務通信。管理
核心設計模式
1. 領域驅動設計(DDD)
在這個項目中,系统整體體驗不錯 。实践比如部門ID是基于架构DeptId,
3. 事件驅動架構
事件驅動這塊,管理項目地址在https://github.com/zhouda1fu/Ncp.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(); } }}這種測試方式很接近真實的場景 ,Aspire會自動管理所有依賴服務 ,系统開箱即用的功能很多 。這個結構應該很多做DDD的朋友都比較熟悉 。而且不手動賦值ID,接口定義好之後,不依賴任何其他層。
前端架構
前端用的是Vben Admin這個模板 ,而且會自動清理測試數據,
架構設計
分層架構
整個項目采用了經典的三層架構 ,希望能給正在做類似項目的朋友一些參考。不需要手動啟動數據庫、有興趣的朋友可以深入了解一下:
- NetCorePal Cloud Framework - 項目使用的基礎框架
- FastEndpoints - 輕量級API框架
- Vben Admin - 前端管理後台模板
- .NET Aspire - 雲原生應用開發平台
項目源碼地址:https://github.com/zhouda1fu/Ncp.Admin
而不會影響寫操作的邏輯 。類型安全有保障。後端用.NET 10 + EF Core + FastEndpoints + MediatR ,PostgreSQL和SQL Server,還有國際化支持,不需要啟動HTTP服務器,也不容易出錯。服務之間的連接字符串也會自動配置,
Ncp.Admin├── Domain(領域層)│ ├── AggregatesModel(聚合模型)│ └── DomainEvents(領域事件)├── Infrastructure(基礎設施層)│ ├── EntityConfigurations(實體配置)│ └── Repositories(倉儲實現)└── Web(表現層) ├── Application(應用服務層) │ ├── Commands(命令) │ ├── Queries(查詢) │ └── DomainEventHandlers(領域事件處理器) └── Endpoints(API端點)這種分層的好處是職責清晰 ,可以看看這個項目的代碼 ,權限都配置好了。Name={ d.Name}"); }}
4. 異常處理
業務異常用KnownException來處理
,職責分明,這樣可以避免把部門ID和用戶ID搞混,比如檢查部門名稱是否已存在這種需要查數據庫的驗證 ,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,編譯器就能幫你檢查出來。狀態隻能通過業務方法來修改。自動化工具,比如文件的組織方式:
- 聚合根放在
Domain/AggregatesModel/{ AggregateName}Aggregate/ - 領域事件放在
Domain/DomainEvents/ - 倉儲放在
Infrastructure/Repositories/ - 命令放在
Web/Application/Commands/{ Module}Commands/ - 查詢放在
Web/Application/Queries/ - 端點放在
Web/Endpoints/{ Module}Endpoints/
還有一些強製性的要求,就拿部門這個聚合根來說吧 :
/// <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); }}這裏有幾個設計點我覺得值得說一下。結合.NET 10和Vue 3搭建了一套完整的前後端分離架構 。如果將來需要增加新的業務邏輯 ,用起來很方便 。而且測試起來也很方便,比如創建部門的時候 ,可以快速生成常用代碼。可以模擬登錄用戶的各種操作。還有完善的開發規範,這是一個非常優秀的Vue 3 + TypeScript + Vite的管理後台模板,或者想了解DDD在實際項目中的應用,代碼分層清晰 ,寫操作通過命令(Command)來處理 ,業務異常用KnownException處理。必須通過業務方法,Redis 、一個類就把路由、首先是強類型ID ,框架會自動轉換成合適的HTTP狀態碼。DeptId = { request.DeptId}");
這樣前端收到的錯誤信息就很清晰,所有命令都要有對應的驗證器。用起來很順手 。通過事件來通信 。
讀操作這邊 ,一個端點就是一個類,比如用投影減少內存占用,主要是覺得FastEndpoints的代碼更簡潔,這樣做的好處是不用手動搭建測試數據庫 、
另外,項目裏製定了一些開發規範 。用讀庫等 ,Aspire會自動管理所有依賴服務cd src/Ncp.Admin.AppHostdotnet run
Aspire會自動啟動和管理數據庫容器(MySQL、不需要再做額外的轉換。就是一個record。代碼組織得也比較規範 。框架會自動處理 。
# 僅需確保Docker環境運行docker version# 直接運行AppHost項目
,可以直觀地看到代碼之間的關係和數據流向 。都是目前比較主流的技術
。請求和響應都是強類型的,命令的定義很簡單,前端部分基於Vben Admin
,寫操作通過倉儲來處理,支持同步和異步驗證
。事件流程圖、查詢操作直接使用DbContext 。ncpar可以生成聚合根,基本的管理後台需求都能滿足
。
比如說,epp可以生成FastEndpoint的完整實現 。比如獲取部門樹的時候 ,隻需要再加一個事件處理器就行了,保證測試之間的獨立性。就可以用異步驗證:
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 => $"該部門已存在,依賴EF的值生成器。省了很多麻煩。代碼分析可視化
框架還提供了代碼流分析和可視化功能,CQRS、TypeScript
、有代碼片段、歡迎交流討論。啟動開發環境隻需要運行AppHost項目
,方便新人理解架構
。這是一個基於Vue 3的管理後台框架 。路由用Vue Router 。另外,類型檢查能幫你發現很多問題。技術棧也比較主流:Vue 3 Composition API 、可以查看所有服務的狀態。命令處理器裏不需要手動調用,開發效率還可以。而且可以用投影來優化性能。比如權限控製 ,ncprepo可以生成倉儲接口和實現,可以多語言切換。領域事件主要用於聚合內部的同步操作,這個對理解架構很有幫助
。
技術棧上
,部門等基礎功能模塊。UI組件用的是Ant Design Vue,
基於NetCorePal Cloud Framework的DDD架構管理係統實踐
前段時間在做一個管理係統的項目,每個命令都有對應的驗證器和處理器。緩存用Redis
,讀操作通過查詢(Query)來處理。性能也更好。想嚐試一下DDD架構在實際項目中的應用。認證、直接測端點就行了。在技術選型上
,
2. 倉儲模式
倉儲這塊,消息隊列選擇了RabbitMQ(通過CAP框架集成) ,其次是屬性都用private set
,還會提供統一的Aspire Dashboard界麵,Infrastructure層負責技術實現,
雲原生支持
項目集成了.NET Aspire,需要同步更新用戶表中的部門名稱。狀態管理用Pinia
,支持同步和異步驗證。使用.NET 10作為主要框架
,Web層處理HTTP請求和響應
。應該能有一些參考價值
。
最重要的是類型安全,這樣做的好處是編譯器能幫你檢查類型錯誤,事件驅動這些架構思想
。
如果你也在做類似的管理係統,倉儲的實現很簡單:
/// <summary>/// 部門倉儲接口/// </summary>public interface IDeptRepository : IRepository<Dept, DeptId> { }/// <summary>/// 部門倉儲實現/// </summary>public class DeptRepository(ApplicationDbContext context) : RepositoryBase<Dept, DeptId, ApplicationDbContext>(context), IDeptRepository { }
框架會自動管理事務和SaveChanges
,
項目源碼地址 :https://github.com/zhouda1fu/Ncp.Admin
項目概述
這個項目是一個典型的企業級管理係統
,查詢這邊可以針對不同的查詢場景做優化
,測試的是完整的HTTP請求流程 ,項目選擇了FastEndpoints而不是傳統的Controller
。Redis容器 ,比如DeptId
目擊道存網