工作流系列(5.2)-Activiti流程文件解析源码分析

最新推荐文章于 2024-08-27 03:59:15 发布
最新推荐文章于 2024-08-27 03:59:15 发布
阅读量2.3k 收藏 4
点赞数
分类专栏： Activiti学习 文章标签： Activiti 工作流
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/laozhaishaozuo/article/details/85240605
版权

文章目录

解析准备

转换器和解析器共同构建了Activiti的转换基础。

准备转换器

从配置文件的到BpmnModel的转换都是通过org.activiti.bpmn.converterBpmnXMLConvert类来进行，在解析之前会准备各种转换器，具体的代码是

static {
    // events
    addConverter(new EndEventXMLConverter());
    addConverter(new StartEventXMLConverter());

    // tasks
   ....
  }

只列出了部分，没有全部列出。从之前的文章中，我们可以看到对于每个元素都有相对应的转化器（解析器）与其对应，而每个元素公共的属性也有相应的解析器去解析。

解析器

对于各个子元素或公共元素的解析，大部分是通过org.activiti.bpmn.converter.util.BpmnXMLUtil类来进行解析的，当然其也会首先加载不同子元素的解析器。

 static {
    addGenericParser(new ActivitiEventListenerParser());
    ...
    addGenericParser(new IOSpecificationParser());
    addGenericParser(new MessageEventDefinitionParser());
    addGenericParser(new MultiInstanceParser());
    addGenericParser(new SignalEventDefinitionParser());
    addGenericParser(new TaskListenerParser());
    ....
  }

Activiti自有解析

解析入口

在BpmnXMLConvert中，我们使用convertToBpmnModel方法将流程配置文件解析为BpmnModel模型

 public BpmnModel convertToBpmnModel(InputStreamProvider, boolean, boolean)
 public BpmnModel convertToBpmnModel(InputStreamProvider, boolean, boolean, String)
 public BpmnModel convertToBpmnModel(XMLStreamReader)

在解析配置文件过程中，我们需要XML流，有两种方式，

  1. 构建org.activiti.bpmn.converter.util.InputStreamReader
  2. 直接构建XMLStreamReader
    当然最终的处理都是会基于XMLStreamReader

执行解析

我们阅读源码会发现，所有的转换最终都是调用public BpmnModel convertToBpmnModel(XMLStreamReader)方法，我们可以大致浏览一下其方法

public BpmnModel convertToBpmnModel(XMLStreamReader){
    BpmnModel model = new BpmnModel();
    model.setStartEventFormTypes(startEventFormTypes);
    model.setUserTaskFormTypes(userTaskFormTypes);
    try {
	  //定义主流程
      Process activeProcess = null;
      //准备子流程列表
      List<SubProcess> activeSubProcessList = new ArrayList<SubProcess>();
      while (xtr.hasNext()) {
        try {
          xtr.next();
        } catch (Exception e) {
          LOGGER.debug("Error reading XML document", e);
          throw new XMLException("Error reading XML", e);
        }
		//子流程或事务子流程或特别子流程
        if (xtr.isEndElement() && (ELEMENT_SUBPROCESS.equals(xtr.getLocalName()) || 
            ELEMENT_TRANSACTION.equals(xtr.getLocalName()) ||
            ELEMENT_ADHOC_SUBPROCESS.equals(xtr.getLocalName()))) {
          activeSubProcessList.remove(activeSubProcessList.size() - 1);
        }
		//不是开始元素跳过执行
        if (xtr.isStartElement() == false) {
          continue;
        }
        //解析定义信息
        if (ELEMENT_DEFINITIONS.equals(xtr.getLocalName())) {
			 definitionsParser.parse(xtr, model);	  
        } else if (ELEMENT_RESOURCE.equals(xtr.getLocalName())) {
          //解析资源信息
          resourceParser.parse(xtr, model);
         } else if (ELEMENT_SIGNAL.equals(xtr.getLocalName())) {
			signalParser.parse(xtr, model);
		 } else if (ELEMENT_MESSAGE.equals(xtr.getLocalName())) {
            messageParser.parse(xtr, model);
        } else if (ELEMENT_ERROR.equals(xtr.getLocalName())) {
          if (StringUtils.isNotEmpty(xtr.getAttributeValue(null, ATTRIBUTE_ID))) {
            model.addError(xtr.getAttributeValue(null, ATTRIBUTE_ID), xtr.getAttributeValue(null, ATTRIBUTE_ERROR_CODE));
          }
        }
        .....//省略大部分if判断
        } else {
        
          if (!activeSubProcessList.isEmpty() && ELEMENT_MULTIINSTANCE.equalsIgnoreCase(xtr.getLocalName())) {

            multiInstanceParser.parseChildElement(xtr, activeSubProcessList.get(activeSubProcessList.size() - 1), model);

          } else if (convertersToBpmnMap.containsKey(xtr.getLocalName())) {
            if (activeProcess != null) {
              BaseBpmnXMLConverter converter = convertersToBpmnMap.get(xtr.getLocalName());
              converter.convertToBpmnModel(xtr, model, activeProcess, activeSubProcessList);
            }
          }
        }
      }

      for (Process process : model.getProcesses()) {
        for (Pool pool : model.getPools()) {
          if (process.getId().equals(pool.getProcessRef())) {
            pool.setExecutable(process.isExecutable());
          }
        }
        processFlowElements(process.getFlowElements(), process);
      }

    } catch (XMLException e) {
      throw e;

    } catch (Exception e) {
      LOGGER.error("Error processing BPMN document", e);
      throw new XMLException("Error processing BPMN document", e);
    }
    return model;
 }

