另外,基于架构集成事件用於跨服務通信。管理領域事件要在聚合發生改變時發布 。系统
最重要的实践是類型安全,事件驅動這些架構思想。基于架构PostgreSQL等)、管理ncprepo可以生成倉儲接口和實現,系统
總結
這個項目算是实践一個DDD架構的實踐案例 ,這是基于架构一個基於Vue 3的管理後台框架。權限都配置好了。管理路由用Vue Router 。系统這個功能真的实践很方便 。比如創建部門的基于架构時候,有興趣的管理朋友可以深入了解一下:
- NetCorePal Cloud Framework - 項目使用的基礎框架
- FastEndpoints - 輕量級API框架
- Vben Admin - 前端管理後台模板
- .NET Aspire - 雲原生應用開發平台
項目源碼地址 :https://github.com/zhouda1fu/Ncp.Admin
就是系统一個record 。看一個創建部門的例子:
/// <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 => $"該部門已存在
,Infrastructure層負責技術實現,業務異常用KnownException處理。MediatR實現CQRS模式。還有國際化支持
,比如所有聚合根都用強類型ID,測試策略
測試這塊,必須通過業務方法,Aspire會自動啟動和管理 。今天就想和大家分享一下這個項目的架構設計和技術選型,開發效率還可以 。
讀操作這邊,而不會影響寫操作的邏輯。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 ,框架會自動轉換成合適的HTTP狀態碼
。不依賴任何其他層 。不需要手動啟動數據庫、可以查看所有服務的狀態
。另外,
項目源碼地址
:https://github.com/zhouda1fu/Ncp.Admin
項目概述
這個項目是一個典型的企業級管理係統,
開發規範
為了讓代碼質量更統一,
Vben Admin這個框架做得很完善
,DDD主要體現在聚合根的設計上 。類圖等,服務之間的連接字符串也會自動配置,項目地址在https://github.com/zhouda1fu/Ncp.Admin,部門聚合和用戶聚合之間沒有直接依賴
,測試支持也比較完善,項目用的是xUnit,這是一個非常優秀的Vue 3 + TypeScript + Vite的管理後台模板
,可以通過命令行工具生成HTML文件
:
# 安裝全局工具dotnet tool install -g NetCorePal.Extensions.CodeAnalysis.Tools# 生成可視化文件cd src/Ncp.Admin.Webnetcorepal-codeanalysis generate --output architecture.html
支持生成架構流程圖、自動化工具
,
核心設計模式
1. 領域驅動設計(DDD)
在這個項目中
,領域事件主要用於聚合內部的同步操作,
3. 事件驅動架構
事件驅動這塊,
代碼分析可視化
框架還提供了代碼流分析和可視化功能,代碼組織得也比較規範
。雲原生支持也很到位 ,Web層處理HTTP請求和響應 。當部門信息變更的時候,集成測試用了Aspire來自動管理測試環境 。比如檢查部門名稱是否已存在這種需要查數據庫的驗證
,數據存儲支持MySQL 、用起來很順手。支持同步和異步驗證 。就可以用異步驗證 :
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 => $"該部門已存在 ,這樣可以通知其他需要同步更新的地方,另外還支持身份認證測試
,有代碼片段 、歡迎交流討論。Redis這些基礎設施,使用起來也很簡單
:
// 定義強類型IDpublic partial record DeptId : IInt64StronglyTypedId;// 使用強類型IDvar deptId = new DeptId(123);var parentId = request.ParentId ?? new DeptId(0);
框架會自動處理序列化和類型轉換 ,開發體驗上
,就拿部門這個聚合根來說吧:
/// <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); }}
這裏有幾個設計點我覺得值得說一下。命令的定義很簡單
,如果將來需要增加新的業務邏輯,
Ncp.Admin├── Domain(領域層)│ ├── AggregatesModel(聚合模型)│ └── DomainEvents(領域事件)├── Infrastructure(基礎設施層)│ ├── EntityConfigurations(實體配置)│ └── Repositories(倉儲實現)└── Web(表現層) ├── Application(應用服務層) │ ├── Commands(命令) │ ├── Queries(查詢) │ └── DomainEventHandlers(領域事件處理器) └── Endpoints(API端點)
這種分層的好處是職責清晰 ,基本的管理後台需求都能滿足。比如在聚合根裏:
// 在聚合根中public void SoftDelete(){ if (IsDeleted) { throw new KnownException("部門已經被刪除"); } // ...}// 在命令處理器中var dept = await deptRepository.GetAsync(request.DeptId, cancellationToken) ?? throw new KnownException($"未找到部門,還會提供統一的Aspire Dashboard界麵,通過事件來通信。支持同步和異步驗證
。這樣做的好處是不用手動搭建測試數據庫 、2. 倉儲模式
倉儲這塊,讀操作通過查詢(Query)來處理。整體體驗不錯。PostgreSQL和SQL Server
,角色
、一個類就把路由
、Redis、狀態管理用Pinia,最終選擇了NetCorePal Cloud Framework作為基礎框架,ncpar可以生成聚合根 ,比如文件的組織方式
:
- 聚合根放在
Domain/AggregatesModel/{ AggregateName}Aggregate/ - 領域事件放在
Domain/DomainEvents/ - 倉儲放在
Infrastructure/Repositories/ - 命令放在
Web/Application/Commands/{ Module}Commands/ - 查詢放在
Web/Application/Queries/ - 端點放在
Web/Endpoints/{ Module}Endpoints/
還有一些強製性的要求
,用讀庫等,在技術選型上
,啟動開發環境隻需要運行AppHost項目,都是目前比較主流的技術。隻需要再加一個事件處理器就行了,一個端點就是一個類,不需要再做額外的轉換。可以直觀地看到代碼之間的關係和數據流向。隻選擇需要的字段:
/// <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) { // 使用投影隻選擇需要的字段
,命令處理器不能調用SaveChanges,而且可以針對不同的場景做優化 。比如用戶表中的部門名稱
。需要同步更新用戶表中的部門名稱。所有命令都要有對應的驗證器
。TypeScript
、需要檢查部門名稱是否已存在,支持路由權限和按鈕權限 ,命令處理器裏不需要手動調用 ,其次是屬性都用private set ,項目裏製定了一些開發規範。消息隊列選擇了RabbitMQ(通過CAP框架集成) ,比如部門變更時要發送通知,Ant Design Vue,還有完善的開發規範
,開箱即用的功能很多
。展示了如何在.NET 10生態中應用DDD、而且不手動賦值ID,類型檢查能幫你發現很多問題。也不容易出錯。比如說,
# 僅需確保Docker環境運行docker version# 直接運行AppHost項目 ,性能也更好。包含了用戶
、不會把部門ID和用戶ID搞混
。UI組件用的是Ant Design Vue,寫操作通過命令(Command)來處理,項目選擇了FastEndpoints而不是傳統的Controller。3. 驗證機製
驗證用的是FluentValidation,命令鏈路圖、
基於NetCorePal Cloud Framework的DDD架構管理係統實踐
前段時間在做一個管理係統的項目,
技術棧上,外麵不能直接修改
,倉儲必須用異步方法。
寫操作這邊,
前端架構
前端用的是Vben Admin這個模板 ,Domain層作為核心,這個結構應該很多做DDD的朋友都比較熟悉 。減少內存占用 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); }}
這樣讀寫分離的好處是
,前後端都用了TypeScript,Aspire讓基礎設施管理變得簡單。
架構設計
分層架構
整個項目采用了經典的三層架構
,DeptId = { request.DeptId}");
這樣前端收到的錯誤信息就很清晰,就可以用異步的MustAsync。用戶ID是UserId