1. 流程图
流程变量在整个工作流中扮演很重要的作用。例如:请假流程中有请假天数、请假原因等一些参数都为流程变量的范围。流程变量的作用域范围是只对应一个流程实例。也就是说各个流程实例的流程变量是不相互影响的。流程实例结束完成以后流程变量还保存在数据库中(存放到流程变量的历史表中)。
例如:
即:
2. 部署流程定义
/**
* this.getClass().getClassLoader().getResourceAsStream("testVariables.bpmn")从classspath根目录下加载指定名称的文件
* this.getClass().getResourceAsStream("testVariables.bpmn") 从当前包下载指定名称的文件
* this.getClass().getResourceAsSteam("/testVariables.bpmn") 从classpath根目录下加载指定名称的文件
* @throws Exception
* /
// 部署流程定义
@Test
public void deploy_inputstream() throws Exception {
InputStream inputStream = this.getClass().getResourceAsSteam("/diagrams/testVariables.bpmn");
InputStream inputStreamPng = this.getClass().getResourceAsStream("/diagrams/testVariables.png");
Deployment deployment = processEngine.getRepositoryService()
.createDeployment()
.name("审批流程(流程变量)")
.addInputStream("testVariables1.bpmn", inputStream)//指定资源名称
.addInputStream("testVariables1.png", inputStreamPng)//指定资源名称
.deploy();// 发布流程
System.out.println(deployment.getId()+" "+deployment.getName());
}
说明:
· 输入流加载资源文件的3种方式
InputStream inputStream = this.getClass().getClassLoader().getResourceAsStream("diagrams/testVariables.bpmn");
InputStream inputStreamPng = this.getClass().getClassLoader().getResourceAsStream("diagrams/testVariables.png");
InputStream inputStream = this.getClass().getClass().getResourceAsStream("testVariables.bpmn");
InputStream inputStreamPng = this.getClass().getResourceAsStream("testVariables.png");
<font color=red>*this.getClass().getClassLoader().getResourceAsStream("testVariables.bpmn")//从classpath根目录下加载指定名称的文件</font>
<font color=red>*this.getClass().getResourceAsStream("testVariables.bpmn")//从当前包下加载指定名称的文件</font>
<font color=red>*this.getClass().getResourceAsStream("/testVariables.bpmn")//从classpath根目录下加载指定名称的文</font>件
3. 启动流程实例
// 启动 流程
@Test
public void startProcess() throws Exception {
String processDefinitionKey = "myVariables";
// 在启动时设置流程变量
ProcessInstance pi = processEngine.getRuntimeService().startProcessInstanceByKey(processDefinitionKey);
System.out.println("pid:"+pi.getId());
}
4. 设置流程变量
/**设置流程变量*/
@Test
public void setVariables() {
// 获取执行的Service
TaskService taskService = processEngine.getTaskService();
// 指定办理人
String assigneeUser = "张三";
// 流程实例ID
String processInstanceId = "1101";
Task task = taskService.createTaskQuery()//创建任务查询
.taskAssignee(assigneeUser)//指定办理人
.processInstanceId(processInstanceId)//指定流程实例ID
.singleResult();
/**一:变量中存放基本数据类型*/
taskService.setVarriable(task.getId(), "请假人", "张无忌123456");// 使用流程变量的名称和流程变量的值设置流程变量,一次只能设置一个值
taskService.setVariableLocal(task.getId(),"请假天数", 6);
taskservice.setVariable(task.getId(), "请假日期", new Date());
/**二:变量中存放javabean对象,前提:让javabean对象实现implements java.io.Serializable*/
Person p = new Person();
p.setId(1L);
p.setName("翠花");
taskService.setVariable(task.getId(), "人员信息", p);
}
说明:
- 流程变量的作用域就是流程实例,所以只要设置就行了,不用管在哪个阶段设置
- 基本类型设置流程变量,在taskService中使用任务ID,定义流程变量的名称,设置流程变量的值。
3) Javabean类型设置流程变量,需要这个javabean实现了Serializable接口 - 设置流程变量的时候,向act_ru_variable这个表添加数据
5. 获取流程变量
/**获取流程变量*/
@Test
public void getVariables() {
// 获取执行的Service
TaskService taskService = processEngine.getTaskService();
// 指定办理人
String assigneeUser = "李四";
// 流程实例ID
String processInstanceId = "1101";
Task task = taskService.createTaskQuery()//创建任务查询
.taskAssignee(assigneeUser)//指定办理人
.processInstanceId(processInstanceId)//指定流程实例ID
.singleResult();
/**一: 变量中存放基本数据类型*/
String stringValue = (String) taskService.getVariable(task.getId(), "请假人");
Integer integerValue = (integer) taskService.getVariableLocal(task.getId(), "请假天数");
Date dateValue = (Date) taskService.getVariable(task.getId(), "请假日期");
System.out.println(stringValue+" "+integerValue+" "+dateValue);
/**二: 变量中存放javabean对象,前提:让javabean对象实现implements java.io.Serializable*/
/**
* 获取流程变量时注意:流程变量如果是javabean对象,除要求实现Serializable之外,
* 同时要求流程变量对象的属性不能发生变化,否则抛出异常
* 解决方案:在设置流程变量的时候,在javabean的对象中使用:
* private static final long serialVersionUID = -2452345243523452345L;
* /
Person p = (Person)taskService.getVariable(task.getId(), "人员信息");
System.out.pringln(p.getId());
System.out.println(p.getName());
}
说明:
1) 流程变量的获取针对流程实例(即1个流程),每个流程实例获取的流程变量时不同的
2) 使用基本类型获取流程变量,在taskService中使用任务ID,流程变量的名称,获取流程变量的值。
3) Javabean类型设置获取流程变量,除了需要这个javabean实现了Serializable接口外,还要求流程变量对象的属性不能发生变化,否则抛出异常。解决方案,固定序列化ID。
6. 模拟流程变量的设置和获取的场景
public void setAndGetvariables() {
RuntimeService runtimeService = processEngine.getRuntimeService();
TaskService taskService = processEngine.getTaskService();
// ==============================================
// 设置变量的方法
// 通过Execution设置一个变量
runtimeService.setVariable(executionId, name, value);
// 通过Execution设置多个变量
runtimeService.setVariable(executionId, variablesMap);
// 通过Task设置一个变量
taskService.setVariable(taskId, variableName, value);
// 在启动流程实例时,同时也设置一些流程变量
taskService.complete(taskId, variables);
// =============================================
// 获取变量的方法
// 通过Excution获取一个变量
runtimeService.getVariable(executionId, variableName);
// 通过Execution获取所有变量的信息,存放在Map集合中
runtimeService.getVariables(executionId);
// 通过Execution获取指定流程变量名称的变量值得信息,存放到Map集合中
runtimeService.getVariables(executionId, variableNames);
// 通过Task获取一个变量
taskService.getVariable(taskId, variableName);
// 通过Task获取所有变量的信息,存放到Map集合中
taskService.getVariables(taskId);
// 通过Task获取指定流程变量名称的变量值信息,存放到Map集合中
taskService.getVariables(taskId, variableNames);
}
说明:
1) RuntimeService对象可以设置流程变量和获取流程变量
2) TaskService对象可以设置流程变量和获取流程变量
3) 流程实例启动的时候可以设置流程变量
4) 任务办理完成的时候可以设置流程变量
5) 流程变量可以通过名称/值的形式设置单个流程变量
6) 流程变量可以通过Map集合,同时设置多个流程变量
Map集合的key表示流程变量的名称
Map集合的value表示流程变量的值
8. 流程变量的支持的类型
如图是从官网列出来的流程变量的类型:
从图中可以看出包括了大部分封装类型和Date、String和实现了Serializable接口的类的类型。
9. 总结
1. 流程变量
在流程执行或者任务执行的过程中,用于设置和获取变量,使用流程变量在流程传递的过程中传递业务参数。
对应的表:
act_ru_variable:正在执行的流程变量表
act_hi_varinst:流程变量历史表
2. 扩展知识:setVariable和setVariableLocal的区别
setVariable:设置流程变量的时候,流程变量名称相同的时候,后一次的值替换前一次的值,而且可以看到TASK_ID的字段不会存放任务ID的值
setVariableLocal:
- 设置流程变量的时候,针对当前活动的节点设置流程变量,如果一个流程中存在2个活动节点,对每个活动节点都设置流程变量,即使流程变量的名称相同,后一次的版本的值也不会替换前一次版本的值,它会使用不同的任务ID作为标识,存放2个流程变量值,而且可以看到TASK_ID的字段会存放任务ID的值
例如act_hi_varinst 表的数据:不同的任务节点,即使流程变量名称相同,存放的值也是不同的。
如图:
- 还有,使用setVariableLocal说明流程变量绑定了当前的任务,当流程继续执行时,下个任务获取不到这个流程变量(因为正在执行的流程变量中没有这个数据),所有查询正在执行的任务时不能查询到我们需要的数据,此时需要查询历史的流程变量。