Activiti基础教程--06流程变量

相关代码参考gihub:https://github.com/changwensir/Activiti/tree/master/ActivitiDemo1

    流程变量在整个工作流中扮演很重要的作用。例如：请假流程中有请假天数、请假原因等一些参数都为流程变量的范围。流程变量的作用域范围是只对应一个流程实例。也就是说各个流程实例的流程变量是不相互影响的。流程实例结束完成以后流程变量还保存在数据库中（存放到流程变量的历史表中）。

1、部署流程定义

ProcessEngine processEngine = ProcessEngines.getDefaultProcessEngine();/**部署流程定义（从InputStream）*/@Testpublic void deploymentProcessDefinition_inputStream(){InputStream inputStreambpmn = this.getClass().getResourceAsStream("/diagrams/processVariables.bpmn");InputStream inputStreampng = this.getClass().getResourceAsStream("/diagrams/processVariables.png");Deployment deployment = processEngine.getRepositoryService()//与流程定义和部署对象相关的Service.createDeployment()//创建一个部署对象.name("流程定义")//添加部署的名称.addInputStream("processVariables.bpmn", inputStreambpmn)//使用资源文件的名称（要求：与资源文件的名称要一致），和输入流完成部署.addInputStream("processVariables.png", inputStreampng)//使用资源文件的名称（要求：与资源文件的名称要一致），和输入流完成部署.deploy();//完成部署System.out.println("部署ID："+deployment.getId());//System.out.println("部署名称："+deployment.getName());//}

    部署ID：1101
    部署名称：流程定义说明：输入流加载 资源文件的3种方式
  InputStream inputStreambpmn = this.getClass().getClassLoader().getResourceAsStream("processVariables.bpmn");
--  从classpath根目录下加载指定名称的文件
  InputStream inputStreambpmn = this.getClass().getResourceAsStream("processVariables.bpmn");
--  从当前包下加载指定名称的文件
  InputStream inputStreambpmn = this.getClass().getResourceAsStream("/processVariables.bpmn");
--  从classpath根目录下加载指定名称的文件

2、启动流程实例

/**启动流程实例*/@Testpublic void startProcessInstance(){//流程定义的keyString processDefinitionKey = "processVariables";ProcessInstance pi = processEngine.getRuntimeService()//与正在执行的流程实例和执行对象相关的Service.startProcessInstanceByKey(processDefinitionKey);//使用流程定义的key启动流程实例，key对应helloworld.bpmn文件中id的属性值，使用key值启动，默认是按照最新版本的流程定义启动System.out.println("流程实例ID:"+pi.getId());//流程实例ID    System.out.println("流程定义ID:"+pi.getProcessDefinitionId());//流程定义ID  }

    流程实例ID:1201
    流程定义ID:processVariables:1:1104   

3、设置流程变量

import java.io.Serializable;public class Person implements Serializable {private static final long serialVersionUID = 6757393795687480331L;private Integer id;//编号private String name;//姓名private String education;public String getEducation() {return education;}public void setEducation(String education) {this.education = education;}public Integer getId() {return id;}public void setId(Integer id) {this.id = id;}public String getName() {return name;}public void setName(String name) {this.name = name;}}

/**设置流程变量*/@Testpublic void setVariables(){/**与任务（正在执行）*/TaskService taskService = processEngine.getTaskService();//任务IDString taskId = "1204"; //act_ru_task表里id/**一：设置流程变量，使用基本数据类型*///taskService.setVariableLocal(taskId, "请假天数", 5);//与任务ID绑定//taskService.setVariable(taskId, "请假日期", new Date());//taskService.setVariable(taskId, "请假原因", "回家探亲，一起吃个饭");/**二：设置流程变量，使用javabean类型*//** * 当一个javabean（实现序列号）放置到流程变量中，要求javabean的属性不能再发生变化 *    * 如果发生变化，再获取的时候，抛出异常 *   * 解决方案：在Person对象中添加： * private static final long serialVersionUID = 6757393795687480331L; *      同时实现Serializable  * */Person p = new Person();p.setId(20);p.setName("翠花");taskService.setVariable(taskId, "人员信息(添加固定版本)", p);System.out.println("设置流程变量成功！");} 

设置流程变量，使用基本数据类型的查询表

说明：
  1).流程变量的作用域就是流程实例，所以只要设置就行了，不用管在哪个阶段设置
  2).基本类型设置流程变量，在taskService中使用任务ID，定义流程变量的名称，设置流程变量的值。
  3).Javabean类型设置流程变量，需要这个javabean实现了Serializable接口
  4).设置流程变量的时候，向act_ru_variable这个表添加数据

4、获取流程变量

