activiti6.0源码剖析之BpmnModel模型校验器

activiti源码剖析之BpmnModel模型校验器

前言
BpmnModel校验器可以用来校验BpmnModel是否构造成功，可以对BpmnModel每一个元素进行合法校验，除了BpmnModel构造正确性校验之外，我们还可以根据业务场景设计自定义模型校验器。比如业务需要流程中如果包含用户任务，那么用户任务必须指定处理人等等，这种需求我们完全可以通过自定义模型校验器进行实现。

一、BpmnModel模型校验器初体验

        //创建模型校验器工厂
        ProcessValidatorFactory processValidatorFactory = new ProcessValidatorFactory();
        //创建默认模型校验器
        ProcessValidator processValidator = processValidatorFactory.createDefaultProcessValidator();
        //进行模型校验
        List<ValidationError> validate = processValidator.validate(bpmnModel);
        //如果校验错误集合长度大于1，则说明校验出错，遍历打印出错信息
        if(validate.size()>=1){
            for (ValidationError validationError : validate) {
                System.out.println(validationError.getProblem());
                System.out.println(validationError.isWarning());
            }
        }

二、通过源码分析模型校验器

通过初体验代码我们大致了解到，模型校验器的步骤：

1.获取模型校验器工厂ProcessValidatorFactory
2.通过模型校验器工厂创建模型校验器ProcessValidator
3.调用ProcessValidator模型校验器validate方法，返回校验结果集

查看processValidatorFactory.createDefaultProcessValidator()源码

public ProcessValidator createDefaultProcessValidator() {
       ProcessValidatorImpl processValidator = new ProcessValidatorImpl();
       processValidator.addValidatorSet((new ValidatorSetFactory()).createActivitiExecutableProcessValidatorSet());
       return processValidator;
   }

ValidatorSetFactory()).createActivitiExecutableProcessValidatorSet()实现

    public ValidatorSet createActivitiExecutableProcessValidatorSet() {
        ValidatorSet validatorSet = new ValidatorSet("activiti-executable-process");
        validatorSet.addValidator(new AssociationValidator());
        ...
        validatorSet.addValidator(new FlowElementValidator());
        validatorSet.addValidator(new StartEventValidator());
        validatorSet.addValidator(new SequenceflowValidator());
        validatorSet.addValidator(new UserTaskValidator());
        .....
        validatorSet.addValidator(new DiagramInterchangeInfoValidator());
        return validatorSet;
    }

首先创建一个ProcessValidatorImpl对象，该对象持有元素为ValidatorSet的一个集合，顾名思义，这个集合中包含着所有的校验器，ProcessValidatorImpl进行模型校验时，遍历这个集合，再针对每一个validatorSet中持有的所有Validator实现遍历对BpmnModel模型进行校验，并且将校验错误添加到 List<ValidationError>集合中，遍历结束返回ValidationError结果集。

所以如果想实现自定义校验器，只需要实现我们自己的ValidatorSet 然后添加到ProcessValidatorImpl对象中的validatorSets集合中。那么如何实现自定义的ValidatorSet呢？我们先来看看ValidatorSet都有哪些东西

ValidatorSet.png

从ValidatorSet的构成来看，校验器的重点应该是Validator，也就是说所有的模型校验器都应该实现Validator接口，这里我们查看Validator类结构，可以看出来activiti通过Validator有很多实现，分别校验bpmn流程文档中不同的元素节点。

Validator类结构.png

三、自定义Bpmn模型校验器实战

场景：在部署流程之前需要校验流程中的所有用户任务是否指定办理人

第一步、定义校验器类，继承ProcessLevelValidator实现executeValidation方法

public class UserTaskValidator extends ProcessLevelValidator {
    @Override
    protected void executeValidation(BpmnModel bpmnModel, Process process, List<ValidationError> errors) {
        //获取模型中所有的用户任务节点
        List<UserTask> userTaskList = process.findFlowElementsOfType(UserTask.class);
        for (UserTask userTask : userTaskList) {
            //获取用户任务指定人
            String assignee = userTask.getAssignee();
            if(assignee == null || assignee == ""){
                //向List<ValidationError>添加校验错误结果
                ValidationError validationError = new ValidationError();
                validationError.setProblem(userTask.getId()+"--->没有指定办理人");
                validationError.setWarning(false);

                errors.add(validationError);
            }
        }

    }
}