通过简单浏览其源码，我们发现是通过对XML文件流进行一系列的判断，根据遇到的元素不同，而调用不同的转化器（解析器），最终将整个BpmnModel构建出来。

探秘转换器（解析器）

因为有很多转化器或解析器，我们不能一一解析，我们将挑选几个比较典型的元素转换器进行分析。对于子元素、扩展元素的解析，放到下一节中。

ProcessParser（流程元素解析）

在convertToBpmnModel方法中，如果遇到Process元素，就会通过调用org.activiti.bpmn.converter.parser.ProcessParser中的parse方法来进行解析

public BpmnModel convertToBpmnModel(XMLStreamReader){
...
   else if (ELEMENT_PROCESS.equals(xtr.getLocalName())) {
      Process process = processParser.parse(xtr, model);
      if (process != null) {
          activeProcess = process;
       }
	}
...
 return model;
}

以下是org.activiti.bpmn.converter.parser.ProcessParser.parse()方法的源码

public Process parse(XMLStreamReader xtr, BpmnModel model) throws Exception {
    //创建Process对象，用于表示该元素
    Process process = null;
    if (StringUtils.isNotEmpty(xtr.getAttributeValue(null, ATTRIBUTE_ID))) {
      //解析processId
      String processId = xtr.getAttributeValue(null, ATTRIBUTE_ID);
      process = new Process();
      process.setId(processId);
      //解析元素在XML文件中的的位置信息
      BpmnXMLUtil.addXMLLocation(process, xtr);
      process.setName(xtr.getAttributeValue(null, ATTRIBUTE_NAME));
      //获取可执行属性
      if (StringUtils.isNotEmpty(xtr.getAttributeValue(null, ATTRIBUTE_PROCESS_EXECUTABLE))) {
        process.setExecutable(Boolean.parseBoolean(xtr.getAttributeValue(null, ATTRIBUTE_PROCESS_EXECUTABLE)));
      }
      //获取流程开始时用户 
      String candidateUsersString = xtr.getAttributeValue(ACTIVITI_EXTENSIONS_NAMESPACE, ATTRIBUTE_PROCESS_CANDIDATE_USERS);
      if (StringUtils.isNotEmpty(candidateUsersString)) {
        List<String> candidateUsers = BpmnXMLUtil.parseDelimitedList(candidateUsersString);
        process.setCandidateStarterUsers(candidateUsers);
      }
      //获取流程开始时分组    
      String candidateGroupsString = xtr.getAttributeValue(ACTIVITI_EXTENSIONS_NAMESPACE, ATTRIBUTE_PROCESS_CANDIDATE_GROUPS);
      if (StringUtils.isNotEmpty(candidateGroupsString)) {
        List<String> candidateGroups = BpmnXMLUtil.parseDelimitedList(candidateGroupsString);
        process.setCandidateStarterGroups(candidateGroups);
      }
	  //解析扩展元素
      BpmnXMLUtil.addCustomAttributes(xtr, process, ProcessExport.defaultProcessAttributes);
      model.getProcesses().add(process);

    }
    return process;
  }
  1. 首先创建Process用于承载解析的对象，如果该元素没有定义id则忽略
  2. 然后元素的id、name等熟悉
  3. 解析扩展属性（会在下方详细介绍）
