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