第二步、创建ValidatorSet封装自定义校验器

    
        ValidatorSet validatorSet = new ValidatorSet("Validate UserTask assigne");
        validatorSet.addValidator(new UserTaskValidator());

第三步、获取ProcessValidator的List<ValidatorSet>，将自定义校验器添加进去，对模型进行校验

        //创建模型校验器工厂
        ProcessValidatorFactory processValidatorFactory = new ProcessValidatorFactory();
        //创建默认模型校验器
        ProcessValidator processValidator = processValidatorFactory.createDefaultProcessValidator();
        //添加自定义模型校验器
        List<ValidatorSet> validatorSets = processValidator.getValidatorSets();
        validatorSets.add(validatorSet);

        //进行模型校验
        List<ValidationError> validate = processValidator.validate(bpmnModel);
        //如果校验错误集合长度大于1，则说明校验出错，遍历打印出错信息
        if(validate.size()>=1){
            for (ValidationError validationError : validate) {
                System.out.println(validationError.getProblem());
                System.out.println(validationError.isWarning());
            }
        }

查看校验结果

校验结果.png

四、扩展源码，将自定义模型检验器融合进activiti

此操作相当于将我们自定义的校验器设置为全局检验，这样以后在部署流程文档时，都会经过我们自定义的模型校验器，如果校验出错误，则部署失败。那么应该如何扩展呢

查看ProcessEngineConfigurationImpl.class中初始化流程校验器实现

    public void initProcessValidator() {
        if (this.processValidator == null) {
            this.processValidator = (new ProcessValidatorFactory()).createDefaultProcessValidator();
        }

    }

可以看到，这里先校验processValidator开关属性（可配置）是否为空，如果为空（用户未设置该开关属性）则使用默认的流程校验器。所以我们这里通过配置processValidator开关属性来进行扩展，当然，你也可以直接扩展ProcessEngineConfigurationImpl

第一步、自定义模型检验器
这里不再重复
第二步、扩展ProcessValidatorFactory,将自定义校验器添加进去

public class ProcessValidatorFactoryExt extends ProcessValidatorFactory {
    @Override
    public ProcessValidator createDefaultProcessValidator() {
        ProcessValidator defaultProcessValidator = super.createDefaultProcessValidator();
        //将自定义校验器添加进去
        ValidatorSet validatorSet = new ValidatorSet("Validate UserTask assigne");
        validatorSet.addValidator(new UserTaskValidator());

        defaultProcessValidator.getValidatorSets().add(validatorSet);
        return defaultProcessValidator;
    }
}

第三步、修改activit.cfg.xml，配置StandaloneProcessEngineConfiguration的开关属性processValidator（这里修改activiti_context.xml也是类似的,也就是集成Spring）

<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://www.springframework.org/schema/beans   http://www.springframework.org/schema/beans/spring-beans.xsd">

    <bean id="processEngineConfiguration" class="org.activiti.engine.impl.cfg.StandaloneProcessEngineConfiguration">

        <property name="jdbcUrl" value="jdbc:mysql://localhost:3306/db_activiti" />
        <property name="jdbcDriver" value="com.mysql.jdbc.Driver" />
        <property name="jdbcUsername" value="root" />
        <property name="jdbcPassword" value="1234" />
        <property name="databaseSchemaUpdate" value="true" />
        <!--配置流程校验器-->
        <property name="processValidator">
            <bean  factory-bean="processValidatorFactoryExt" factory-method="createDefaultProcessValidator"/>
        </property>

    </bean>
    <bean id="processValidatorFactoryExt" class="cn.cf.activiti.shareniu.ProcessValidatorFactoryExt"/>

</beans>

部署一个流程文档，流程文档中的用户任务不分配处理人的结果

部署结果.png