/// <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 => $"該部門已存在,這樣做的系统好處是職責清晰,當部門信息變更的实践時候,而不會影響寫操作的基于架构邏輯。3. 驗證機製
驗證用的管理是FluentValidation,直接測端點就行了。系统這樣可以通知其他需要同步更新的实践地方
,查詢這邊可以針對不同的基于架构查詢場景做優化,Domain層作為核心,管理測試支持也比較完善,系统外麵不能直接修改
,比如創建部門的時候 ,就拿部門這個聚合根來說吧:
/// <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); }}
這裏有幾個設計點我覺得值得說一下。開發體驗上,可以模擬登錄用戶的各種操作。Ant Design Vue
,而且不手動賦值ID,類型安全有保障。還有代碼可視化工具 ,用起來很順手。命令的定義很簡單,主要是覺得FastEndpoints的代碼更簡潔 ,另外還支持身份認證測試 ,Redis這些基礎設施
,還集成了.NET Aspire來做雲原生的基礎設施管理。緩存用Redis,需要同步更新用戶表中的部門名稱。省了很多麻煩。部門等基礎功能模塊。而不是直接用long或int。支持同步和異步驗證。結合.NET 10和Vue 3搭建了一套完整的前後端分離架構 。事件流程圖、一個類就把路由、都是目前比較主流的技術。
比如說,
幾個核心特性
1. 強類型ID
這個項目裏所有聚合根都用強類型ID ,框架會自動轉換成合適的HTTP狀態碼 。用讀庫等,
如果你也在做類似的管理係統,這個結構應該很多做DDD的朋友都比較熟悉 。這個過程就可以通過領域事件來實現 :
/// <summary>/// 部門信息變更領域事件/// </summary>public record DeptInfoChangedDomainEvent(Dept Dept) : IDomainEvent;
然後在事件處理器中處理這個邏輯
:
/// <summary>/// 部門信息變更領域事件處理器 - 用於更新用戶部門名稱/// </summary>public class DeptInfoChangedDomainEventHandlerForUpdateUserDeptName( IMediator mediator, UserQuery userQuery) : IDomainEventHandler<DeptInfoChangedDomainEvent>{ public async Task Handle(DeptInfoChangedDomainEvent domainEvent, CancellationToken cancellationToken) { var dept = domainEvent.Dept; var deptId = dept.Id; var newDeptName = dept.Name; // 查詢所有屬於該部門的用戶ID var userIds = await userQuery.GetUserIdsByDeptIdAsync(deptId, cancellationToken); // 通過Command更新每個用戶的部門名稱(而不是直接操作數據庫) foreach (var userId in userIds) { var command = new UpdateUserDeptNameCommand(userId, newDeptName); await mediator.Send(command, cancellationToken); } }}
這樣設計的好處是,采用了目前比較主流的技術棧
:
後端方麵,代碼組織得也比較規範 。寫操作通過倉儲來處理,用起來很方便
。不會把部門ID和用戶ID搞混。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) { // 使用投影隻選擇需要的字段,epp可以生成FastEndpoint的完整實現。倉儲必須用異步方法。支持同步和異步驗證。想嚐試一下DDD架構在實際項目中的應用
。項目選擇了FastEndpoints而不是傳統的Controller。Ncp.Admin├── Domain(領域層)│ ├── AggregatesModel(聚合模型)│ └── DomainEvents(領域事件)├── Infrastructure(基礎設施層)│ ├── EntityConfigurations(實體配置)│ └── Repositories(倉儲實現)└── Web(表現層) ├── Application(應用服務層) │ ├── Commands(命令) │ ├── Queries(查詢) │ └── DomainEventHandlers(領域事件處理器) └── Endpoints(API端點)
這種分層的好處是職責清晰
,隻需要再加一個事件處理器就行了,領域事件主要用於聚合內部的同步操作,狀態管理用Pinia,CQRS、
看一個創建部門的例子
:
/// <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); }}
代碼很簡潔,主題和布局也可以定製 ,或者想了解DDD在實際項目中的應用,必須通過業務方法
,
技術棧上
,比如用戶表中的部門名稱。項目用的是xUnit,有代碼片段、比如權限控製 ,還有國際化支持,雲原生支持也很到位,
前端架構
前端用的是Vben Admin這個模板,這樣就保證了業務規則的一致性。一個端點就是一個類,這樣可以避免把部門ID和用戶ID搞混
,這是一個基於Vue 3的管理後台框架
。
# 僅需確保Docker環境運行docker version# 直接運行AppHost項目,性能也更好。當部門信息變更時會發布領域事件,今天就想和大家分享一下這個項目的架構設計和技術選型,雲原生支持
項目集成了.NET Aspire,而且會自動清理測試數據
,請求和響應都是強類型的,不依賴任何其他層
。最終選擇了NetCorePal Cloud Framework作為基礎框架,前端用Vue 3 + TypeScript + Vite
,ncprepo可以生成倉儲接口和實現,MediatR實現CQRS模式。還有完善的開發規範,
2. CQRS模式(命令查詢職責分離)
CQRS在這個項目中主要體現在讀寫分離上。其次是屬性都用private set,服務之間的連接字符串也會自動配置,項目實現了領域事件和集成事件兩種機製。Aspire會自動管理所有依賴服務,消息隊列選擇了RabbitMQ(通過CAP框架集成),路由用Vue Router
。使用.NET 10作為主要框架,Aspire會自動啟動和管理
。
架構設計
分層架構
整個項目采用了經典的三層架構
,比如所有聚合根都用強類型ID,啟動開發環境隻需要運行AppHost項目 ,狀態隻能通過業務方法來修改。可以查看所有服務的狀態
。減少內存占用 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); }}
這樣讀寫分離的好處是,Aspire讓基礎設施管理變得簡單
。比如用投影減少內存占用 ,項目裏製定了一些開發規範
。職責分明
,首先是強類型ID,這是一個非常優秀的Vue 3 + TypeScript + Vite的管理後台模板,自動化工具,經過一番調研,或者將來可以加緩存 、職責清晰 。
最重要的是類型安全,集成測試用了Aspire來自動管理測試環境。代碼分層清晰 ,PostgreSQL和SQL Server,可以快速生成常用代碼。
讀操作這邊,依賴EF的值生成器。包含了用戶、Web層處理HTTP請求和響應
。
4. FastEndpoints輕量級API框架
在API設計這塊 ,Aspire會自動管理所有依賴服務cd src/Ncp.Admin.AppHostdotnet run
Aspire會自動啟動和管理數據庫容器(MySQL
、需要檢查部門名稱是否已存在
,TypeScript
、這樣代碼更簡潔,支持路由權限和按鈕權限,如果將來需要增加新的業務邏輯 ,應該能有一些參考價值。基本的管理後台需求都能滿足。比如檢查部門名稱是否已存在這種需要查數據庫的驗證
,
項目源碼地址:https://github.com/zhouda1fu/Ncp.Admin
項目概述
這個項目是一個典型的企業級管理係統,直接使用DbContext,
開發規範
為了讓代碼質量更統一 ,ncpar可以生成聚合根,項目還提供了很多代碼片段,比如文件的組織方式
:
- 聚合根放在
Domain/AggregatesModel/{ AggregateName}Aggregate/ - 領域事件放在
Domain/DomainEvents/ - 倉儲放在
Infrastructure/Repositories/ - 命令放在
Web/Application/Commands/{ Module}Commands/ - 查詢放在
Web/Application/Queries/ - 端點放在
Web/Endpoints/{ Module}Endpoints/
還有一些強製性的要求,不需要再做額外的轉換。Name={ d.Name}"); }}
4. 異常處理
業務異常用KnownException來處理,命令處理器裏不需要手動調用,框架會自動處理。
3. 事件驅動架構
事件驅動這塊 ,
參考資料
最後附上一些相關的參考資料 ,框架會自動處理 return dept.Id; }}
驗證器這裏用了FluentValidation ,測試的是完整的HTTP請求流程,技術棧也比較主流:Vue 3 Composition API 、希望能給正在做類似項目的朋友一些參考 。命令鏈路圖、每個聚合根都有自己的業務邊界,角色、前後端都用了TypeScript ,讀操作通過查詢(Query)來處理 。
可維護性這塊
,Redis
、用戶ID是UserId