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