Activiti6.0学习实践（9）-核心api：IdentityService、FormService、HistoryService、ManagementService等

绝地灬酷狼 2023-07-03 10:57 17阅读 0赞

前面学习了三个重要的核心API，本章介绍剩下的几个核心API

# 1、**身份管理服务** #

流程引擎提供了身份管理服务（IdentityService）来管理用户（User），管理用户组（Group），以及用户和用户组之间的关系（Membership）。身份管理不依赖与流程定义文件。

身份管理服务调用的实现调用过程如下图

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nzb2xv_size_16_color_FFFFFF_t_70][]

## 1.1、**创建用户和组** ##

建立一个测试leiIdentityServiceTest.java

public class IdentityServiceTest {
        private static final Logger logger = LoggerFactory.getLogger(IdentityServiceTest.class);
    
        @Rule
        public ActivitiRule activitiRule = new ActivitiRule();
    
        //identity不依赖流程定义文件
        @Test
        public void testIdentity() {
    
            //获取身份管理服务
            IdentityService identityService = activitiRule.getIdentityService();
            User user1 = identityService.newUser("user1");
            user1.setEmail("user1@126.com");
    
            User user2 = identityService.newUser("user2");
            user2.setEmail("user2@126.com");
    
            identityService.saveUser(user1);
            identityService.saveUser(user2);
    
            Group group1 = identityService.newGroup("group1");
            identityService.saveGroup(group1);
            Group group2 = identityService.newGroup("group2");
            identityService.saveGroup(group2);
    
            identityService.createMembership("user1", "group1");
            identityService.createMembership("user2", "group1");
            identityService.createMembership("user1", "group2");
    
            List<User> userList = identityService.createUserQuery().memberOfGroup("group1").listPage(0, 100);
            for (User user : userList) {
                logger.info("user = {}", ToStringBuilder.reflectionToString(user, ToStringStyle.JSON_STYLE));
            }
    
            List<Group> groupList = identityService.createGroupQuery().groupMember("user1").listPage(0, 100);
            for (Group group : groupList) {
                logger.info(" group = {}", ToStringBuilder.reflectionToString(group, ToStringStyle.JSON_STYLE));
            }
    
        }
    
    }

执行结果

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nzb2xv_size_16_color_FFFFFF_t_70 1][]

第一个红框看到可以查询出属于group1的两个用户，第二个红框看到查询出user1输的用户组

## 1.2、**修改用户组** ##

修改上面的测试代码，加入如下修改用户的内容

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nzb2xv_size_16_color_FFFFFF_t_70 2][]

## 1.3、执行结果 ##

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nzb2xv_size_16_color_FFFFFF_t_70 3][]

修改lastname后，我们看到version也变为2

# 2、**表单管理服务** #

Activiti提供了表单管理服务，主要提供了如下功能：解析流程定义中单项的配置，提交表单的方式驱动用户节点流转，获取自定义外部表单key。主要是对流程定义文件中的表单设置项进行解析

## 2.1、**创建流程定义文件** ##

在这个例子中，创建一个带有表单的流程定义文件

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nzb2xv_size_16_color_FFFFFF_t_70 4][]

## 2.2、**创建FormServiceTest** ##

public class FormServiceTest {
        private static final Logger logger = LoggerFactory.getLogger(FormServiceTest.class);
    
        @Rule
        public ActivitiRule activitiRule = new ActivitiRule();
    
    
        @Test
        @Deployment(resources = {"my-process-form.bpmn20.xml"})
        public void testFormService() {
            FormService formService = activitiRule.getFormService();
    
            //获取流程定义文件
            ProcessDefinition processDefinition = activitiRule.getRepositoryService().createProcessDefinitionQuery().singleResult();
    
            //获取start节点的formkey
            String startFormKey = formService.getStartFormKey(processDefinition.getId());
            logger.info("startFormKey = {} ", startFormKey);
    
            //获取start节点表单数据
            StartFormData startFormData = formService.getStartFormData(processDefinition.getId());
    
            //表单数据项的遍历
            List<FormProperty> formProperties = startFormData.getFormProperties();
            for (FormProperty formProperty : formProperties) {
                logger.info("formProperty = {}", ToStringBuilder.reflectionToString(formProperty, ToStringStyle.JSON_STYLE));
            }
    
            //通过fromservice启动流程引擎
            Map<String, String> properties= Maps.newHashMap();
            properties.put("message", "my test message");  //因为在定义文件中有message属性，所以这里进行赋值
            formService.submitStartFormData(processDefinition.getId(), properties);
    
            Task task = activitiRule.getTaskService().createTaskQuery().singleResult();
            TaskFormData taskFormData = formService.getTaskFormData(task.getId());
            List<FormProperty> taskFormDataFormProperties = taskFormData.getFormProperties();
            for (FormProperty taskFormDataFormProperty : taskFormDataFormProperties) {
                logger.info("taskFormDataFormProperty = {}", ToStringBuilder.reflectionToString(taskFormDataFormProperty,ToStringStyle.JSON_STYLE));
            }
    
            //给task的表单属性赋值
            Map<String, String> properties2= Maps.newHashMap();
            properties2.put("yesORno", "no");  //因为在定义文件中task有yesORno属性，所以这里进行赋值
            formService.submitTaskFormData(task.getId(), properties2);
    
            Task task1 = activitiRule.getTaskService().createTaskQuery().singleResult();
            logger.info("task1 = {}", task1);
    
    
        }
    
    }

