Activiti6.0学习实践（8）-核心api：TaskService流程任务服务

TaskService也是非常重要的核心api，主要是对用户任务（UserTask）管理和控制，也可以设置UserTask的权限信息，针对用户任务添加任务附件、任务评论和事件记录。虽然TaskService可以对task对象进行创建和删除，但是一般都是在流程定义文件中我们定义task，当流程执行到这个节点时，就触发task执行。下面通过一个demo来说明

1、创建流程定义文件

创建一个关于task的流程定义文件my-process-task.bpmn20.xml

2、任务控制和变量设置

创建一个测视类来测试任务控制和变量的设置

public class TaskServiceTest {
    private static final Logger logger = LoggerFactory.getLogger(TaskServiceTest.class);

    @Rule
    public ActivitiRule activitiRule = new ActivitiRule();

    //流程启动，通过key的方式
    @Test
    @Deployment(resources = {"my-process-task.bpmn20.xml"})
    public void testTaskService() {

        //设置一下流程的变量
        Map<String, Object> variables = Maps.newHashMap();
        variables.put("message","my test message！");  //这里用my test message 替换在定义文件中的message

        //启动流程
        activitiRule.getRuntimeService().startProcessInstanceByKey("my-process",variables);

        //获取taskService
        TaskService taskService = activitiRule.getTaskService();
        Task task = taskService.createTaskQuery().singleResult();
        logger.info("task = {}", ToStringBuilder.reflectionToString(task, ToStringStyle.JSON_STYLE)); //JSON_STYLE类型到3.9版才支持
        logger.info("task description = {}", task.getDescription());

        taskService.setVariable(task.getId(), "key1","value1");
        taskService.setVariableLocal(task.getId(), "localkey1", "localvalue1");

        Map<String, Object> variables1 = taskService.getVariables(task.getId());
        Map<String, Object> variablesLocal = taskService.getVariablesLocal(task.getId());

        //也可以根据执行流获取变量
        Map<String, Object> variables2 = activitiRule.getRuntimeService().getVariables(task.getExecutionId());
        logger.info("taskservive get variables1 = {}", variables1);
        logger.info("local variables1 = {}", variablesLocal);
        logger.info("runtimeservice get variable= {}", variables2);

    }

}

测试结果

测试结果中，第一个红框表示通过占位替换方式输入的变量。第二个红框表示三种获取变量的方式，第一行是任务服务获取的变量，会获取流程变量，任务外部设定一下变量，任务本地变量，第二行是通过本地变量方式，可以获取任务内的变量，第三行是通过运行时服务获取的变量，包含流程的变量和外部设定的变量

2、指定用户和候选组

流程执行到某个环节的时候，我们会希望某个任务由指定的用户或者某个候选组（比如某部门）来执行，因此任务服务就提供了这个接口。在activiti中有几个专有名词：候选用户（candidateUser），候选组（candidateGroup），指定拥有人（Owner），办理人（Assignee），通过claim接口也可设置办理人。

2.1、测试代码

//测试task对用户权限的控制
    @Test
    @Deployment(resources = {"my-process-task.bpmn20.xml"})
    public void testTaskServiceUser() {

        //设置一下流程的变量
        Map<String, Object> variables = Maps.newHashMap();
        variables.put("message","my test message！");  //这里用my test message 替换在定义文件中的message

        //启动流程
        activitiRule.getRuntimeService().startProcessInstanceByKey("my-process",variables);

        //获取taskService
        TaskService taskService = activitiRule.getTaskService();
        Task task = taskService.createTaskQuery().singleResult();
        logger.info("task = {}", ToStringBuilder.reflectionToString(task, ToStringStyle.JSON_STYLE)); //JSON_STYLE类型到3.9版才支持
        logger.info("task description = {}", task.getDescription());

        taskService.setOwner(task.getId(), "user1");
//        taskService.setAssignee(task.getId(),"admin");  //此方法一般不使用
        //先查询一下用户设为admin的没有分配任务有多少
        List<Task> taskList = taskService.createTaskQuery().taskCandidateUser("admin")
                .taskUnassigned().listPage(0, 100);

        //设定办理人  assignee
        for (Task task1 : taskList) {
            try {
                taskService.claim(task1.getId(), "admin");
            } catch (Exception e) {
                logger.error(e.getMessage(), e);
            }
        }
        //获取用户和用户组与task的关系
        List<IdentityLink> identityLinksForTask = taskService.getIdentityLinksForTask(task.getId());
        for (IdentityLink identityLink : identityLinksForTask) {
            logger.info("identityLink = {}",  identityLink);
        }

        //让这些流程执行下去
        List<Task> tasks = taskService.createTaskQuery().taskAssignee("admin").listPage(0, 100);
        for (Task task1 : tasks) {
            Map<String, Object> vars = Maps.newHashMap();
            vars.put("ckey1","cvalue1");  //这里用my test message 替换在定义文件中的message
            taskService.complete(task1.getId(), vars);
        }

        //再次执行查询，看看这些任务执行完成没有
        tasks = taskService.createTaskQuery().taskAssignee("admin").listPage(0, 100);
        logger.info("是否为空 {}", CollectionUtils.isEmpty(tasks));


    }

