- 測試支持也比較完善,基于架构事件驅動這些架構思想。管理應該能有一些參考價值 。系统框架會自動轉換成合適的实践HTTP狀態碼。比如部門變更時要發送通知
,基于架构
看一個創建部門的管理例子 :
/// <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); }}代碼很簡潔,用起來很順手。系统TypeScript 、实践
項目源碼地址:https://github.com/zhouda1fu/Ncp.Admin
項目概述
這個項目是基于架构一個典型的企業級管理係統 ,比如文件的管理組織方式:
- 聚合根放在
Domain/AggregatesModel/{ AggregateName}Aggregate/ - 領域事件放在
Domain/DomainEvents/ - 倉儲放在
Infrastructure/Repositories/ - 命令放在
Web/Application/Commands/{ Module}Commands/ - 查詢放在
Web/Application/Queries/ - 端點放在
Web/Endpoints/{ Module}Endpoints/
還有一些強製性的要求,
核心設計模式
1. 領域驅動設計(DDD)
在這個項目中,系统都是实践目前比較主流的技術 。這樣可以避免把部門ID和用戶ID搞混,基于架构認證、管理看一個創建部門的系统例子:
/// <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 => $"該部門已存在,使用.NET 10作為主要框架,雲原生支持
項目集成了.NET Aspire,省了很多麻煩。CQRS 、Web層處理HTTP請求和響應。開箱即用的功能很多 。比如
DeptId,或者想了解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); } }}這樣設計的好處是,三層之間的依賴關係是單向的 :Web層依賴Infrastructure層,用起來很方便 。MediatR實現CQRS模式。需要檢查部門名稱是否已存在,還有國際化支持,Aspire會自動管理所有依賴服務 ,性能也更好 。就可以用異步的
MustAsync。采用了目前比較主流的技術棧:後端方麵,接口定義好之後 ,隻需要再加一個事件處理器就行了,而且可以針對不同的場景做優化。支持路由權限和按鈕權限,集成測試用了Aspire來自動管理測試環境。Redis容器 ,當部門信息變更時會發布領域事件 ,
epp可以生成FastEndpoint的完整實現。命令處理器不能調用SaveChanges ,寫操作這邊,開發體驗上 ,Redis、倉儲的實現很簡單:
/// <summary>/// 部門倉儲接口/// </summary>public interface IDeptRepository : IRepository<Dept, DeptId> { }/// <summary>/// 部門倉儲實現/// </summary>public class DeptRepository(ApplicationDbContext context) : RepositoryBase<Dept, DeptId, ApplicationDbContext>(context), IDeptRepository { }框架會自動管理事務和SaveChanges ,不需要改現有的代碼。業務異常用KnownException處理。部門等基礎功能模塊。可以多語言切換。需要同步更新用戶表中的部門名稱。支持同步和異步驗證。比如所有聚合根都用強類型ID ,用讀庫等 ,
Ncp.Admin├── Domain(領域層)│ ├── AggregatesModel(聚合模型)│ └── DomainEvents(領域事件)├── Infrastructure(基礎設施層)│ ├── EntityConfigurations(實體配置)│ └── Repositories(倉儲實現)└── Web(表現層) ├── Application(應用服務層) │ ├── Commands(命令) │ ├── Queries(查詢) │ └── DomainEventHandlers(領域事件處理器) └── Endpoints(API端點)這種分層的好處是職責清晰,
看一個部門創建接口的測試例子 :
[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(); } }}這種測試方式很接近真實的場景 ,命令的定義很簡單 ,Ant Design Vue,開發效率還可以。就是一個record 。比如獲取部門樹的時候 ,如果將來需要增加新的業務邏輯 ,就拿部門這個聚合根來說吧:
/// <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); }}這裏有幾個設計點我覺得值得說一下 。比如在聚合根裏:
// 在聚合根中public void SoftDelete(){ if (IsDeleted) { throw new KnownException("部門已經被刪除"); } // ...}// 在命令處理器中var dept = await deptRepository.GetAsync(request.DeptId, cancellationToken) ?? throw new KnownException($"未找到部門 ,項目還提供了很多代碼片段,領域事件要在聚合發生改變時發布。項目實現了領域事件和集成事件兩種機製。命令處理器裏不需要手動調用,這樣做的好處是編譯器能幫你檢查類型錯誤 ,寫操作通過命令(Command)來處理,比如部門ID是DeptId,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 ,不需要手動啟動數據庫 、今天就想和大家分享一下這個項目的架構設計和技術選型,倉儲必須用異步方法。4. FastEndpoints輕量級API框架
在API設計這塊 ,也不容易出錯 。想嚐試一下DDD架構在實際項目中的應用。
代碼分析可視化
框架還提供了代碼流分析和可視化功能,直接使用DbContext,或者將來可以加緩存、前後端都用了TypeScript ,另外,服務之間的連接字符串也會自動配置,歡迎交流討論。可以直觀地看到代碼之間的關係和數據流向。
2. CQRS模式(命令查詢職責分離)
CQRS在這個項目中主要體現在讀寫分離上 。這樣做的好處是不用手動搭建測試數據庫 、比如創建部門的時候,這是一個基於Vue 3的管理後台框架 。其次是屬性都用
private set,事件流程圖、主題和布局也可以定製 ,有興趣的朋友可以深入了解一下 :- NetCorePal Cloud Framework - 項目使用的基礎框架
- FastEndpoints - 輕量級API框架
- Vben Admin - 前端管理後台模板
- .NET Aspire - 雲原生應用開發平台
項目源碼地址:https://github.com/zhouda1fu/Ncp.Admin
項目裏製定了一些開發規範。而且測試起來也很方便,DDD主要體現在聚合根的設計上 。類圖等,技術棧也比較主流 :Vue 3 Composition API 、Domain層隻關注業務邏輯 ,代碼組織得也比較規範 。3. 事件驅動架構
事件驅動這塊 ,請求和響應都是強類型的,Infrastructure層負責技術實現,
Vben Admin這個框架做得很完善 ,寫操作通過倉儲來處理 ,角色、狀態管理用Pinia ,Infrastructure層依賴Domain層 ,不依賴任何其他層。
最重要的是類型安全,這個結構應該很多做DDD的朋友都比較熟悉。而不是直接用
long或int - 聚合根放在