基于 Clean Architecture + DDD 的轻量级工作流系统实践

基于 Clean Architecture + DDD 的轻量级工作流系统实践

本文介绍在一个 .NET 10 + Vue 3 的后台管理系统（Ncp.Admin）中，如何基于现有的 Clean Architecture + DDD 架构，从零构建一套轻量级审批工作流系统，涵盖后端领域建模、CQRS 命令查询、领域事件驱动的业务自动化，以及前端可视化流程节点设计器的完整实现。

一、项目背景与技术栈

Ncp.Admin 是一套采用 Clean Architecture 分层架构的后台管理系统，技术栈如下：
层级技术选型前端Vue 3 + Vite + Ant Design Vue (Vben Admin)API 层ASP.NET Core + FastEndpoints应用层MediatR (CQRS)、FluentValidation领域层DDD 聚合根、领域事件、强类型 ID基础设施EF Core + Pomelo MySQL、Redis、CAP、Hangfire项目已经有完善的用户、角色、部门、权限管理模块。本次需求是在现有架构基础上，增加一套 审批工作流系统，支持流程定义、流程发起、多级审批、驳回、转办等能力，并实现 "新增用户需走审批流程" 的业务闭环。
二、为什么不用 Elsa Workflows？

在技术选型阶段，我们对比了 Elsa Workflows 和自建方案：
维度Elsa Workflows自建方案功能丰富度自带可视化设计器、条件分支、定时触发等按需实现，功能精简学习成本需理解 Elsa 活动模型、序列化机制复用现有 DDD 模式，团队零成本架构耦合引入独立的持久化层和运行时完全融入现有分层架构前端集成自带 Blazor/React 设计器，与 Vue 生态不匹配原生 Vue 3 + Ant Design Vue数据库默认 SQLite，MySQL 支持需额外配置复用现有 EF Core + MySQL.NET 版本Elsa 3.x 对 .NET 10 的兼容性需验证无兼容性风险最终选择了 自建方案 —— 对于审批类工作流，核心逻辑并不复杂，而自建方案可以完美融入现有 DDD 架构，代码风格统一，维护成本更低。
三、领域模型设计

3.1 聚合根划分

工作流系统划分为两个聚合：

1. WorkflowDefinition (流程定义聚合)
2. ├── WorkflowDefinitionId    // 强类型 ID
3. ├── Name / Description / Category
4. ├── Status (Draft → Published → Archived)
5. ├── Version
6. ├── Nodes: ICollection<WorkflowNode>  // 流程节点（值对象集合）
7. └── 领域方法: Publish(), Archive(), GetFirstApprovalNode(), GetNextApprovalNode()
9. WorkflowInstance (流程实例聚合)
10. ├── WorkflowInstanceId      // 强类型 ID
11. ├── WorkflowDefinitionId    // 关联定义
12. ├── BusinessKey / BusinessType
13. ├── Status (Running → Completed/Rejected/Cancelled)
14. ├── Variables               // 业务数据 JSON
15. ├── Tasks: ICollection<WorkflowTask>   // 审批任务集合
16. └── 领域方法: CreateTask(), ApproveTask(), RejectTask(), TransferTask(), Complete()

复制代码

3.2 强类型 ID

与项目现有模式一致，所有聚合根使用强类型 ID：

1. public partial record WorkflowDefinitionId : IGuidStronglyTypedId;
2. public partial record WorkflowInstanceId : IGuidStronglyTypedId;

复制代码

3.3 流程定义聚合根

WorkflowDefinition 是流程模板的聚合根，封装了状态管理和 流程流转的领域逻辑：

1. public class WorkflowDefinition : Entity<WorkflowDefinitionId>, IAggregateRoot
2. {
3.     public WorkflowDefinitionStatus Status { get; private set; }
4.     public virtual ICollection<WorkflowNode> Nodes { get; init; } = [];
6.     // 状态变更 + 领域事件
7.     public void Publish()
8.     {
9.         if (Status == WorkflowDefinitionStatus.Published)
10.             throw new KnownException("流程定义已经发布", ErrorCodes.WorkflowDefinitionAlreadyPublished);
12.         Status = WorkflowDefinitionStatus.Published;
13.         AddDomainEvent(new WorkflowDefinitionPublishedDomainEvent(this));
14.     }
16.     // 流程流转逻辑下沉到聚合根（而非 Handler）
17.     public WorkflowNode? GetFirstApprovalNode()
18.         => GetOrderedApprovalNodes().FirstOrDefault();
20.     public WorkflowNode? GetNextApprovalNode(string currentNodeName)
21.     {
22.         var orderedNodes = GetOrderedApprovalNodes();
23.         var currentIndex = orderedNodes.ToList().FindIndex(n => n.NodeName == currentNodeName);
24.         return (currentIndex >= 0 && currentIndex < orderedNodes.Count - 1)
25.             ? orderedNodes[currentIndex + 1]
26.             : null;
27.     }
28. }