2.2、测试日志输出：

上面红框1处：是根据流程定义文件，指定了候选人，所以有三条记录，对应流程定义文件中如下内容

红框2处，没有id的，是程序用claim方法设置的办理人；

红框3处，也没有id，是程序用setOwner方法设置的拥有者

红框4处，是执行完全部task后，判断是否还有task，返回为空

3、设置task附加信息

taskService还可以对task设置附加信息，我们在流程执行中，会有这样的场景，就是对执行任务，进行附件（Attachment）因此taskService也提供了附加信息的接口,附件是存储附件的url

3.1、测试代码：

//测试task的附件接口
@Test
@Deployment(resources = {"my-process-task.bpmn20.xml"})
public void testTaskServiceAttachment() {

    //设置一下流程的变量
    Map<String, Object> variables = Maps.newHashMap();
    variables.put("message","my test message！");  //这里用my test message 替换在定义文件中的message

    //启动流程
    activitiRule.getRuntimeService().startProcessInstanceByKey("my-process",variables);

    //获取taskService
    TaskService taskService = activitiRule.getTaskService();
    Task task = taskService.createTaskQuery().singleResult();
    taskService.createAttachment("url", task.getId(),
            task.getProcessInstanceId(),"name",
            "desc", "/url/test.png"
            );

    List<Attachment> taskAttachments = taskService.getTaskAttachments(task.getId());
    for (Attachment taskAttachment : taskAttachments) {
        logger.info(" = {}", ToStringBuilder.reflectionToString(taskAttachment, ToStringStyle.JSON_STYLE));
    }

}

3.2、执行日志：

4、设置task备注信息

taskService还可以对task设置备注信息，我们在流程执行中，会有这样的场景，就是对执行任务，进行评论（comment,如办理意见）因此taskService也提供了备注信息的接口

4.1、测试代码

//测试task的评论接口
@Test
@Deployment(resources = {"my-process-task.bpmn20.xml"})
public void testTaskServiceComment() {

    //设置一下流程的变量
    Map<String, Object> variables = Maps.newHashMap();
    variables.put("message","my test message！");  //这里用my test message 替换在定义文件中的message

    //启动流程
    activitiRule.getRuntimeService().startProcessInstanceByKey("my-process",variables);

    //获取taskService
    TaskService taskService = activitiRule.getTaskService();
    Task task = taskService.createTaskQuery().singleResult();
    taskService.addComment(task.getId(),task.getProcessInstanceId(), "this is note 1");
    taskService.addComment(task.getId(),task.getProcessInstanceId(), "this is note 2");


    List<Comment> taskComments = taskService.getTaskComments(task.getId());

    for (Comment comment  : taskComments) {
        logger.info(" = {}", ToStringBuilder.reflectionToString(comment, ToStringStyle.JSON_STYLE));
    }

}

4.2、执行日志:

日志显示了增加了2条备注

4.3、comment和event的区别

下面我们来看一下comment和event的区别

在上面的代码中，我们修改2个地方

这里增加一个setOwner操作

然后我们把event打印出来，在前面打印comment的后面

执行日志

可以看到comment的部分和event内容一样，但是event还多了前面设置owner的内容，也就是说，对于taskservcie的操作，都会被当做event进行记录下来。