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