##  2.3、**执行结果** ##

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nzb2xv_size_16_color_FFFFFF_t_70 5][]

# 3、**历史管理服务** #

历史管理服务主要提供了一下功能：管理流程实例结束后的历史数据，构建历史数据的查询对象，根据流程实例id删除流程历史数据。主要是牵涉到一下历史数据实体：

HistoricProcessInstance：历史流程实例实体类

HistoricVariableInstance：流程或任务变量值的实体

HistoricActivityInstance：单个活动节点执行的信息

HistoricTaskiInstance：用户任务实例的信息

HistoricDetail：历史流程活动任务详细信息

## 3.1、**创建测试类HistoryServiceTest** ##

在这个测试类中，将通过HistroyService获取各种历史数据

public class HistoryServiceTest {
        private static final Logger logger = LoggerFactory.getLogger(HistoryServiceTest.class);
    
        @Rule
        public ActivitiRule activitiRule = new ActivitiRule("activiti-history.cfg.xml");
    
    
        @Test
        @Deployment(resources = {"my-process.bpmn20.xml"})
        public void testHistoryService() {
            HistoryService historyService = activitiRule.getHistoryService();
            //用builder可以对两类变量进行测试
            ProcessInstanceBuilder processInstanceBuilder = activitiRule.getRuntimeService().createProcessInstanceBuilder();
    
            //普通变量
            Map<String, Object> variables = Maps.newHashMap();
            variables.put("key0", "value0");
            variables.put("key1","value1");
            variables.put("key2","value2");
    
            //瞬时变量
            Map<String, Object> transientVariables = Maps.newHashMap();
            transientVariables.put("tkey1","tvalue1");
    
            //启动流程
            ProcessInstance processInstance = processInstanceBuilder.processDefinitionKey("my-process")
                    .variables(variables)
                    .transientVariables(transientVariables).start();
    
            //启动后，会暂停在task上，这个时候，我们可以用runtimeService进行变量修改
            activitiRule.getRuntimeService().setVariable(processInstance.getId(),"key1", "value1-1");
    
            //获取task
            Task task = activitiRule.getTaskService().createTaskQuery().processInstanceId(processInstance.getId()).singleResult();
            //让task通过
    //        activitiRule.getTaskService().complete(task.getId(),variables);  //可以用这种方式让task完成，本例中采用另外一种方式
            //通过表单submit的方式让task通过，先获取表单，然后调用submit
    
            Map<String, String> properties= Maps.newHashMap();
            properties.put("fkey1", "fvalue1");
            properties.put("key2", "value2-2");
            activitiRule.getFormService().submitTaskFormData(task.getId(), properties);
    
            //通过history查询流程实例对象
            List<HistoricProcessInstance> historicProcessInstances = historyService.createHistoricProcessInstanceQuery().listPage(0,100);
            for (HistoricProcessInstance historicProcessInstance : historicProcessInstances) {
                logger.info(" historicProcessInstance = {}", ToStringBuilder.reflectionToString( historicProcessInstance,ToStringStyle.JSON_STYLE));
            }
    
            //查询节点
            List<HistoricActivityInstance> historicActivityInstances = historyService.createHistoricActivityInstanceQuery().listPage(0, 100);
            for (HistoricActivityInstance historicActivityInstance : historicActivityInstances) {
                logger.info(" historicActivityInstance = {}", historicActivityInstance);
            }
    
            //查询task
            List<HistoricTaskInstance> historicTaskInstances = historyService.createHistoricTaskInstanceQuery().listPage(0, 100);
            for (HistoricTaskInstance historicTaskInstance : historicTaskInstances) {
                logger.info(" historicTaskInstance = {}", ToStringBuilder.reflectionToString(historicTaskInstance, ToStringStyle.JSON_STYLE));
            }
    
            //查询variable
            List<HistoricVariableInstance> historicVariableInstances = historyService.createHistoricVariableInstanceQuery().listPage(0, 100);
            for (HistoricVariableInstance historicVariableInstance : historicVariableInstances) {
                logger.info(" historicVariableInstance = {}", historicVariableInstance);
            }
    
            //查询details
            List<HistoricDetail> historicDetails = historyService.createHistoricDetailQuery().listPage(0, 100);
            for (HistoricDetail historicDetail : historicDetails) {
                logger.info(" historicDetail = {}", ToStringBuilder.reflectionToString(historicDetail, ToStringStyle.JSON_STYLE) );
            }
            //查询his log,通过include控制查询的内容
            ProcessInstanceHistoryLog processInstanceHistoryLog = historyService.createProcessInstanceHistoryLogQuery(processInstance.getId())
                    .includeActivities()
                    .includeComments()
                    .includeVariables()
                    .includeFormProperties()
                    .includeTasks()
                    .includeVariableUpdates().singleResult();
    
            List<HistoricData> historicDataList = processInstanceHistoryLog.getHistoricData();
            for (HistoricData historicData : historicDataList) {
                logger.info(" historicData = {}", ToStringBuilder.reflectionToString(historicData, ToStringStyle.JSON_STYLE));
            }
    
            //删除流程历史记录
            historyService.deleteHistoricProcessInstance(processInstance.getId());
    
            //验证删除后的历史记录无法为空  期望为null
            HistoricProcessInstance historicProcessInstance = historyService.createHistoricProcessInstanceQuery().singleResult();
            logger.info(" After delete, historicProcessInstance = {} ", historicProcessInstance);
        }

##  3.2、**执行结果** ##

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nzb2xv_size_16_color_FFFFFF_t_70 6][]