复制代码

DDD 要点：流转逻辑（获取首节点、下一节点）放在 WorkflowDefinition 聚合根而非 Command Handler 中。Handler 只负责编排调度，领域逻辑由聚合根保护。

3.4 流程实例聚合根

WorkflowInstance 管理一次具体的审批流程执行：

1. public class WorkflowInstance : Entity<WorkflowInstanceId>, IAggregateRoot
2. {
3.     public string Variables { get; private set; } = "{}"; // 业务数据 JSON
5.     public WorkflowTask CreateTask(string nodeName, WorkflowTaskType taskType,
6.         UserId assigneeId, string assigneeName)
7.     {
8.         var task = new WorkflowTask(nodeName, taskType, assigneeId, assigneeName);
9.         Tasks.Add(task);
10.         CurrentNodeName = nodeName;
11.         AddDomainEvent(new WorkflowTaskCreatedDomainEvent(this, task));
12.         return task;
13.     }
15.     public void ApproveTask(WorkflowTaskId taskId, UserId operatorId, string comment)
16.     {
17.         var task = Tasks.FirstOrDefault(t => t.Id == taskId)
18.             ?? throw new KnownException("未找到该任务", ErrorCodes.WorkflowTaskNotFound);
19.         task.Approve(comment);
20.         AddDomainEvent(new WorkflowTaskCompletedDomainEvent(this, task));
21.     }
23.     public void Complete()
24.     {
25.         Status = WorkflowInstanceStatus.Completed;
26.         CompletedAt = DateTimeOffset.UtcNow;
27.         AddDomainEvent(new WorkflowInstanceCompletedDomainEvent(this));
28.     }
29. }

复制代码

四、CQRS 命令与查询

4.1 发起流程命令

StartWorkflowCommand 演示了 Handler 如何 编排 聚合根交互：

1. public class StartWorkflowCommandHandler(
2.     IWorkflowDefinitionRepository definitionRepository,
3.     IWorkflowInstanceRepository instanceRepository)
4.     : ICommandHandler<StartWorkflowCommand, WorkflowInstanceId>
5. {
6.     public async Task<WorkflowInstanceId> Handle(StartWorkflowCommand request, CancellationToken ct)
7.     {
8.         var definition = await definitionRepository.GetAsync(request.WorkflowDefinitionId, ct)
9.             ?? throw new KnownException("未找到流程定义");
11.         // 创建实例
12.         var instance = new WorkflowInstance(
13.             request.WorkflowDefinitionId, definition.Name,
14.             request.BusinessKey, request.BusinessType,
15.             request.Title, request.InitiatorId, request.InitiatorName,
16.             request.Variables, request.Remark);
18.         await instanceRepository.AddAsync(instance, ct);
20.         // 通过聚合根领域方法获取第一个审批节点（逻辑在 Definition 中）
21.         var firstNode = definition.GetFirstApprovalNode();
22.         if (firstNode != null && long.TryParse(firstNode.AssigneeValue, out var id))
23.         {
24.             instance.CreateTask(firstNode.NodeName, WorkflowTaskType.Approval,
25.                 new UserId(id), string.Empty);
26.         }
28.         return instance.Id;
29.     }
30. }

复制代码

4.2 审批命令 — 自动流转

1. public class ApproveTaskCommandHandler(
2.     IWorkflowInstanceRepository instanceRepository,
3.     IWorkflowDefinitionRepository definitionRepository) : ICommandHandler
4. {
5.     public async Task Handle(ApproveTaskCommand request, CancellationToken ct)
6.     {
7.         var instance = await instanceRepository.GetAsync(request.WorkflowInstanceId, ct);
8.         instance.ApproveTask(request.TaskId, request.OperatorId, request.Comment);
10.         var definition = await definitionRepository.GetAsync(instance.WorkflowDefinitionId, ct);
11.         var approvedTask = instance.Tasks.First(t => t.Id == request.TaskId);
13.         // 领域方法：获取下一节点
14.         var nextNode = definition.GetNextApprovalNode(approvedTask.NodeName);
16.         if (nextNode != null)
17.         {
18.             // 创建下一个审批任务
19.             instance.CreateTask(nextNode.NodeName, WorkflowTaskType.Approval, ...);
20.         }
21.         else
22.         {
23.             // 所有节点审批完毕，流程完成
24.             instance.Complete();
25.         }
26.     }
27. }

复制代码

五、领域事件驱动的业务自动化

5.1 领域事件定义

