KingbaseES客户端编程开发框架-Activiti.pdf

KingbaseES 客户端编程开发框架-Activiti 金仓数据库管理系统 KingbaseES 文档版本：V9（V009R001C001B0024） 发布日期：2023 年 10 月 12 日 北京人大金仓信息技术股份有限公司 目 目 录 录 第 1 章 前言 1 1.1 适用读者 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 1.2 相关文档 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 1.3 术语 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 1.4 手册约定 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 第 2 章 概述 3 2.1 Activiti 工作流简介 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 2.2 Activiti 驱动包 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 第 3 章 Activiti 环境配置说明 4 3.1 数据库连接配置 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 3.2 建表文件 5 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 第 4 章 SpringBoot 整合 Activiti 配置说明 6 版权声明 9 服务周期承诺 10 I 第 1 章 前言 1 第 章 前言 本文档描述了 KingbaseES 对 Activiti 的支持情况，以及 Activiti 的相关配置和使用说明。 前言部分包含以下主题： • 适用读者 • 相关文档 • 术语 • 手册约定 1.1 适用读者 《KingbaseES Activiti 指南》面向所有使用 KingbaseES 数据库进行客户端编程开发的用户，主要是使用 Activiti 的开发人员。 1.2 相关文档 有关 Activiti 的更多信息，请参阅以下资源： 《Activiti & Activiti Cloud Developers Guide》 1.3 术语 无。 1 第 1 章 前言 1.4 手册约定 本文档中可能出现“注意、提示、警告、另请参阅”等标志，它们所代表的含义如下： 注意: 用于突出重要/关键信息、最佳实践等。 提示: 用于突出小窍门、捷径等。 警告: 用于传递设备或环境安全警示信息，若不避免，可能会导致设备损坏、数据丢失、设备性能降低或其 它不可预知的结果。 另请参阅: 用于突出参考、参阅等。 以下程序代码书写约定适用于本文档： 符号 说明 [] 表示包含一个或多个可选项。不需要输入中括号本身。 {} 表示包含两个以上（含两个）的候选，必须在其中选取一个。不需要输入花括号本身。 | 分割中括号或者花括号中的两个或两个以上选项。不需要输入“|”本身。 ... 表示其之前的元素可以被重复。 斜体 表示占位符或者需要提供特定值的变量。 大写 表示系统提供的元素，以便与用户定义的元素相互区分。除出现在方括号中的元素外，应当按 照顺序逐字输入。当然，部分元素在系统中是大小写不敏感的，因此用户可以根据系统说明以 小写形式输入。 小写 表示由用户提供的元素。 2 第 2 章 概述 2 第 章 概述 本部分简单介绍了 Activiti 的兼容情况和驱动包的使用。 本部分包含以下章节： • Activiti 工作流简介 • Activiti 驱动包 2.1 Activiti 工作流简介 Activiti 是一个覆盖了业务流程管理、工作流、服务协作等领域的开源的、灵活的、易扩展的可执行流程语言框 架。 KingbaseES 已兼容至 Activiti7。 2.2 Activiti 驱动包 Activiti 的 jar 包及其依赖包可以从官方网站下载，也可以通过 maven 导入。 KingbaseES 有两种形态的驱动包： • （推荐）Postgre 形态：postgresql-42.2.9.jar，无需配置，替换后修改连接信息即可； • （不推荐）KingbaseES 形态：kingbase8-9.0.0.jar，需要配置 databaseType。SpringBoot 整合时，整合包未提 供 databaseType，修改配置较为繁琐。在使用多数据源时，同时配置 PG 原生的数据源和 KES 的数据源时， 只能使用该方式，其它情况均不推荐。 驱动包均可以从 KingbaseES 官网下载获取。 3 第 3 章 ACTIVITI 环境配置说明 3 第 章 Activiti 环境配置说明 本部分介绍了使用 Activiti 时需要的环境配置操作。 本部分包含以下章节： • 数据库连接配置 • 建表文件 3.1 数据库连接配置 Activiti 的配置信息可以通过配置文件配置，也可以直接在代码中进行配置，以下是两种方式的举例。 a. Activiti 使用配置文件配置连接信息，创建工作流需要的表。 在 activiti.cfg.xml 中增加如下声明： （KingbaseES 形态） （Postgre 形态） 4 第 3 章 ACTIVITI 环境配置说明 配置时根据实际情况修改”jdbcDriver” 、”jdbcUrl” 、”databaseType” 即可。 b. Activiti 使用代码配置连接信息，创建工作流需要的表。 @Test public void createTable(){ ProcessEngineConfiguration processEngineConfiguration = ProcessEngineConfiguration.createStandaloneProcessEngineConfiguration(); processEngineConfiguration.setJdbcDriver("org.postgresql.Driver"); processEngineConfiguration.setJdbcUrl( "jdbc:postgresql://localhost:54321/test"); processEngineConfiguration.setJdbcUsername("test"); processEngineConfiguration.setJdbcPassword("test"); processEngineConfiguration.setDatabaseType("postgres"); processEngineConfiguration.setDatabaseSchemaUpdate( ProcessEngineConfiguration.DB_SCHEMA_UPDATE_TRUE); ProcessEngine processEngine = processEngineConfiguration.buildProcessEngine(); } 配置时根据实际情况修改以下参数： 1. processEngineConfiguration.setJdbcDriver 2. processEngineConfiguration.setJdbcUrl 3. processEngineConfiguration.setDatabaseType 您还可以前往 人大金仓官网 下载 Activiti 测试用例 。 3.2 建表文件 KingbaseES 兼容 Activiti 的核心，使用的是 PG 的建表语句。详细请参考：Getting Started with Activiti Core Runtime APIs 。 5 第 4 章 SPRINGBOOT 整合 ACTIVITI 配置说明 4 第 章 SpringBoot 整合 Activiti 配置说明 SpringBoot 整合 Activiti 的包 activiti-spring-boot-starter-basic 中，未提供对参数 databaseType 的设置，所以 需要对配置方式进行扩展。 a. 在 ActivitiDatasourceProperties.java 中添加新增的配置参数： package com.example.activiti.config; import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.stereotype.Component; @ConfigurationProperties(prefix = "spring.activiti") @Component public class ActivitiDatasourceProperties { private String databaseType; public String getDatabaseType() { return databaseType; } public void setDatabaseType(String databaseType) { this.databaseType = databaseType; } } b. 新建一个类继承 AbstractProcessEngineAutoConfiguration 类，实现 springProcessEngineConfiguration 方法， 在 SpringProcessEngineConfiguration 对象上设置需要新增的配置参数： package com.example.activiti.config; import java.io.IOException; import javax.sql.DataSource; 6 第 4 章 SPRINGBOOT 整合 ACTIVITI 配置说明 import org.activiti.spring.SpringAsyncExecutor; import org.activiti.spring.SpringProcessEngineConfiguration; import org.activiti.spring.boot.AbstractProcessEngineAutoConfiguration; import org.activiti.spring.boot.ActivitiProperties; import org.activiti.spring.boot.JpaProcessEngineAutoConfiguration; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.autoconfigure.AutoConfigureAfter; import org.springframework.boot.autoconfigure.AutoConfigureBefore; import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration; import org.springframework.boot.context.properties.EnableConfigurationProperties; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.transaction.PlatformTransactionManager; @Configuration @AutoConfigureAfter({ DataSourceAutoConfiguration.class }) @AutoConfigureBefore({ JpaProcessEngineAutoConfiguration.class }) public class ActivitiConfig { @Configuration @EnableConfigurationProperties({ ActivitiProperties.class }) public static class ActivitiConfiguration extends AbstractProcessEngineAutoConfiguration { private ActivitiDatasourceProperties activitiDatasourceProperties; public ActivitiDatasourceProperties getActivitiDatasourceProperties() { return activitiDatasourceProperties; } @Autowired public void setActivitiDatasourceProperties( ActivitiDatasourceProperties activitiDatasourceProperties) { this.activitiDatasourceProperties = activitiDatasourceProperties; } @Bean @ConditionalOnMissingBean public SpringProcessEngineConfiguration springProcessEngineConfiguration(DataSource dataSource, PlatformTransactionManager transactionManager, SpringAsyncExecutor springAsyncExecutor) throws IOException { SpringProcessEngineConfiguration config = baseSpringProcessEngineConfiguration(dataSource, 7 第 4 章 SPRINGBOOT 整合 ACTIVITI 配置说明 transactionManager, springAsyncExecutor); config.setDatabaseType(this.activitiDatasourceProperties.getDatabaseType()); return config; } } } c. 在 SpringBoot 的配置文件中，添加数据库类型的设置： spring.activiti.database-type=postgres 注意 使用 KingbaseES 适配 Activiti 时，如果使用 Postgre 形态的驱动，直接使用即可。如果使用 KingbaseES 形态 的驱动，需要配置 databaseType 为 postgres： 8 版权声明 版权声明 北京人大金仓信息技术股份有限公司（简称：人大金仓）版权所有，并保留对本手册及本声明的一切权利。 未得到人大金仓的书面许可，任何人不得以任何方式或形式对本手册内的任何部分进行复制、摘录、备份、修 改、传播、翻译成其他语言、将其全部或部分用于商业用途。 免责声明 本手册内容依据现有信息制作，由于产品版本升级或其他原因，其内容有可能变更。人大金仓保留在没有任何通 知或者提示的情况下对手册内容进行修改的权利。 本手册仅作为使用指导，人大金仓在编写本手册时已尽力保证其内容准确可靠，但并不确保手册内容完全没有错 误或遗漏，本手册中的所有信息也不构成任何明示或暗示的担保。 技术支持 • 人大金仓官方网站：http://www.kingbase.com.cn/ • 人大金仓文档中心：http://help.kingbase.com.cn/ • 全国服务热线：400-601-1188 • 人大金仓技术支持与反馈信箱：support@kingbase.com.cn 9 服务周期承诺 服务周期承诺 由于市场需求在不断变化，技术创新和发展的进程不断加剧，产品的版本更迭不可避免。人大金仓对于产品版本 生命周期的有效管理，有助于您提前规划项目，更好地从产品服务终止上过渡。 表 1: KingbaseES 产品生命周期里程碑 关键里程碑点 定义 产品发布日期 产品正式发布版本，即 GA（general availability）版本的发布日期。 停止销售日期 正式停止销售的日期，版本停止接受订单日。该日之后，产品将不再销售。 停止功能升级日期 在该日期之后，不再提供新特性和新硬件支持。但依旧提供错误修复、安全修复、功 能维护等服务。 停止功能维护日期 在该日期之后，不再维护功能，修复问题。但依旧提供安全修复等服务 停止安全维护日期 在该日期之后，不再发布补丁版本修复中高风险漏洞，仅提供有限的支持。 产品服务终止日期 停止提供产品服务和支持的日期。包括软件维护版本，缺陷修复，以及针对该产品的 所有服务支持（包括服务热线和远程/现场支持）。 服务周期策略 金仓数据库管理系统 KingbaseES 产品确保以下的服务周期： 1）产品自发布之日起至产品停止功能升级（包含新特性、新硬件支持）之日不少于 5 年。 2）产品停止功能升级之日起至产品停止功能维护（主要包括问题修复）之日不少于 4 年。 3）产品功能维护停止之日起至产品停止安全维护（包括中高风险漏洞修复）之日不少于 2 年。 服务终止策略 金仓数据库管理系统 KingbaseES 产品确保在销售后，至少提供 6 年的服务支持。 注意: 人大金仓将会综合各方因素来确定产品服务终止日期。并将在实际产品服务终止日期之前至少 90 天，通过公 10 服务周期承诺 开方式宣布产品服务终止日期。 11