1. 启动分析
源码版本是 7.1.0.M6
首先从 ProcessEngineAutoConfiguration 开始
ProcessEngineAutoConfiguration 是activiti-spring-boot-starter 7.1.0.M6自动配置的入口类,在这里主要看SpringProcessEngineConfiguration
主要是配置了自动部署
最最最重要的是 buildProcessEngine() 方法,将来根据配置构建 ProcessEngine 的时候它就派上用场了
ProcessEngine processEngine = ProcessEngineConfiguration.createProcessEngineConfigurationFromResourceDefault().buildProcessEngine();
下面重点看一下如何构建 ProcessEngine
在父类(ProcessEngineConfigurationImpl)的 buildProcessEngine() 里调用了一个非常重要的方法 init()
可以看到在init()方法里初始化了很多组件,接下来挑几个来重点看一下
initAgendaFactory()
initCommandContextFactory()
new了一个CommandContextFactory,重要的是CommandContextFactory中持有当前processEngineConfiguration的引用
initCommandExecutors()
初始化拦截器interceptor要重点说下,这里构造了一个拦截器链,而且拦截器链的最后是CommandInvoker,并且将第一个拦截器放到CommandExecutor里面,姑且先记下,后面有用到
initServices()
initBehaviorFactory()
在初始化各个组件以后,new了一个ProcessEngineImpl,并将当前的配置 ProcessEngineConfigurationImpl 赋值给它
因此,这个代表流程引擎的ProcessEngine就变成了一个基础的入口类,它提供了对工作流操作的所有服务的访问。
2. CommandContextInterceptor
在默认的拦截器中有一个 CommandContextInterceptor 特别重要
在其execute()方法中设置上下文CommandContext
- 查找栈顶部的元素,如果为空,则新new一个CommandContext,如果不为空,则将获取到的CommandContext的熟悉reused设为true
- 将刚才获取到的CommandContext压入栈中
- 将当前processEngineConfiguration压入另一个栈中
- 调用下一个拦截器
也就是说,每个命令在经过CommandContextInterceptor后都有了自己的上下文
那么,CommandContext中到底有什么呢?继续看
CommandContext中有命令(Command),还有agenda(ActivitiEngineAgenda)
3. Command
Activiti这里采用命令模式,将操作以及与之相关的信息都封装成命令。
下面以完成任务为例来看一下命令是如何被完成的
前面初始化services的时候说过了,会将创建好的CommandExecutor设置到各个Service中,因此TaskService中commandExecutor的出现就不足为奇了
可以看到,完成任务的时候,直接new了一个CompleteTaskCmd,然后交由commandExecutor去执行
CompleteTaskCmd主要有两个属性:任务ID 和 流程变量
既然命令交给了CommandExecutor执行,那么接下来看下它是如何执行的。
在前面 initCommandExecutor() 的时候我们指定,它其实是 CommandExecutorImpl,并且我们还知道它持有默认的命令配置,以及拦截器链中的第一个拦截器
从代码中可以看到 CommandExecutorImpl#execute() 直接从拦截器链中的第一个拦截器开始往后依次调用。可以预见到,它肯定会经过CommandContextInterceptor,于是在当前请求线程的局部变量中就会有一个栈(Stack),在栈的顶部放了一个CommandContext,在这个CommandContext中有待执行的Command,有processEngineConfiguration,还有agenda。
它这个CommandContext被设计成是每个线程私有的,就是每个线程都有自己的一个CommandContext
在线程局部变量中存放这栈,栈里面放着对象
拦截器链的最后一个拦截器是 CommandInvoker
4. CommandInvoker
重头戏来了,接下来 CommandInvoker 的每个方法都要仔细看了
可以看到,真正去执行命令是在CommandInvoker中触发的
5. Agenda
agenda (译:议程,待议事项,议事日程)的意思是“议程”,“会议议程”,“待议事项”
可以把 agenda 想象成是一个会议,首先每个命令请求都有一个 CommandContext,CommandContext里面有Agenda
这样的话,CommandContext 相当于会议室,Agenda 相当于这次会议的议程,就是这次会议要商议的事项有哪些,每个 Operation 相当于一个待议事项,在会议进行期间会不断产生很多新的事项,然后一个一个事项的过,直到所有的事项都处理完了。
也可以把 agenda 想象成线程池,不断有新的任务被丢进线程池,工作线程就不断从工作队列中取任务执行
还是 “会议室 –> 会议 –> 议程 –> 事项 –> 处理事项”更加形象生动
每个命令请求就相当于发起一次会议,会议的目的是处理这次的命令请求。为了开会讨论解决问题,需要有个会议室,然后发起会议,会议上有很多要解决的问题,一个一个解决问题,直到所有问题都被解决,会议结束
每个待议事项都是一个 Runnable 类型的对象,注意别搞混了,Runnable 本身不是线程。我个人猜测,之所以设计成Runnable类型的主要是为了方便异步处理,我们可以配置Activiti的活动是同步还是异步执行,而直接调用Runnable的run()方法就是同步执行,把它放到线程池就是异步执行,业务处理的逻辑都在run()方法里,完全不用关心是同步还是异步执行,这种设计太绝了,妙啊。。。(PS:纯属个人猜测,没有求证过,O(∩_∩)O哈哈~)
命令执行的结果放到会议室(CommandContext)
活动结束后,会调用planContinueProcessOperation(),流程继续执行,进入下一个活动节点
6. CompleteTaskCmd
回到最初的完成任务命令,我们指定任务执行调用的Runnable的run()方法,run()方法里面是调用命令的execute方法
所以,接下来看完成任务这个命令具体做了什么
7. ActivityBehavior
要理解 Behavior 必须要和流程图联系起来,流程图上的一些元素比如 网关、用户任务、子流程、事件等等都有对应的行为,每种行为的处理方式都不同
ActivityBehavior 的实现类比较多,层级也比较深,不一一列举,以其中一个为例看看就行了
继续回到完成任务,刚才看到往agenda中放了一个 TriggerExecutionOperation,该操作触发等待状态并继续该流程,并离开该活动。
8. 回顾
Command:命令
ActivitiEngineAgendaFactory:用于创建ActivitiEngineAgenda
ActivitiEngineAgenda:议程,待议事项,用于循环执行Operation
AbstractOperation:事项/操作,它实现了Runnable接口
CommandContextFactory:用于创建CommandContext
CommandContext:每个命令执行线程都有自己的CommandContext,其内部有对Command和Agenda的引用
CommandExecutor:执行Command,从拦截器链的第一个拦截器开始执行
CommandInvoker:拦截器链上的最后一个拦截器,负责将命令封装成Operation,在Agenda中执行Operation的时候就会调用具体命令的execute方法
ActivityBehavior:代表活动的行为,这是真正底层的驱动流程流转的核心