Turbo 技术文档

Turbo 技术文档

turbo Turbo is a light-weight flow engine framework, support BPMN2.0. 一款轻量级流程引擎服务框架，可作为底层服务支持各类流程设计、低代码设计、工作流、服务编排等场景 项目地址: https://gitcode.com/gh_mirrors/turb/turbo

安装指南

环境要求

• 运行环境

  • JDK 1.8 或更高版本
  • MySQL 数据库

• 开发环境

  • JDK 1.8 或更高版本
  • MySQL
  • Maven 3.1+ 或更高版本
  • IntelliJ IDEA 或其他IDE

Maven 依赖

为了集成 Turbo 流程引擎，您需要将其添加到您的 pom.xml 文件中。以下是核心引擎和示例Demo的依赖项：

对于引擎核心功能，添加以下依赖：

<dependency>
    <groupId>com.didiglobal.turbo</groupId>
    <artifactId>engine</artifactId>
    <version>1.0.0</version>
</dependency>

如果您想快速开始，可以通过引入Demo依赖了解其用法（非必须）：

<dependency>
    <groupId>com.didiglobal.turbo</groupId>
    <artifactId>demo</artifactId>
    <version>1.0.0</version>
</dependency>

数据库准备

• 下载并执行提供的建表脚本 engine/src/main/resources/turbo.db.create/turbo.mysql.sql 来创建必要的数据库表结构。
• 在您的应用配置文件中（如 application.properties 或者使用Spring Boot的 application.yml），配置正确的数据库连接信息。

spring.datasource.dynamic.primary=engine
spring.datasource.dynamic.datasource.engine.type=com.alibaba.druid.pool.DruidDataSource
spring.datasource.dynamic.datasource.engine.username=your_username
spring.datasource.dynamic.datasource.engine.password=your_password
spring.datasource.dynamic.datasource.engine.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.dynamic.datasource.engine.url=jdbc:mysql://localhost:3306/turbo_db?useSSL=false&serverTimezone=UTC

项目的使用说明

快速启动

1. 配置完毕后，确保您的项目能够成功构建。
2. 使用提供的Demo服务，例如 AfterSaleServiceImpl 和 LeaveServiceImpl 作为出发点，理解如何定义流程和触发流程执行。
3. 查阅【流程定义】和【流程元素】章节以深入了解流程构建的基础知识。
4. 实现您的业务逻辑，与Turbo的流程执行服务交互。

与LogicFlow集成

• 对于前端展示与编辑流程图，推荐使用LogicFlow。
• 参考 FlowController 类及其测试用例 FlowControllerTest，学习如何通过API与后端交互，实现流程的创建、编辑与发布。
• 前端开发者应查看 turbo-client 项目，获得与Turbo后端服务集成的前端示例代码。

项目API使用文档

虽然具体API文档需要参考项目源码注释及文档，但关键步骤如下：

• 流程部署：通过API上传流程定义XML，获取部署ID。
• 启动流程：使用部署ID和所需参数启动一个流程实例。
• 执行用户任务：模拟用户操作，推进流程至下一节点。
• 查询流程实例状态：根据流程实例ID获取流程执行状态。
• 流程回滚：在允许的情况下，回退至指定流程节点。

扩展阅读：CallActivity 和 Turbo特有节点

• CallActivity 的引入允许您实现子流程调用，详细指导见 CallActivityGuide.md。
• 查阅相关文档以学习如何利用这些高级特性来构建复杂流程逻辑。

总结

Turbo流程引擎提供了一种轻量级的方式，让您的系统能够迅速地集成流程控制逻辑，无论是简单的售后审批还是复杂的业务编排。通过本指南的步骤，您可以快速熟悉其安装、配置和基本使用。深入探索API和文档，将使您能更有效地利用Turbo为您的应用程序带来强大的流程管理能力。

turbo Turbo is a light-weight flow engine framework, support BPMN2.0. 一款轻量级流程引擎服务框架，可作为底层服务支持各类流程设计、低代码设计、工作流、服务编排等场景 项目地址: https://gitcode.com/gh_mirrors/turb/turbo