TJC.Cyclops.ApprovalFlow 2026.5.11.1

Cyclops.ApprovalFlow

🔄 灵活强大的审批流程引擎 🔄

Cyclops.ApprovalFlow 是企服版框架中的审批流开发套件，提供灵活、可扩展的工作流管理能力。该项目采用图论模型设计，通过节点和边的组合构建复杂的审批流程，支持多种节点类型和流转逻辑，为企业应用提供强大的业务流程管理支持。

🌟 核心特性

• 图式流程定义：基于图论的流程模型，通过节点和边的组合构建复杂审批流程
• 多样化节点类型：支持开始节点、服务节点、用户节点、网关节点、结束节点等多种节点类型
• 会签聚合策略：支持自动通过、全票通过、任一人通过、过半通过、百分比通过等多种聚合模式
• 灵活的流转逻辑：支持条件流转、并行分支、串行审批等复杂流程场景
• 可视化流程设计：支持流程的可视化配置和管理
• 流程监控：实时监控流程执行状态和进度
• 自动推进机制：根据预设规则自动推进流程，提高审批效率
• 可扩展的节点处理器：支持自定义节点处理逻辑
• 完整的事件系统：提供流程生命周期事件，便于集成业务逻辑

🛠️ 技术栈

• 开发框架：.NET 8.0
• 项目类型：类库（Class Library）
• 核心依赖：
  • Cyclops.Common：提供通用工具类支持
  • Cyclops.DI：提供依赖注入能力

📦 安装

dotnet add package Cyclops.ApprovalFlow

🚀 快速开始

1. 从JSON文件加载流程定义

using Cyclops.ApprovalFlow;

// 创建流程构建器实例
var flowBuilder = new FlowBuilder();

// 从JSON文件加载流程定义
string jsonPath = "path/to/your/flowdefinition.json";
var executor = await flowBuilder.CreateExecutorFromJsonFileAsync(jsonPath);

2. 从JSON字符串加载流程定义

using Cyclops.ApprovalFlow;

// 创建流程构建器实例
var flowBuilder = new FlowBuilder();

// 流程定义JSON字符串
string flowJson = @"{
  ""key"": ""LeaveApprovalFlow"",
  ""name"": ""请假审批流程"",
  ""nodes"": [
    {
      ""id"": ""start"",
      ""type"": ""start-node"",
      ""text"": { ""value"": ""开始"" }
    },
    {
      ""id"": ""manager-approval"",
      ""type"": ""user-node"",
      ""text"": { ""value"": ""经理审批"" },
      ""properties"": {
        ""assignee"": ""manager""
      }
    },
    {
      ""id"": ""end"",
      ""type"": ""end-node"",
      ""text"": { ""value"": ""结束"" }
    }
  ],
  ""edges"": [
    {
      ""id"": ""edge1"",
      ""sourceNodeId"": ""start"",
      ""targetNodeId"": ""manager-approval"",
      ""text"": { ""value"": ""提交"" }
    },
    {
      ""id"": ""edge2"",
      ""sourceNodeId"": ""manager-approval"",
      ""targetNodeId"": ""end"",
      ""text"": { ""value"": ""通过"" }
    }
  ]
}";

// 从JSON字符串加载流程定义
var executor = await flowBuilder.CreateExecutorFromJsonStringAsync(flowJson, "LeaveApprovalFlow");

3. 初始化并启动流程引擎

using Cyclops.ApprovalFlow;

// 初始化流程引擎
var flowEngine = FlowEngine.Instance;

// 启动流程引擎
await flowEngine.StartAsync();

📋 节点类型说明

🔄 会签聚合策略

用户节点支持会签模式，提供以下聚合策略：

📁 项目结构

Cyclops.ApprovalFlow/
├── Core/                          # 核心引擎与处理器
│   ├── ApprovalFlowEngine.cs      # 审批流引擎
│   ├── AggregationEvaluator.cs    # 会签聚合评估器
│   ├── RuleEngine.cs              # 规则引擎
│   ├── FlowExecutor.cs            # 流程执行器
│   ├── Handlers/                  # 节点处理器
│   │   ├── BaseNodeHandler.cs     # 处理器基类
│   │   ├── StartNodeHandler.cs    # 开始节点处理器
│   │   ├── EndNodeHandler.cs      # 结束节点处理器
│   │   ├── UserNodeHandler.cs     # 用户节点处理器
│   │   ├── TaskNodeHandler.cs     # 服务节点处理器
│   │   ├── GatewayNodeHandler.cs  # 网关节点处理器
│   │   └── HttpNodeHandler.cs     # HTTP节点处理器
│   ├── FlowEventBusPublisher.cs   # 事件总线发布器
│   └── FlowMonitor.cs             # 流程监控器
├── Consts/                        # 常量定义
│   ├── ConstNodeType.cs           # 节点类型常量
│   ├── ConstAggregationType.cs    # 聚合策略常量
│   └── ConstTaskNodeStatus.cs     # 服务节点状态常量
├── Models/                        # 模型定义
│   ├── GraphNode.cs               # 图节点
│   ├── GraphEdge.cs               # 图边
│   └── FlowRuntimeState.cs        # 流程运行时状态
├── Data/                          # 示例数据
│   └── exampleData.json           # 采购审批流程示例
└── README.md                      # 项目说明

🔧 配置说明

用户节点属性配置

{
  "className": "PurchaseService",
  "methodName": "OnDeptManagerApprove",
  "roleId": 1300000000101,
  "roleName": "部门负责人",
  "stage": "初审",
  "multiApproval": true,
  "aggregationType": "any_approve",
  "approvePercentage": 60,
  "assignees": [
    {
      "type": "user",
      "userId": 101,
      "userName": "张经理",
      "account": "zhangmanager"
    },
    {
      "type": "role",
      "roleId": 1300000000102,
      "roleName": "大区经理"
    }
  ],
  "events": {
    "onNodeEnter": [...],
    "onNodeLeave": [...],
    "onApprovalAction": [...]
  }
}

服务节点属性配置

{
  "className": "PurchaseService",
  "methodName": "CreatePurchaseRequest",
  "formModelName": "DbPurchaseRequest",
  "formModelField": "id",
  "formModelFieldValue": "${recordId}",
  "resultMapping": [
    { "source": "response.purchaseId", "target": "Variables.purchaseId" }
  ],
  "events": {
    "onNodeEnter": [...],
    "onNodeLeave": [...]
  }
}

📝 注意事项

1. 节点类型标识：前端和后端的节点类型标识必须保持一致
2. 会签配置：开启会签时必须指定聚合策略，百分比通过时需设置通过比例
3. 服务节点：className 和 methodName 为必填项，用于反射调用目标服务
4. 事件配置：支持 HTTP 回调，可配置同步/异步执行、重试次数等参数

📄 许可证

MIT License