1. public record WorkflowDefinitionPublishedDomainEvent(WorkflowDefinition WorkflowDefinition) : IDomainEvent;
2. public record WorkflowInstanceStartedDomainEvent(WorkflowInstance WorkflowInstance) : IDomainEvent;
3. public record WorkflowInstanceCompletedDomainEvent(WorkflowInstance WorkflowInstance) : IDomainEvent;
4. public record WorkflowTaskCreatedDomainEvent(WorkflowInstance WorkflowInstance, WorkflowTask WorkflowTask) : IDomainEvent;
5. public record WorkflowTaskCompletedDomainEvent(WorkflowInstance WorkflowInstance, WorkflowTask WorkflowTask) : IDomainEvent;

复制代码

5.2 审批通过后自动执行业务操作

这是整个系统的亮点设计 —— 通过领域事件实现 流程与业务的解耦：

1. public class WorkflowInstanceCompletedDomainEventHandler(IMediator mediator, RoleQuery roleQuery)
2.     : IDomainEventHandler<WorkflowInstanceCompletedDomainEvent>
3. {
4.     public async Task Handle(WorkflowInstanceCompletedDomainEvent domainEvent, CancellationToken ct)
5.     {
6.         var instance = domainEvent.WorkflowInstance;
7.         if (instance.Status != WorkflowInstanceStatus.Completed) return;
9.         switch (instance.BusinessType)
10.         {
11.             case "CreateUser":
12.                 await HandleCreateUser(instance, ct);
13.                 break;
14.             // 后续可扩展：case "PurchaseOrder": ...
15.         }
16.     }
18.     private async Task HandleCreateUser(WorkflowInstance instance, CancellationToken ct)
19.     {
20.         // 从 Variables JSON 中反序列化用户数据
21.         var userData = JsonSerializer.Deserialize<CreateUserVariables>(instance.Variables);
23.         // 复用现有的 CreateUserCommand
24.         var cmd = new CreateUserCommand(
25.             userData.Name, userData.Email, userData.Password, ...);
26.         await mediator.Send(cmd, ct);
27.     }
28. }

复制代码

设计思想：前端提交审批时，将完整的业务数据（如用户信息）序列化为 JSON 存入 Variables 字段。审批通过后，领域事件处理器从 Variables 中反序列化数据，调用对应的业务 Command 完成操作。这样 工作流引擎本身不需要了解任何业务细节，新增业务类型只需在 switch 中扩展即可。

六、前端可视化节点设计器

6.1 设计思路

传统的做法是让用户编辑 JSON 来配置流程节点，这显然不够友好。我们实现了一个 基于竖向流程图的可视化节点设计器：

1.     [▶ 开始]
2.        │
3.        ↓
4.   ┌──────────────┐
5.   │ ✓ 主管审批     │  ← 可编辑卡片
6.   │ 类型: 审批     │
7.   │ 处理人: 张三   │
8.   └──────────────┘
9.        │
10.       (+)           ← 点击插入新节点
11.        │
12.   ┌──────────────┐
13.   │ ✓ 总监审批     │
14.   │ 类型: 审批     │
15.   │ 处理人: 李四   │
16.   └──────────────┘
17.        │
18.        ↓
19.     [■ 结束]

复制代码

6.2 组件实现

node-designer.vue 是一个完整的 Vue 3 组件，核心设计如下：
交互能力：

• 添加节点（顶部、中间、底部均可插入）
  
• 删除节点（带 Popconfirm 二次确认）
  
• 上下移动节点（调整审批顺序）
  
• 配置节点属性（名称、类型、处理人类型、处理人）
  
• 已发布流程只读，不可编辑
  

视觉设计：

• 开始/结束节点使用渐变色圆形标识
  
• 节点卡片顶部彩色色条标识类型（蓝色=审批、绿色=抄送、橙色=通知）
  
• 连接线带有方向箭头
  
• 悬浮动效（卡片微浮、操作按钮渐显、添加按钮缩放高亮）
  
• 表单双列布局节省空间
  

核心代码片段：
[code]// 节点类型视觉配置const nodeTypeConfig: Record = {  1: { color: '#1677ff', bg: '#e6f4ff', icon: '✓' },  // 审批  2: { color: '#52c41a', bg: '#f6ffed', icon: '
来源：程序园用户自行投稿发布，如果侵权，请联系站长删除
免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！

感谢分享，下载保存了，貌似很强大

这个好，看起来很实用

鼓励转贴优秀软件安全工具和文档！

鼓励转贴优秀软件安全工具和文档！

鼓励转贴优秀软件安全工具和文档！

收藏一下   不知道什么时候能用到

这个好，看起来很实用

分享、互助 让互联网精神温暖你我

谢谢分享，辛苦了

yyds。多谢分享

新版吗？好像是停更了吧。

热心回复！