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