ProcessEngine流程引擎
在jBPM内部通过各种服务相互作用。 服务接口可以从ProcessEngine中获得, 它是从Configuration构建的。
流程引擎是线程安全的,它可以保存在静态变量中, 甚至JNDI中或者其他重要位置。 在应用中,所有线程和请求都可以使用同一个流程引擎对象, 现在就告诉你怎么获得流程引擎。
这章中涉及到的代码和下一章中关于流程部署的代码, 都来自org.jbpm.examples.services.ServicesTest 例子。
ProcessEngine processEngine = new Configuration()
.buildProcessEngine();
上面的代码演示了如何通过classpath根目录下 默认的配置文件jbpm.cfg.xml创建一个ProcessService。 如果你要指定其他位置的配置文件, 请使用setResource()方法:
ProcessEngine processEngine = new Configuration()
.setResource("my-own-configuration-file.xml")
.buildProcessEngine();
还有其他setXxxx()方法可以获得配置内容, 例如:从InputStream中、 从xml字符串中、从InputSource中、 从URL中或者从文件(File)中。
我们可以根据流程引擎得到 下面的服务:
RepositoryService repositoryService = processEngine.getRepositoryService();
ExecutionService executionService = processEngine.getExecutionService();
TaskService taskService = processEngine.getTaskService();
HistoryService historyService = processEngine.getHistoryService();
ManagementService managementService = processEngine.getManagementService();
在配置中定义的这些流程引擎(ProcessEngine)对象, 也可以根据类型processEngine.get(Class<T>) 或者根据名字processEngine.get(String)来获得。
Deploying a process部署流程
RepositoryService包含了用来管理发布资源的所有方法。 在第一个例子中,我们会使用RepositoryService 从classpath中部署一个流程资源。
String deploymentid = repositoryService.createDeployment()
.addResourceFromClasspath("org/jbpm/examples/services/Order.jpdl.xml")
.deploy();
通过上面的addResourceFromClass方法, 流程定义XML的内容可以从文件, 网址,字符串,输入流或zip输入流中获得。
每次部署都包含了一系列资源。每个资源的内容都是一个字节数组。 jPDL流程文件都是以.jpdl.xml作为扩展名的。 其他资源是任务表单和java类。
部署时要用到一系列资源, 默认会获得多种流程定义和其他的归档类型。 jPDL发布器会自动识别后缀名是.jpdl.xml 的流程文件。
在部署过程中,会把一个id分配给流程定义。 这个id的格式为{key}-{version}, key和version之间使用连字符连接。
如果没有提供key, 会在名字的基础自动生成。 生成的key会把所有不是字母和数字的字符替换成下划线。
同一个名称只能关联到一个key, 反之亦然。
如果没有为流程文件提供版本号, jBPM会自动为它分配一个版本号。 请特别注意那些已经部署了的名字 相同的流程文件的版本号。 它会比已经部署的同一个key的流程定义 里最大的版本号还大。 没有部署相同key的流程定义的版本号会分配为1。
在下面第1个例子里,我们只提供了流程的名字,没有提供其他信息:
<process name="Insurance claim">
...
</process>
假设这个流程是第一次部署, 下面就是它的属性:
表 5.1. 没有key值的属性流程
Property Value Source
name Insurance claim process xml
key Insurance_claim generated
version 1 generated
id Insurance_claim-1 generated
第2个例子我们将演示如何通过设置流程的key 来获得更短的id。
<process name="Insurance claim" key="ICL">
...
</process>
这个流程定义的属性就会像下面这样:
表 5.2. 有key值属性的流程
Property Value Source
name Insurance claim process xml
key ICL process xml
version 1 generated
id ICL-1 generated
5.4. 删除流程定义
删除一个流程定义会把它从数据库中删除。
repositoryService.deleteDeployment(deploymentId);
如果在发布中的流程定义还存在活动的流程实例, 这个方法就会抛出异常。
如果希望级联删除一个发布中流程定义的 所有流程实例, 可以使用deleteDeploymentCascade。
5.5. 启动一个新的流程实例
5.5.1. 最新的流程实例
下面是为流程定义启动一个新的流程实例的最简单也是 最常用的方法:
ProcessInstance processInstance = executionService.startProcessInstanceByKey("ICL");
上面service的方法会去查找 key为ICL的最新版本的流程定义, 然后在最新的流程定义里启动流程实例。
当insurance claim流程部署了一个新版本, startProcessInstanceByKey方法会自动切换到 最新部署的版本。
在jBPM内部通过各种服务相互作用。 服务接口可以从ProcessEngine中获得, 它是从Configuration构建的。
流程引擎是线程安全的,它可以保存在静态变量中, 甚至JNDI中或者其他重要位置。 在应用中,所有线程和请求都可以使用同一个流程引擎对象, 现在就告诉你怎么获得流程引擎。
这章中涉及到的代码和下一章中关于流程部署的代码, 都来自org.jbpm.examples.services.ServicesTest 例子。
ProcessEngine processEngine = new Configuration()
.buildProcessEngine();
上面的代码演示了如何通过classpath根目录下 默认的配置文件jbpm.cfg.xml创建一个ProcessService。 如果你要指定其他位置的配置文件, 请使用setResource()方法:
ProcessEngine processEngine = new Configuration()
.setResource("my-own-configuration-file.xml")
.buildProcessEngine();
还有其他setXxxx()方法可以获得配置内容, 例如:从InputStream中、 从xml字符串中、从InputSource中、 从URL中或者从文件(File)中。
我们可以根据流程引擎得到 下面的服务:
RepositoryService repositoryService = processEngine.getRepositoryService();
ExecutionService executionService = processEngine.getExecutionService();
TaskService taskService = processEngine.getTaskService();
HistoryService historyService = processEngine.getHistoryService();
ManagementService managementService = processEngine.getManagementService();
在配置中定义的这些流程引擎(ProcessEngine)对象, 也可以根据类型processEngine.get(Class<T>) 或者根据名字processEngine.get(String)来获得。
Deploying a process部署流程
RepositoryService包含了用来管理发布资源的所有方法。 在第一个例子中,我们会使用RepositoryService 从classpath中部署一个流程资源。
String deploymentid = repositoryService.createDeployment()
.addResourceFromClasspath("org/jbpm/examples/services/Order.jpdl.xml")
.deploy();
通过上面的addResourceFromClass方法, 流程定义XML的内容可以从文件, 网址,字符串,输入流或zip输入流中获得。
每次部署都包含了一系列资源。每个资源的内容都是一个字节数组。 jPDL流程文件都是以.jpdl.xml作为扩展名的。 其他资源是任务表单和java类。
部署时要用到一系列资源, 默认会获得多种流程定义和其他的归档类型。 jPDL发布器会自动识别后缀名是.jpdl.xml 的流程文件。
在部署过程中,会把一个id分配给流程定义。 这个id的格式为{key}-{version}, key和version之间使用连字符连接。
如果没有提供key, 会在名字的基础自动生成。 生成的key会把所有不是字母和数字的字符替换成下划线。
同一个名称只能关联到一个key, 反之亦然。
如果没有为流程文件提供版本号, jBPM会自动为它分配一个版本号。 请特别注意那些已经部署了的名字 相同的流程文件的版本号。 它会比已经部署的同一个key的流程定义 里最大的版本号还大。 没有部署相同key的流程定义的版本号会分配为1。
在下面第1个例子里,我们只提供了流程的名字,没有提供其他信息:
<process name="Insurance claim">
...
</process>
假设这个流程是第一次部署, 下面就是它的属性:
表 5.1. 没有key值的属性流程
Property Value Source
name Insurance claim process xml
key Insurance_claim generated
version 1 generated
id Insurance_claim-1 generated
第2个例子我们将演示如何通过设置流程的key 来获得更短的id。
<process name="Insurance claim" key="ICL">
...
</process>
这个流程定义的属性就会像下面这样:
表 5.2. 有key值属性的流程
Property Value Source
name Insurance claim process xml
key ICL process xml
version 1 generated
id ICL-1 generated
5.4. 删除流程定义
删除一个流程定义会把它从数据库中删除。
repositoryService.deleteDeployment(deploymentId);
如果在发布中的流程定义还存在活动的流程实例, 这个方法就会抛出异常。
如果希望级联删除一个发布中流程定义的 所有流程实例, 可以使用deleteDeploymentCascade。
5.5. 启动一个新的流程实例
5.5.1. 最新的流程实例
下面是为流程定义启动一个新的流程实例的最简单也是 最常用的方法:
ProcessInstance processInstance = executionService.startProcessInstanceByKey("ICL");
上面service的方法会去查找 key为ICL的最新版本的流程定义, 然后在最新的流程定义里启动流程实例。
当insurance claim流程部署了一个新版本, startProcessInstanceByKey方法会自动切换到 最新部署的版本。