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