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