UserTaskXMLConverter（用户任务转换器）

解析元素userTask时，使用org.activiti.bpmn.converter.UserTaskXMLConverter进行解析。

调用转换器

在BpmnXMLConverter中对其的调用是通过获取转换器Map中对应元素的转化进行解析的。

BaseBpmnXMLConverter converter = convertersToBpmnMap.get(xtr.getLocalName());
converter.convertToBpmnModel(xtr, model, activeProcess, activeSubProcessList);
转换方法
  @Override
  @SuppressWarnings("unchecked")
  protected BaseElement convertXMLToElement(XMLStreamReader xtr, BpmnModel model) throws Exception {
    String formKey = xtr.getAttributeValue(ACTIVITI_EXTENSIONS_NAMESPACE, ATTRIBUTE_FORM_FORMKEY);
    UserTask userTask = null;
    //判断是是否存在formKey（表单key）
    if (StringUtils.isNotEmpty(formKey)) {
      if (model.getUserTaskFormTypes() != null && model.getUserTaskFormTypes().contains(formKey)) {
        userTask = new AlfrescoUserTask();
      }
    }
    if (userTask == null) {
      userTask = new UserTask();
    }
    //解析位置信息
    BpmnXMLUtil.addXMLLocation(userTask, xtr);
    //然后分别解析截止时间，分类，表单key，所属人员，优先级，候选人、候选组、跳过表达式
    userTask.setDueDate(xtr.getAttributeValue(ACTIVITI_EXTENSIONS_NAMESPACE, ATTRIBUTE_TASK_USER_DUEDATE));
    userTask.setBusinessCalendarName(xtr.getAttributeValue(ACTIVITI_EXTENSIONS_NAMESPACE, ATTRIBUTE_TASK_USER_BUSINESS_CALENDAR_NAME));
    userTask.setCategory(xtr.getAttributeValue(ACTIVITI_EXTENSIONS_NAMESPACE, ATTRIBUTE_TASK_USER_CATEGORY));
    userTask.setFormKey(formKey);
    userTask.setAssignee(xtr.getAttributeValue(ACTIVITI_EXTENSIONS_NAMESPACE, ATTRIBUTE_TASK_USER_ASSIGNEE)); 
    userTask.setOwner(xtr.getAttributeValue(ACTIVITI_EXTENSIONS_NAMESPACE, ATTRIBUTE_TASK_USER_OWNER));
    userTask.setPriority(xtr.getAttributeValue(ACTIVITI_EXTENSIONS_NAMESPACE, ATTRIBUTE_TASK_USER_PRIORITY));
    
    if (StringUtils.isNotEmpty(xtr.getAttributeValue(ACTIVITI_EXTENSIONS_NAMESPACE, ATTRIBUTE_TASK_USER_CANDIDATEUSERS))) {
      String expression = xtr.getAttributeValue(ACTIVITI_EXTENSIONS_NAMESPACE, ATTRIBUTE_TASK_USER_CANDIDATEUSERS);
      userTask.getCandidateUsers().addAll(parseDelimitedList(expression));
    } 
    
    if (StringUtils.isNotEmpty(xtr.getAttributeValue(ACTIVITI_EXTENSIONS_NAMESPACE, ATTRIBUTE_TASK_USER_CANDIDATEGROUPS))) {
      String expression = xtr.getAttributeValue(ACTIVITI_EXTENSIONS_NAMESPACE, ATTRIBUTE_TASK_USER_CANDIDATEGROUPS);
      userTask.getCandidateGroups().addAll(parseDelimitedList(expression));
    }
    
    userTask.setExtensionId(xtr.getAttributeValue(ACTIVITI_EXTENSIONS_NAMESPACE, ATTRIBUTE_TASK_SERVICE_EXTENSIONID));

    if (StringUtils.isNotEmpty(xtr.getAttributeValue(ACTIVITI_EXTENSIONS_NAMESPACE, ATTRIBUTE_TASK_USER_SKIP_EXPRESSION))) {
      String expression = xtr.getAttributeValue(ACTIVITI_EXTENSIONS_NAMESPACE, ATTRIBUTE_TASK_USER_SKIP_EXPRESSION);
      userTask.setSkipExpression(expression);
    }
    //解析自定义属性
    BpmnXMLUtil.addCustomAttributes(xtr, userTask, defaultElementAttributes, 
        defaultActivityAttributes, defaultUserTaskAttributes);
    //解析子元素
    parseChildElements(getXMLElementName(), userTask, childParserMap, model, xtr);
    
    return userTask;
  }

