TOMCAT源码分析-生命周期管理2

时间:2021-09-05 08:58:48

容器生命周期

每个容器都会有自身的生命周期,其中也涉及状态的迁移,以及伴随的事件生成,本节详细介绍Tomcat中的容器生命周期实现。所有容器的转态转换(如*、初始化、启动、停止等)都是由外到内,由上到下进行,即先执行父容器的状态转换及相关操作,然后再执行子容器的转态转换,这个过程是层层迭代执行的。

容器新建

所有容器在构造的过程中,都会首先对父类LifecycleBase进行构造。LifecycleBase中定义了所有容器的起始状态为LifecycleState.NEW,代码如下:

TOMCAT源码分析-生命周期管理2

容器初始化

  每个容器的init方法是自身初始化的入口,其初始化过程如图4所示。


TOMCAT源码分析-生命周期管理2
图4  容器初始化时序图


图4中所说的具体容器,实际就是LifecycleBase的具体实现类,目前LifecycleBase的类继承体系如图5所示。


TOMCAT源码分析-生命周期管理2
图5  LifecycleBase的类继承体系


根据图4所示的初始化过程,我们对Tomcat的源码进行分析,其处理步骤如下:


1. 调用方调用容器父类LifecycleBase的init方法,LifecycleBase的init方法主要完成一些所有容器公共抽象出来的动作;


2. LifecycleBase的init方法调用具体容器的initInternal方法实现,此initInternal方法用于对容器本身真正的初始化;


3. 具体容器的initInternal方法调用父类LifecycleMBeanBase的initInternal方法实现,此initInternal方法用于将容器托管到JMX,便于运维管理;


4. LifecycleMBeanBase的initInternal方法调用自身的register方法,将容器作为MBean注册到MBeanServer;


5. 容器如果有子容器,会调用子容器的init方法;


6. 容器初始化完毕,LifecycleBase会将容器的状态更改为初始化完毕,即LifecycleState.INITIALIZED。


现在对容器初始化的源码进行分析,init方法的实现见代码清单6。


代码清单6

TOMCAT源码分析-生命周期管理2

代码清单6说明,只有当前容器的状态处于LifecycleState.NEW的才可以被初始化,真正执行初始化的方法是initInternal,当初始化完毕,当前容器的状态会被更改为LifecycleState.INITIALIZED。为了简便起见,我们还是以StandardServer这个容器为例,StandardServer的initInternal方法的实现见代码清单7。


代码清单7

TOMCAT源码分析-生命周期管理2

通过分析StandardServer的initInternal方法,其处理过程如下:

步骤一 将当前容器注册到JMX

  调用父类LifecycleBase的initInternal方法(见代码清单8),为当前容器创建DynamicMBean,并注册到JMX中。


代码清单8

TOMCAT源码分析-生命周期管理2

StandardServer实现的getObjectNameKeyProperties方法如下:

TOMCAT源码分析-生命周期管理2

LifecycleBase的register方法(见代码清单9)会为当前容器创建对应的注册名称,以StandardServer为例,getDomain默认返回Catalina,因此StandardServer的JMX注册名称默认为Catalina:type=Server,真正的注册在registerComponent方法中实现。

代码清单9

TOMCAT源码分析-生命周期管理2

Registry的registerComponent方法会为当前容器(如StandardServer)创建DynamicMBean,并且注册到MBeanServer,见代码清单10。

代码清单10

TOMCAT源码分析-生命周期管理2

TOMCAT源码分析-生命周期管理2

步骤二 将StringCache、MBeanFactory、globalNamingResources注册到JMX

从代码清单7中已经列出。其中StringCache的注册名为Catalina:type=StringCache,MBeanFactory的注册名为Catalina:type=MBeanFactory,globalNamingResources的注册名为Catalina:type=NamingResources。


步骤三 初始化子容器

从代码清单7中看到StandardServer主要对Service子容器进行初始化,默认是StandardService。


注意:个别容器并不完全遵循以上的初始化过程,比如ProtocolHandler作为Connector的子容器,其初始化过程并不是由Connector的initInternal方法调用的,而是与启动过程一道被Connector的startInternal方法所调用。


容器启动

每个容器的start方法是自身启动的入口,其启动过程如图6所示。


TOMCAT源码分析-生命周期管理2
图6  容器启动时序图

根据图6所示的启动过程,我们对Tomcat的源码进行分析,其处理步骤如下:


1.调用方调用容器父类LifecycleBase的start方法,LifecycleBase的start方法主要完成一些所有容器公共抽象出来的动作;


2.LifecycleBase的start方法先将容器状态改为LifecycleState.STARTING_PREP,然后调用具体容器的startInternal方法实现,此startInternal方法用于对容器本身真正的初始化;


3.具体容器的startInternal方法会将容器状态改为LifecycleState.STARTING,容器如果有子容器,会调用子容器的start方法启动子容器;


4.容器启动完毕,LifecycleBase会将容器的状态更改为启动完毕,即LifecycleState.STARTED。


现在对容器启动的源码进行分析,start方法的实现见代码清单11。


代码清单11

TOMCAT源码分析-生命周期管理2
TOMCAT源码分析-生命周期管理2

代码清单11说明在真正启动容器之前需要做2种检查:

  1. 如果当前容器已经处于启动过程(即容器状态为LifecycleState.STARTING_PREP、LifecycleState.STARTING、LifecycleState.STARTED)中,则会产生并且用日志记录LifecycleException异常并退出。

  2. 如果容器依然处于LifecycleState.NEW状态,则在启动之前,首先确保初始化完毕。
    代码清单11还说明启动容器完毕后,需要做1种检查,即如果容器启动异常导致容器进入LifecycleState.FAILED或者LifecycleState.MUST_STOP状态,则需要调用stop方法停止容器。
    现在我们重点分析startInternal方法,还是以StandardServer为例,其startInternal的实现见代码清单12所示。

    代码清单12

    TOMCAT源码分析-生命周期管理2

    从代码清单12看到StandardServer的启动由以下步骤组成:

    1.产生CONFIGURE_START_EVENT事件;
    2.将自身状态更改为LifecycleState.STARTING;
    3.调用子容器Service(默认为StandardService)的start方法启动子容器。
    除了初始化、启动外,各个容器还有停止和销毁的生命周期,其原理与初始化、启动类似,本文不再赘述,有兴趣的读者可以自行研究。
    Tomcat启动完毕后,打开Java visualVM,打开Tomcat进程监控,给visualVM安装MBeans插件后,选择MBeans标签页可以对Tomcat所有注册到JMX中的对象进行管理,比如StandardService就向JMX暴露了start和stop等方法,这样管理员就可以动态管理Tomcat,如图7所示。
    TOMCAT源码分析-生命周期管理2
    图7  使用JMX动态管理Tomcat


    总结

     Tomcat通过将内部所有组件都抽象为容器,为容器提供统一的生命周期管理,各个子容器只需要关心各自的具体实现,这便于Tomcat以后扩展更多的容器,对于研究或者学习Tomcat的人来说,其设计清晰易懂。