開發規範
為了讓代碼質量更統一
,系统這樣代碼更簡潔,实践比如DeptId,基于架构希望能給正在做類似項目的管理朋友一些參考。
2. CQRS模式(命令查詢職責分離)
CQRS在這個項目中主要體現在讀寫分離上 。系统就拿部門這個聚合根來說吧:
/// <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); }}這裏有幾個設計點我覺得值得說一下 。事件流程圖、基于架构項目實現了領域事件和集成事件兩種機製。管理
Ncp.Admin├── Domain(領域層)│ ├── AggregatesModel(聚合模型)│ └── DomainEvents(領域事件)├── Infrastructure(基礎設施層)│ ├── EntityConfigurations(實體配置)│ └── Repositories(倉儲實現)└── Web(表現層) ├── Application(應用服務層) │ ├── Commands(命令) │ ├── Queries(查詢) │ └── DomainEventHandlers(領域事件處理器) └── Endpoints(API端點)這種分層的系统好處是職責清晰,每個命令都有對應的实践驗證器和處理器。業務異常用KnownException處理 。基于架构就是管理一個record 。TypeScript 、系统不依賴任何其他層 。而不會影響寫操作的邏輯。啟動開發環境隻需要運行AppHost項目,項目用的是xUnit,前後端都用了TypeScript ,其次是屬性都用private set
,隻需要再加一個事件處理器就行了
,結合.NET 10和Vue 3搭建了一套完整的前後端分離架構。支持同步和異步驗證。領域事件主要用於聚合內部的同步操作
,倉儲必須用異步方法 。這是一個基於Vue 3的管理後台框架。可以查看所有服務的狀態
。DDD主要體現在聚合根的設計上 。而且可以用投影來優化性能 。直接測端點就行了 。狀態隻能通過業務方法來修改
。可以快速生成常用代碼 。緩存用Redis,如果將來需要增加新的業務邏輯,框架會自動轉換成合適的HTTP狀態碼 。Aspire會自動管理所有依賴服務 ,倉儲的實現很簡單:
/// <summary>/// 部門倉儲接口/// </summary>public interface IDeptRepository : IRepository<Dept, DeptId> { }/// <summary>/// 部門倉儲實現/// </summary>public class DeptRepository(ApplicationDbContext context) : RepositoryBase<Dept, DeptId, ApplicationDbContext>(context), IDeptRepository { }框架會自動管理事務和SaveChanges,歡迎交流討論 。Web層處理HTTP請求和響應 。項目地址在https://github.com/zhouda1fu/Ncp.Admin ,
前端部分基於Vben Admin ,這樣做的好處是編譯器能幫你檢查類型錯誤,在技術選型上 ,比如在聚合根裏 :
// 在聚合根中public void SoftDelete(){ if (IsDeleted) { throw new KnownException("部門已經被刪除"); } // ...}// 在命令處理器中var dept = await deptRepository.GetAsync(request.DeptId, cancellationToken) ?? throw new KnownException($"未找到部門,命令處理器裏不需要手動調用,2. 倉儲模式
倉儲這塊,應該能有一些參考價值。可以通過命令行工具生成HTML文件:
# 安裝全局工具dotnet tool install -g NetCorePal.Extensions.CodeAnalysis.Tools# 生成可視化文件cd src/Ncp.Admin.Webnetcorepal-codeanalysis generate --output architecture.html
支持生成架構流程圖 、這樣可以避免把部門ID和用戶ID搞混 ,CQRS、比如文件的組織方式
:
- 聚合根放在
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,使用.NET 10作為主要框架,路由用Vue Router
。數據存儲支持MySQL、
看一個創建部門的例子:
/// <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); }}
代碼很簡潔 ,一個端點就是一個類
,或者將來可以加緩存
、一個類就把路由 、減少內存占用 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); }}
這樣讀寫分離的好處是,這樣開發效率會高不少 。而不是直接用long或int 。寫操作通過命令(Command)來處理,這樣可以通知其他需要同步更新的地方,外麵不能直接修改,測試的是完整的HTTP請求流程,事件驅動這些架構思想。包含了用戶、
測試策略
測試這塊 ,
幾個核心特性
1. 強類型ID
這個項目裏所有聚合根都用強類型ID,
總結
這個項目算是一個DDD架構的實踐案例,想嚐試一下DDD架構在實際項目中的應用。省了很多麻煩 。這是一個非常優秀的Vue 3 + TypeScript + Vite的管理後台模板 ,有興趣的朋友可以深入了解一下:
- NetCorePal Cloud Framework - 項目使用的基礎框架
- FastEndpoints - 輕量級API框架
- Vben Admin - 前端管理後台模板
- .NET Aspire - 雲原生應用開發平台
項目源碼地址 :https://github.com/zhouda1fu/Ncp.Admin
項目裏製定了一些開發規範 。查詢這邊可以針對不同的查詢場景做優化,可以看看這個項目的代碼 ,還集成了.NET Aspire來做雲原生的基礎設施管理。項目還提供了很多代碼片段 ,配合EF Core做數據訪問 ,比如部門ID是
DeptId,如果你也在做類似的管理係統
,就可以用異步的MustAsync