解析用户任务的简要逻辑是：

  1. 首先判断是否存在formKey属性，如果存在则使用则将其解析为AlfrescoUserTask对象，不存在则是UserTask对象
  2. 解析位置信息
  3. 然后分别解析截止时间，分类，表单key，所属人员，优先级，候选人、候选组、跳过表达式
  4. 解析扩展属性
  5. 解析子元素
解析连线（sequenceFlow）

另外一个比较重要的元素是连线，它的解析类是org.activiti.bpmn.converter.SequenceFlowXMLConverter

protected BaseElement convertXMLToElement(XMLStreamReader xtr, BpmnModel model) throws Exception {
    SequenceFlow sequenceFlow = new SequenceFlow();
    BpmnXMLUtil.addXMLLocation(sequenceFlow, xtr);
    sequenceFlow.setSourceRef(xtr.getAttributeValue(null, ATTRIBUTE_FLOW_SOURCE_REF));
    sequenceFlow.setTargetRef(xtr.getAttributeValue(null, ATTRIBUTE_FLOW_TARGET_REF));
    sequenceFlow.setName(xtr.getAttributeValue(null, ATTRIBUTE_NAME));
    sequenceFlow.setSkipExpression(xtr.getAttributeValue(null, ATTRIBUTE_FLOW_SKIP_EXPRESSION));

    parseChildElements(getXMLElementName(), sequenceFlow, model, xtr);

    return sequenceFlow;
  }
  1. 首先实例化SequenceFlow对象，在解析过程中会将相应属性填充进该对象
  2. 解析位置信息
  3. 解析属性，包括sourceRef、targetRef、skipExpression，当然还有常用属性name等
  4. 解析子元素
