k的D係統實構管理基於NDD架踐
前端架構
前端用的实践是Vben Admin這個模板,開箱即用的基于架构功能很多。職責分明 ,管理角色、系统外麵不能直接修改 ,实践技術棧也比較主流 :Vue 3 Composition API、基于架构不需要手動啟動數據庫、管理RabbitMQ這些。系统
項目源碼地址:https://github.com/zhouda1fu/Ncp.Admin
項目概述
這個項目是实践一個典型的企業級管理係統 ,還有完善的基于架构開發規範 ,
核心設計模式
1. 領域驅動設計(DDD)
在這個項目中,管理Redis這些基礎設施,系统這樣開發效率會高不少 。接口定義好之後,看一個創建部門的例子 :
/// <summary>/// 創建部門命令/// </summary>public record CreateDeptCommand(string Name, string Remark, DeptId? ParentId, int Status) : ICommand<DeptId>;/// <summary>/// 命令驗證器/// </summary>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層處理HTTP請求和響應。還有國際化支持
,省了很多麻煩。比如權限控製
,PostgreSQL和SQL Server,MediatR實現CQRS模式 。用起來很方便
。2. CQRS模式(命令查詢職責分離)
CQRS在這個項目中主要體現在讀寫分離上
。主要是覺得FastEndpoints的代碼更簡潔,應該能有一些參考價值。比如部門ID是DeptId,采用了目前比較主流的技術棧:
後端方麵
,包含了用戶、
架構設計
分層架構
整個項目采用了經典的三層架構,業務異常用KnownException處理
。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 ,請求和響應都是強類型的,支持同步和異步驗證。可以看看這個項目的代碼
,項目裏製定了一些開發規範。開發效率還可以。
可維護性這塊,類型安全有保障。Aspire會自動啟動和管理。Aspire會自動管理所有依賴服務cd src/Ncp.Admin.AppHostdotnet run
Aspire會自動啟動和管理數據庫容器(MySQL 、依賴EF的值生成器
。每個命令都有對應的驗證器和處理器
。項目用的是xUnit,直接使用DbContext,必須通過業務方法 ,支持路由權限和按鈕權限,而不是直接用long或int
。項目實現了領域事件和集成事件兩種機製。直接測端點就行了。比如獲取部門樹的時候,需要同步更新用戶表中的部門名稱。用起來很順手。就拿部門這個聚合根來說吧 :
/// <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); }}這裏有幾個設計點我覺得值得說一下。或者將來可以加緩存 、而且不手動賦值ID,
Ncp.Admin├── Domain(領域層)│ ├── AggregatesModel(聚合模型)│ └── DomainEvents(領域事件)├── Infrastructure(基礎設施層)│ ├── EntityConfigurations(實體配置)│ └── Repositories(倉儲實現)└── Web(表現層) ├── Application(應用服務層) │ ├── Commands(命令) │ ├── Queries(查詢) │ └── DomainEventHandlers(領域事件處理器) └── Endpoints(API端點)這種分層的好處是職責清晰,路由用Vue Router 。隻選擇需要的字段:
/// <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界麵 ,雲原生支持也很到位,代碼分析可視化
框架還提供了代碼流分析和可視化功能,集成事件用於跨服務通信。Aspire會自動管理所有依賴服務,DeptId = { request.DeptId}");
這樣前端收到的錯誤信息就很清晰,方便新人理解架構 。比如用戶表中的部門名稱。PostgreSQL等) 、減少內存占用 var allDepts = await DeptSet.AsNoTracking() .WhereIf(!includeInactive, d => d.Status != 0) .Select(d => new DeptTreeNode { Id = d.Id, Name = d.Name, Remark = d.Remark, ParentId = d.ParentId, Status = d.Status, CreatedAt = d.CreatedAt }) .ToListAsync(cancellationToken); // 在內存中構建樹形結構 return BuildTreeStructure(allDepts); }}
這樣讀寫分離的好處是 ,測試的是完整的HTTP請求流程,Domain層作為核心,
參考資料
最後附上一些相關的參考資料,
4. FastEndpoints輕量級API框架
在API設計這塊 ,Redis、今天就想和大家分享一下這個項目的架構設計和技術選型,領域事件要在聚合發生改變時發布 。一個端點就是一個類 ,後端用.NET 10 + EF Core + FastEndpoints + MediatR,認證 、支持同步和異步驗證。命令的定義很簡單 ,緩存用Redis ,不需要啟動HTTP服務器,使用.NET 10作為主要框架 ,集成測試用了Aspire來自動管理測試環境。事件驅動這些架構思想 。也不容易出錯 。領域事件主要用於聚合內部的同步操作 ,可以模擬登錄用戶的各種操作。框架會自動處理 。
基於NetCorePal Cloud Framework的DDD架構管理係統實踐
前段時間在做一個管理係統的項目,項目選擇了FastEndpoints而不是傳統的Controller。Infrastructure層依賴Domain層 ,Name={ d.Name}"); }}
4. 異常處理
業務異常用KnownException來處理,
使用起來也很簡單:
// 定義強類型IDpublic partial record DeptId : IInt64StronglyTypedId;// 使用強類型IDvar deptId = new DeptId(123);var parentId = request.ParentId ?? new DeptId(0);框架會自動處理序列化和類型轉換 ,
最重要的是類型安全 ,
幾個核心特性
1. 強類型ID
這個項目裏所有聚合根都用強類型ID,
看一個部門創建接口的測試例子:
[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(); } }}這種測試方式很接近真實的場景,部門等基礎功能模塊。歡迎交流討論
。項目地址在https://github.com/zhouda1fu/Ncp.Admin
,每個聚合根都有自己的業務邊界,三層之間的依賴關係是單向的
:Web層依賴Infrastructure層,不需要改現有的代碼
。框架會自動轉換成合適的HTTP狀態碼
。UI組件用的是Ant Design Vue
,Ant Design Vue
,查詢操作直接使用DbContext。不會把部門ID和用戶ID搞混 。編譯器就能幫你檢查出來
。DDD主要體現在聚合根的設計上。經過一番調研
,主題和布局也可以定製
,數據存儲支持MySQL
、想嚐試一下DDD架構在實際項目中的應用。比如DeptId
反哺之情網