# 4、**管理服务** #

ManagementService是管理服务，可以进行job任务管理，数据库相关通用操作，自定义sql查询，可以执行流程引擎名利（Command）。

## 4.1、**流程定义** ##

在流程定义中，我们配置一个job

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nzb2xv_size_16_color_FFFFFF_t_70 7][]

另外，我们还需要在cfg文件中，添加一个异步动作的配置

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nzb2xv_size_16_color_FFFFFF_t_70 8][]

## 4.2、**查找JOB** ##

### **4.2.1、建立测试函数testJobQuery** ###

建立一个测试类ManagementServiceTest,在这个类里面，建立如下测试函数

@Test
    @Deployment(resources = {"my-process-job.bpmn20.xml"})
    public void testJobQuery() {
    
        ManagementService managementService = activitiRule.getManagementService();
        List<Job> jobs = managementService.createTimerJobQuery().listPage(0, 100);
        for (Job job : jobs) {
            logger.info("timeJob = {}", job);
        }
    
        JobQuery jobQuery = managementService.createJobQuery();
        SuspendedJobQuery suspendedJobQuery = managementService.createSuspendedJobQuery();
        List<Job> jobs1 = suspendedJobQuery.listPage(0,100);
        for (Job job : jobs1) {
            logger.info("suspend job = {}", job);
        }
    
        DeadLetterJobQuery deadLetterJobQuery = managementService.createDeadLetterJobQuery();
        List<Job> jobs2 = deadLetterJobQuery.listPage(0, 100);
        for (Job job : jobs2) {
            logger.info("dead job = {}", job);
        }
    
    
    }

### 4.2.2、执行日志 ###

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nzb2xv_size_16_color_FFFFFF_t_70 9][]

## 4.3、**数据库表查询** ##

### 4.3.1、测试代码 ###

@Test
    @Deployment(resources = {"my-process-job.bpmn20.xml"})
    public void testTablePageQuery() {
    
        ManagementService managementService = activitiRule.getManagementService();
        TablePage tablePage = managementService.createTablePageQuery()
                .tableName(managementService.getTableName(ProcessDefinitionEntity.class))
                .listPage(0, 100);
    
        List<Map<String, Object>> rows = tablePage.getRows();
        for (Map<String, Object> row : rows) {
            logger.info("row = {}", row);
    
        }
    
    }

### 4.3.2 执行结果 ###

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nzb2xv_size_16_color_FFFFFF_t_70 10][]

## 4.4、**数据库sql操作** ##

