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