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