**4.4.1、定义mapper接口**

数据库sql操作，需要先定义个mapper接口

package com.study.activiti.mapper;
    
    import org.apache.ibatis.annotations.Select;
    
    import java.util.List;
    import java.util.Map;
    
    public interface MyCustomMapper
    {
        @Select("SELECT * from ACT_RU_TASK")
        public List<Map<String, Object>> findAll();
    }

### 4.4.2、cfg文件配置mapper对象 ###

将这个接口在cfg文件配置进去

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nzb2xv_size_16_color_FFFFFF_t_70 11][]

### 4.4.3、测试代码 ###

@Test
    @Deployment(resources = {"my-process.bpmn20.xml"})
    public void testTablePageQuery() {
        //启动流程
        activitiRule.getRuntimeService().startProcessInstanceByKey("my-process");
        //查询task表中内容  表ACT_RU_TASK， 在mapper中定义的sql
        ManagementService managementService = activitiRule.getManagementService();
        List<Map<String, Object>> mapList = managementService.executeCustomSql(new AbstractCustomSqlExecution<MyCustomMapper,
                List<Map<String, Object>>>(MyCustomMapper.class) {
            @Override
            public List<Map<String, Object>> execute(MyCustomMapper o) {
                return o.findAll();
            }
        });
    
        for (Map<String, Object> map : mapList) {
            logger.info(" map = {}", map);
        }
    
    }

### 4.4.4、执行日志： ###

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nzb2xv_size_16_color_FFFFFF_t_70 12][]

## 4.5、**执行命令** ##

### 4.5.1、测试代码 ###

@Test
    @Deployment(resources = {"my-process.bpmn20.xml"})
    public void testCommand() {
        //启动流程
        activitiRule.getRuntimeService().startProcessInstanceByKey("my-process");
        //获取management
        ManagementService managementService = activitiRule.getManagementService();
    
        //执行execute
        ProcessDefinitionEntity processDefinitionEntity = managementService.executeCommand(new Command<ProcessDefinitionEntity>() {
            @Override
            public ProcessDefinitionEntity execute(CommandContext commandContext) {
                ProcessDefinitionEntity processDefinitionEntity = commandContext.getProcessDefinitionEntityManager()
                        .findLatestProcessDefinitionByKey("my-process");
                return processDefinitionEntity;
            }
        });
    
        logger.info("processDefinitionEntity = {}", processDefinitionEntity);
    }

### 4.5.2、执行日志： ###

### ![20200206093432370.png][] ###

# 5、**动态流程定义服务** #

DynamicBpmnService是6.0以后才有的动态流程定义服务，但是不建议使用，因为这个是对业务进行强制修改，容易引发混乱，建议少用

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nzb2xv_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20200206093432157.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nzb2xv,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nzb2xv_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20200206093427489.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nzb2xv,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nzb2xv_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/2020020609343265.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nzb2xv,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nzb2xv_size_16_color_FFFFFF_t_70 3]: https://img-blog.csdnimg.cn/20200206093423976.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nzb2xv,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nzb2xv_size_16_color_FFFFFF_t_70 4]: https://img-blog.csdnimg.cn/20200206093432153.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nzb2xv,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nzb2xv_size_16_color_FFFFFF_t_70 5]: https://img-blog.csdnimg.cn/2020020609343290.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nzb2xv,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nzb2xv_size_16_color_FFFFFF_t_70 6]: https://img-blog.csdnimg.cn/20200206093427673.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nzb2xv,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nzb2xv_size_16_color_FFFFFF_t_70 7]: https://img-blog.csdnimg.cn/20200206093422255.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nzb2xv,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nzb2xv_size_16_color_FFFFFF_t_70 8]: https://img-blog.csdnimg.cn/20200206093424153.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nzb2xv,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nzb2xv_size_16_color_FFFFFF_t_70 9]: https://img-blog.csdnimg.cn/20200206093432302.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nzb2xv,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nzb2xv_size_16_color_FFFFFF_t_70 10]: https://img-blog.csdnimg.cn/20200206093432294.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nzb2xv,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nzb2xv_size_16_color_FFFFFF_t_70 11]: https://img-blog.csdnimg.cn/20200206093432324.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nzb2xv,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nzb2xv_size_16_color_FFFFFF_t_70 12]: https://img-blog.csdnimg.cn/20200206093432360.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nzb2xv,size_16,color_FFFFFF,t_70
[20200206093432370.png]: https://img-blog.csdnimg.cn/20200206093432370.png