醉引花眠
关注
专栏目录
Activiti 工作流引擎 详解
nana1253431195的博客
09-09 3249
深知大多数初中级Java工程师，想要提升技能，往往是自己摸索成长或者是报班学习，但对于培训机构动则近万的学费，着实压力不小。自己不成体系的自学效果低效又漫长，而且极易碰到天花板技术停滞不前！因此收集整理了一份《Java开发全套学习资料》送给大家，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。
activiti资料.zip
08-13
深入研究Activiti源码有助于理解其内部机制，如流程引擎如何解析BPMN 2.0模型，以及如何执行流程实例。 3.2 视频教程 “视频1、视频2、视频3、视频4”可能涵盖了Activiti的基础知识、安装配置、流程设计、实际案例...
Activiti5.2版
11-21
Activiti5.2版本，由于官网更新速度飞快，使用低版本可向上兼容，故上传老版本供大家使用
工作流引擎初化配置流程(源码分析)
CBC Java技术博客
06-07 153
01-开篇：重新认识 bpmn.js 与 BPMN 规范
最新发布
weixin_31899339的博客
08-27 351
预览：Flowable 编辑器：flowable-designer，Activiti 编辑器：activiti-designer，预览与模拟：viewer，DMN决策设计器：dmn 在正式开始介绍 bpmn.js 源码之前，我想先向大家介绍一下与 bpmn.js 相关的一些概念。根据官网介绍，bpmn.js 作为符...
Activiti 5.2 版本下载
12-11
Activiti 5.2 版本下载
activiti-explorer for5.2
05-16
这是activiti-5.20.0版本的activiti-explorer，数据源改为了JNDI，数据库部署好之后，把本war包放到tomcat里面，然后修改activiti-explorer\META-INF\context.xml里面的数据库配置。
完整工作流系统源码
12-11
工作流资料,需求分析,源码实例
Activiti 5.2工作流引擎源码解析：引擎初始化详解
"这篇资料主要关注的是Activiti-5.2版本的工作流引擎，通过源码解析来深入了解其内部机制。Activiti是一个流行的开源工作流引擎，用于在企业应用程序中实现业务流程自动化。资料涵盖了从整体结构到引擎初始化等多个...
activiti-5.22.0.zip下载
12-31
Activiti 是一个开源的工作流和业务流程管理（BPM）平台，它被广泛应用于企业级应用中，以实现流程自动化和提升工作效率。标题中的 "activiti-5.22.0.zip" 指的是 Activiti 的特定版本，即 v5.22.0，这是一个压缩包...
开源工作流Fireflow源码分析之流程文件解析
weixin_30352191的博客
06-04 248
Java要解析xml并不困难，fireflow的作者是采用dom4j来解析.具体解析的类为:Dom4JPDLParser,另外还有一个类Dom4JFPDLSerializer,它的作用是将工作流模型写成Xml. 1):如何配置xml解析器的，作者提供了两个模式，一个是开发阶段用的definitionService4FileSystem,一个是实施阶段的definitionServi...
Activiti用户手册中文版V5.21
04-25
activiti用户手册中文版-项目经理推荐,兼容5.21以下版本
Activiti V5.21 用户手册 中文版(全)
05-28
Activiti使用 the Apache V2 license 协议开源。 Activiti Modeler（Web设计器）使用了另一个开源协议 the LGPL 2.1 license,此文档为5.21.0版本对应的文档
基于springboot开发的工作流系统，bpmn.js，vue源码及功能分析（activiti）
2301_81867536的博客
01-30 835
本项目拥有用户管理，部门管理，代码生成，系统监管，报表，大屏展示，业务审批等功能。功能太强大，只能粗矿的介绍，所见即所得，体验一下吧。
Activiti 流程启动及节点流转源码分析
weixin_33749242的博客
04-23 468
作者：jiankunking 出处：http://blog.csdn.net/jiankunking 本文主要是以activiti-study中的xiaomage.xml流程图为例进行跟踪分析 具体的流程图如下： 流程图对应的XML文件如下： <?xml version="1.0" encoding="UTF-...
【工作流Activiti7】6、Activiti 7 源码学习
wufaqidong1的博客
12-25 4809
1. 启动分析源码版本是 7.1.0.M6首先从 ProcessEngineAutoConfiguration 开始ProcessEngineAutoConfiguration 是activiti-spring-boot-starter 7.1.0.M6自动配置的入口类，在这里主要看 SpringProcessEngineConfiguration主要是配置了自动部署最最最重要的是 buildProcessEngine() 方法，将来根据配置构建 ProcessEngine 的时候它就派上用场了 下面
activiti开源工作流集成示例
pxzsky的专栏
07-26 978
开源activiti工作流引擎集成示例
Activity工作过程源码分析
weixin_36234344的博客
07-25 430
Activity是Android四大组件之一，它作为一个展示型的组件，在Android世界里起到了重要作用。它可以与用户交互，将用户信息反馈给后台，可以说，用户每天面对的app界面都是由activity制作的。作为一个不想当咸鱼的程序员，只了解activity的生命周期，启动模式是不够的，还需要更加深入的了解，那么问题来了，作为Android四大组件之一，它是如何启动的呢？ 那么这篇文章，我将从源码
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值