/**获取流程变量*/@Testpublic void getVariables(){/**与任务（正在执行）*/TaskService taskService = processEngine.getTaskService();//任务IDString taskId = "1204";  //act_ru_task表里id/**一：获取流程变量，使用基本数据类型*///Integer days = (Integer) taskService.getVariable(taskId, "请假天数");//Date date = (Date) taskService.getVariable(taskId, "请假日期");//String resean = (String) taskService.getVariable(taskId, "请假原因");//System.out.println("请假天数："+days);//System.out.println("请假日期："+date);//System.out.println("请假原因："+resean);/**二：获取流程变量，使用javabean类型*/Person p = (Person)taskService.getVariable(taskId, "人员信息(添加固定版本)");System.out.println(p.getId()+"        "+p.getName());}

使用基本类型数据的结果如下：
请假天数：5
请假日期：Sat Sep 10 17:27:12 CST 2016
请假原因：回家探亲，一起吃个饭说明：
  1）.流程变量的获取针对流程实例（即1个流程），每个流程实例获取的流程变量时不同的
  2）.使用基本类型获取流程变量，在taskService中使用任务ID，流程变量的名称，获取流程变量的值。
  3）.javabean类型设置获取流程变量，除了需要这个javabean实现了Serializable接口外，还要求流程变量对象的属性不能发生变化，否则抛出异常。解决方案，固定序列化ID

/**完成我的任务*/@Testpublic void completeMyPersonalTask(){//任务IDString taskId = "1204";processEngine.getTaskService()//与正在执行的任务管理相关的Service.complete(taskId);System.out.println("完成任务：任务ID："+taskId);}

5、模拟流程变量的设置和获取的场景

/**模拟设置和获取流程变量的场景*/public void setAndGetVariables(){/**与流程实例，执行对象（正在执行）*/RuntimeService runtimeService = processEngine.getRuntimeService();/**与任务（正在执行）*/TaskService taskService = processEngine.getTaskService();/**设置流程变量*///runtimeService.setVariable(executionId, variableName, value)//表示使用执行对象ID，和流程变量的名称，设置流程变量的值（一次只能设置一个值）//runtimeService.setVariables(executionId, variables)//表示使用执行对象ID，和Map集合设置流程变量，map集合的key就是流程变量的名称，map集合的value就是流程变量的值（一次设置多个值）//taskService.setVariable(taskId, variableName, value)//表示使用任务ID，和流程变量的名称，设置流程变量的值（一次只能设置一个值）//taskService.setVariables(taskId, variables)//表示使用任务ID，和Map集合设置流程变量，map集合的key就是流程变量的名称，map集合的value就是流程变量的值（一次设置多个值）//runtimeService.startProcessInstanceByKey(processDefinitionKey, variables);//启动流程实例的同时，可以设置流程变量，用Map集合//taskService.complete(taskId, variables)//完成任务的同时，设置流程变量，用Map集合/**获取流程变量*///runtimeService.getVariable(executionId, variableName);//使用执行对象ID和流程变量的名称，获取流程变量的值//runtimeService.getVariables(executionId);//使用执行对象ID，获取所有的流程变量，将流程变量放置到Map集合中，map集合的key就是流程变量的名称，map集合的value就是流程变量的值//runtimeService.getVariables(executionId, variableNames);//使用执行对象ID，获取流程变量的值，通过设置流程变量的名称存放到集合中，获取指定流程变量名称的流程变量的值，值存放到Map集合中//taskService.getVariable(taskId, variableName);//使用任务ID和流程变量的名称，获取流程变量的值//taskService.getVariables(taskId);//使用任务ID，获取所有的流程变量，将流程变量放置到Map集合中，map集合的key就是流程变量的名称，map集合的value就是流程变量的值//taskService.getVariables(taskId, variableNames);//使用任务ID，获取流程变量的值，通过设置流程变量的名称存放到集合中，获取指定流程变量名称的流程变量的值，值存放到Map集合中}

说明：
  1）.RuntimeService对象可以设置流程变量和获取流程变量
  2）.TaskService对象可以设置流程变量和获取流程变量
  3）.流程实例启动的时候可以设置流程变量
  4）.任务办理完成的时候可以设置流程变量
  5）.流程变量可以通过名称/值的形式设置单个流程变量
  6）.流程变量可以通过Map集合，同时设置多个流程变量
    Map集合的key表示流程变量的名称
    Map集合的value表示流程变量的值

6、查询历史的流程变量

/**查询流程变量的历史表*/@Testpublic void findHistoryProcessVariables(){List<HistoricVariableInstance> list = processEngine.getHistoryService()//.createHistoricVariableInstanceQuery()//创建一个历史的流程变量查询对象.variableName("请假天数").list();if(list!=null && list.size()>0){for(HistoricVariableInstance hvi:list){System.out.println(hvi.getId()+"   "+hvi.getProcessInstanceId()+"   "+hvi.getVariableName()+"   "+hvi.getVariableTypeName()+"    "+hvi.getValue());System.out.println("###############################################");}}}

说明：
  1）历史的流程变量查询，指定流程变量的名称，查询act_hi_varinst表（也可以针对，流程实例ID，执行对象ID，任务ID查询）

7、流程变量的支持的类型

    如图是从官网列出来的流程变量的类型：

    从图中可以看出包括了大部分封装类型和Date、String和实现了Serializable接口的类的类型。

8、总结

    1：流程变量
    在流程执行或者任务执行的过程中，用于设置和获取变量，使用流程变量在流程传递的过程中传递业务参数。
  对应的表：
  act_ru_variable：正在执行的流程变量表
  act_hi_varinst：流程变量历史表

    2：扩展知识：setVariable和setVariableLocal的区别
  setVariable：设置流程变量的时候，流程变量名称相同的时候，后一次的值替换前一次的值，而且可以看到TASK_ID的字段不会存放任务ID的值
  setVariableLocal：
  1：设置流程变量的时候，针对当前活动的节点设置流程变量，如果一个流程中存在2个活动节点，对每个活动节点都设置流程变量，即使流程变量的名称相同，后一次的版本的值也不会替换前一次版本的值，它会使用不同的任务ID作为标识，存放2个流程变量值，而且可以看到TASK_ID的字段会存放任务ID的值
例如act_hi_varinst 表的数据：不同的任务节点，即使流程变量名称相同，存放的值也是不同的。
如图：

    2：还有，使用setVariableLocal说明流程变量绑定了当前的任务，当流程继续执行时，下个任务获取不到这个流程变量（因为正在执行的流程变量中没有这个数据），所有查询正在执行的任务时不能查询到我们需要的数据，此时需要查询历史的流程变量。