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