# xpflow **Repository Path**: creekmoon/xpflow ## Basic Information - **Project Name**: xpflow - **Description**: Xpflow 是一个轻量级的业务流程管理器,它可以帮助你快速搭建业务流程. - **Primary Language**: Java - **License**: Apache-2.0 - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2025-03-20 - **Last Updated**: 2025-10-22 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # Xpflow 轻量业务流程管理器 ## 介绍 Xpflow 是一个轻量级的业务流程管理器,它可以帮助你快速搭建业务流程, 并提供基础(不是很强大也可以说是非常简陋)的流程控制功能。 ## 特点 - **轻量级设计**:易于集成到现有的Spring Boot项目中, 仅依赖于spring-JdbcTemplate实现持久化. - **简单配置**:通过YAML配置文件快速定义流程节点和规则 - **灵活控制**:支持节点依赖关系、条件执行和回滚操作 - **多节点策略**:支持节点的重复执行、限制执行和条件触发 - **异步处理**:支持流程节点的异步后处理 ## 安装方法 ### Maven依赖 将Xpflow添加到你的项目中: ```xml cn.creekmoon xpflow 0.0.1 ``` ### 环境依赖 依赖于Spring boot 的 **jdbcTemplate** (目前仅提供mysql实现) ```yaml spring: datasource: driver-class-name: com.mysql.cj.jdbc.Driver url: jdbc:mysql://127.0.0.1:3306/xpflow username: root password: 123456 ``` ## 快速入门 ### 配置流程节点 > 这里介绍一下两个概念 **节点(node)** 和 **模板(template)** > > 节点: 节点是一种业务里程碑状态. 其中**id是全局唯一**的, 节点name只作为名称显示 > 模板: 模板是多个节点组成的有序集合. 其中**primary-type是全局唯一**的 例如在`application.yaml`中定义了两套流程 processA 和 processB , 它们实际上复用了所有的节点, 通过自由排列组合完成业务. ```yaml xpflow: nodes: - id: 1 name: 入园 - id: 2 name: 卸货 - id: 3 name: 卸货完成 - id: 4 name: 出园 - id: 5 name: 到达 templates: - primary-type: processA chain: 1->2->4 - primary-type: processB chain: 1->2->3->4->5 ``` ### 执行流程节点 ```java @Autowired NodeCoreManager nodeCoreManager; String primaryType = "processA"; Long primaryId = 1L; // 初始化流程 nodeCoreManager.initAllNodes(primaryType, primaryId); // 执行节点 nodeCoreManager.execNode(primaryType, primaryId, nodeId, null); // 获取流程信息(已经执行的节点,下一步可执行的节点等) XpflowEnvironment environment = nodeCoreManager.getEnvironment(primaryType, primaryId); ``` ## 高级特性 ### 节点处理器 > 设计目的: 核心业务的方法,触发节点时会执行指定的任务 **声明方式①** ```java @Component public class PrintUnloadingDocuments extends XpflowNodeHandler { @Override public void handle(XpFlowParamsHolder paramsHolder) { //做业务 } //重写nodeId接口匹配 @Override public Long nodeId() { return 10L; } } ``` **声明方式②** ```java //调整类名以数字结尾自动匹配 @Component public class PrintUnloadingDocuments_10 extends XpflowNodeHandler { @Override public void handle(XpFlowParamsHolder paramsHolder) { //做业务 } } ``` ### 流程后置处理器 > 设计目的: 基于流程之间的协调关系进行触发业务操作. 根据多个节点的运行状态进行编程. **同步后置处理器(XpflowPostProcessor) :** 如果同步处理器失败, 则事务会回滚. ```java @Component public class MyNodeSyncProcessor extends XpflowPostProcessor { @Override public void postProcess(XpFlowParamsHolder paramsHolder, XpflowEnvironment environment) { // 在节点执行完成后同步处理业务逻辑 log.info("同步处理节点 {} 的后置逻辑", paramsHolder.getNodeId()); } } ``` **异步后置处理(XpflowAsyncPostProcessor):** 如果异步处理器失败, 则事务**不会**回滚. 已经执行的操作不会受到影响 ```java @Component public class MyNodeAsyncProcessor extends XpflowAsyncPostProcessor { @Override public void postProcess(XpFlowParamsHolder paramsHolder, XpflowEnvironment environment) { // 在节点执行完成后异步处理业务逻辑 log.info("异步处理节点 {} 的后置逻辑", paramsHolder.getNodeId()); } } ``` 后置处理器可以访问当前节点的参数和整个流程的环境信息,非常适合用于: - 发送通知 - 更新相关系统 - 记录日志 - 触发其他业务流程 ## 配置说明 ### Xpflow的业务执行顺序 1. 使用NodeCoreManager初始化流程 2. 使用NodeCoreManager执行流程中的某个节点 3. 执行对应的NodeHandler 核心业务逻辑 4. 先执行同步处理器(按优先级顺序)同步处理器如果出现异常则事务回滚,执行失败 5. 执行完成, 将事务提交 6. 执行异步处理器(按优先级顺序)异步处理器在独立的线程池中执行,不会阻塞主流程 ### 节点重复执行策略 - **BANNED**: 禁止重复执行 - **UNLIMITED**: 不限制重复执行 - **LATEST**: 只有当前节点为最新节点时允许重复执行 ### 节点重复执行方式 - **APPEND**: 追加执行记录 - **OVERRIDE**: 覆盖现有执行记录 ## 示例 详细示例可参考测试用例: - 车辆运输流程示例:展示了从申请园区卸货到驶离园区的完整流程