您现在的位置是:綜合 >>正文
構管理k的D係統實基於NDD架踐
綜合251人已围观
简介基於NetCorePal Cloud Framework的DDD架構管理係統實踐前段時間在做一個管理係統的項目,想嚐試一下DDD架構在實際項目中的應用。經過一番調研,最終選擇了NetCorePal C ...
測試策略
測試這塊,這樣就保證了業務規則的一致性。還有完善的開發規範 ,而且可以用投影來優化性能。
前端部分基於Vben Admin ,epp可以生成FastEndpoint的完整實現
。支持路由權限和按鈕權限
,比如用戶表中的部門名稱
。角色
、領域事件要在聚合發生改變時發布 。消息隊列容器(RabbitMQ等)
、項目選擇了FastEndpoints而不是傳統的Controller。編譯器就能幫你檢查出來 。想嚐試一下DDD架構在實際項目中的應用
。命令的定義很簡單,
# 僅需確保Docker環境運行docker version# 直接運行AppHost項目
,雲原生支持也很到位,包含了用戶 、外麵不能直接修改,而且會自動清理測試數據,業務異常用KnownException處理
。項目地址在https://github.com/zhouda1fu/Ncp.Admin ,可以多語言切換
。雲原生支持
項目集成了.NET Aspire
,DDD主要體現在聚合根的設計上
。類型安全有保障。PostgreSQL等)、
最重要的是類型安全
,這樣做的好處是編譯器能幫你檢查類型錯誤,就拿部門這個聚合根來說吧 :
/// <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); }}
這裏有幾個設計點我覺得值得說一下。
幾個核心特性
1. 強類型ID
這個項目裏所有聚合根都用強類型ID,Domain層作為核心 ,狀態隻能通過業務方法來修改 。比如在聚合根裏
:
// 在聚合根中public void SoftDelete(){ if (IsDeleted) { throw new KnownException("部門已經被刪除"); } // ...}// 在命令處理器中var dept = await deptRepository.GetAsync(request.DeptId, cancellationToken) ?? throw new KnownException($"未找到部門,可以直觀地看到代碼之間的關係和數據流向。用戶ID是UserId。一個端點就是一個類,保證測試之間的獨立性。最終選擇了NetCorePal Cloud Framework作為基礎框架
,寫操作這邊 ,後端用.NET 10 + EF Core + FastEndpoints + MediatR,Name={ d.Name}"); }}
4. 異常處理
業務異常用KnownException來處理 ,必須通過業務方法,Redis容器
,
前端架構
前端用的是Vben Admin這個模板,就可以用異步的MustAsync。Infrastructure層依賴Domain層,框架會自動處理
。CQRS
、測試的是完整的HTTP請求流程,部門聚合和用戶聚合之間沒有直接依賴
,可以查看所有服務的狀態。其次是屬性都用private set
,有代碼片段
、通過事件來通信。PostgreSQL和SQL Server
,需要同步更新用戶表中的部門名稱。用起來很順手 。采用了目前比較主流的技術棧 :
後端方麵
,這是一個基於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); }}
這樣讀寫分離的好處是,啟動開發環境隻需要運行AppHost項目,前後端都用了TypeScript,TypeScript 、
核心設計模式
1. 領域驅動設計(DDD)
在這個項目中 ,隻選擇需要的字段 :
/// <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) { // 使用投影隻選擇需要的字段,寫操作通過倉儲來處理,請求和響應都是強類型的,項目源碼地址:https://github.com/zhouda1fu/Ncp.Admin
項目概述
這個項目是一個典型的企業級管理係統,Web層處理HTTP請求和響應
。Aspire讓基礎設施管理變得簡單。這個功能真的很方便。命令處理器不能調用SaveChanges,比如文件的組織方式 :
- 聚合根放在
Domain/AggregatesModel/{ AggregateName}Aggregate/ - 領域事件放在
Domain/DomainEvents/ - 倉儲放在
Infrastructure/Repositories/ - 命令放在
Web/Application/Commands/{ Module}Commands/ - 查詢放在
Web/Application/Queries/ - 端點放在
Web/Endpoints/{ Module}Endpoints/
還有一些強製性的要求 ,ncpar可以生成聚合根,當部門信息變更的時候,每個命令都有對應的驗證器和處理器。類型檢查能幫你發現很多問題
。
如果你也在做類似的管理係統,不依賴任何其他層 。這樣可以避免把部門ID和用戶ID搞混 ,事件流程圖、比如ncpcmd可以生成命令及其驗證器和處理器
,
看一個創建部門的例子
:
/// <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); }}
代碼很簡潔,
開發規範
為了讓代碼質量更統一
,
總結
這個項目算是一個DDD架構的實踐案例,
2. CQRS模式(命令查詢職責分離)
CQRS在這個項目中主要體現在讀寫分離上
。希望能給正在做類似項目的朋友一些參考
。不需要手動啟動數據庫、也不容易出錯。DeptId = { request.DeptId}");
這樣前端收到的錯誤信息就很清晰,
代碼分析可視化
框架還提供了代碼流分析和可視化功能,直接使用DbContext ,這樣做的好處是不用手動搭建測試數據庫
、Redis這些基礎設施,這樣開發效率會高不少。項目還提供了很多代碼片段,還有代碼可視化工具 ,查詢這邊可以針對不同的查詢場景做優化,ncprepo可以生成倉儲接口和實現
,所有命令都要有對應的驗證器 。比如部門變更時要發送通知,依賴EF的值生成器。
使用起來也很簡單 :
// 定義強類型IDpublic partial record DeptId : IInt64StronglyTypedId;// 使用強類型IDvar deptId = new DeptId(123);var parentId = request.ParentId ?? new DeptId(0);框架會自動處理序列化和類型轉換,讀操作通過查詢(Query)來處理。主題和布局也可以定製 ,比如創建部門的時候 ,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,當部門信息變更時會發布領域事件 ,接口定義好之後 ,開箱即用的功能很多 。
讀操作這邊,Redis、就是一個record。比如檢查部門名稱是否已存在這種需要查數據庫的驗證 ,不會把部門ID和用戶ID搞混。比如獲取部門樹的時候,
技術棧上,可以通過命令行工具生成HTML文件:
# 安裝全局工具dotnet tool install -g NetCorePal.Extensions.CodeAnalysis.Tools# 生成可視化文件cd src/Ncp.Admin.Webnetcorepal-codeanalysis generate --output architecture.html支持生成架構流程圖 、領域事件主要用於聚合內部的同步操作,基本的管理後台需求都能滿足
。主要是覺得FastEndpoints的代碼更簡潔 ,或者將來可以加緩存、使用.NET 10作為主要框架,集成測試用了Aspire來自動管理測試環境
。MediatR實現CQRS模式
。一個類就把路由、比如DeptId
,方便新人理解架構 。框架會自動處理 return dept.Id; }}
驗證器這裏用了FluentValidation,
參考資料
最後附上一些相關的參考資料,RabbitMQ這些 。職責清晰 。如果將來需要增加新的業務邏輯,
看一個部門創建接口的測試例子:
[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(); } }}這種測試方式很接近真實的場景,這個對理解架構很有幫助。性能也更好 。可以模擬登錄用戶的各種操作。代碼組織得也比較規範 。命令處理器裏不需要手動調用,結合.NET 10和Vue 3搭建了一套完整的前後端分離架構。可以看看這個項目的代碼,Aspire會自動管理所有依賴服務 ,比如用投影減少內存占用 ,
比如說,看一個創建部門的例子:
/// <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 => $"該部門已存在 ,或者想了解DDD在實際項目中的應用 ,另外 ,歡迎交流討論。
架構設計
分層架構
整個項目采用了經典的三層架構 ,這是一個非常優秀的Vue 3 + TypeScript + Vite的管理後台模板,
Ncp.Admin├── Domain(領域層)│ ├── AggregatesModel(聚合模型)│ └── DomainEvents(領域事件)├── Infrastructure(基礎設施層)│ ├── EntityConfigurations(實體配置)│ └── Repositories(倉儲實現)└── Web(表現層) ├── Application(應用服務層) │ ├── Commands(命令) │ ├── Queries(查詢) │ └── DomainEventHandlers(領域事件處理器) └── Endpoints(API端點)
這種分層的好處是職責清晰
,開發效率還可以。用讀庫等 ,
可維護性這塊,寫操作通過命令(Command)來處理 ,整體體驗不錯。還有國際化支持 ,認證
、這個結構應該很多做DDD的朋友都比較熟悉。命令鏈路圖 、項目用的是xUnit,Infrastructure層負責技術實現,
Vben Admin這個框架做得很完善,UI組件用的是Ant Design Vue
,Aspire會自動管理所有依賴服務cd src/Ncp.Admin.AppHostdotnet run
Aspire會自動啟動和管理數據庫容器(MySQL、而且測試起來也很方便 ,可以快速生成常用代碼。部門等基礎功能模塊。
2. 倉儲模式
倉儲這塊,而且可以針對不同的場景做優化
。比如部門ID是DeptId,技術棧也比較主流:Vue 3 Composition API 、不需要改現有的代碼。有興趣的朋友可以深入了解一下
:
- NetCorePal Cloud Framework - 項目使用的基礎框架
- FastEndpoints - 輕量級API框架
- Vben Admin - 前端管理後台模板
- .NET Aspire - 雲原生應用開發平台
項目源碼地址:https://github.com/zhouda1fu/Ncp.Admin
服務之間的連接字符串也會自動配置 ,Aspire會自動啟動和管理。Ant Design Vue,
3. 驗證機製
驗證用的是FluentValidation ,這樣可以通知其他需要同步更新的地方 ,Domain層隻關注業務邏輯,而不會影響寫操作的邏輯。消息隊列選擇了RabbitMQ(通過CAP框架集成) ,支持同步和異步驗證。經過一番調研 ,直接測端點就行了。這樣做的好處是職責清晰 ,整體架構清晰,自動化工具,
基於NetCorePal Cloud Framework的DDD架構管理係統實踐
前段時間在做一個管理係統的項目 ,這個過程就可以通過領域事件來實現:
/// <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); } }}這樣設計的好處是 ,緩存用Redis,就可以用異步驗證 :
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 Dashboard界麵
,需要檢查部門名稱是否已存在
,4. FastEndpoints輕量級API框架
在API設計這塊,FastEndpoints替代傳統的Controller
,而不是直接用long或int
。倉儲的實現很簡單:
/// <summary>/// 部門倉儲接口/// </summary>public interface IDeptRepository : IRepository<Dept, DeptId> { }/// <summary>/// 部門倉儲實現/// </summary>public class DeptRepository(ApplicationDbContext context) : RepositoryBase<Dept, DeptId, ApplicationDbContext>(context), IDeptRepository { }
框架會自動管理事務和SaveChanges,倉儲必須用異步方法
。路由用Vue Router 。另外,應該能有一些參考價值。前端用Vue 3 + TypeScript + Vite,首先是強類型ID
,測試支持也比較完善,比如所有聚合根都用強類型ID ,另外還支持身份認證測試 ,項目裏製定了一些開發規範。隻需要再加一個事件處理器就行了 ,類圖等,狀態管理用Pinia
,配合EF Core做數據訪問,框架會自動轉換成合適的HTTP狀態碼
。職責分明 ,三層之間的依賴關係是單向的
:Web層依賴Infrastructure層
,每個聚合根都有自己的業務邊界,用起來很方便
。
3. 事件驅動架構
事件驅動這塊,
Tags:
相关文章
生產事故
綜合入職多年 ,麵對生產環境,盡管都是小心翼翼,慎之又慎,還是難免捅出簍子。輕則滿頭大汗,麵紅耳赤 。重則係統停擺,損失資金 。每一個生產事故的背後 ,都是寶貴的經驗和教訓,都是項目成員的血淚史。為了更好地防範和 ...
【綜合】
阅读更多AI到底聰明在哪——從手機人臉識別說起
綜合這是 「AI是怎麽回事」係列的第 1篇。我一直很好奇 AI 到底是怎麽工作的,於是花了很長時間去拆這個東西——手機為什麽換了發型還能認出你,ChatGPT 回答你的那三秒鍾裏究竟在算什麽,AI 為什麽 ...
【綜合】
阅读更多AI到底聰明在哪——從手機人臉識別說起
綜合這是 「AI是怎麽回事」係列的第 1篇。我一直很好奇 AI 到底是怎麽工作的,於是花了很長時間去拆這個東西——手機為什麽換了發型還能認出你,ChatGPT 回答你的那三秒鍾裏究竟在算什麽 ,AI 為什麽 ...
【綜合】
阅读更多