tomcat组件生命周期

﹏ヽ暗。殇╰゛Y 2022-08-07 02:50 16阅读 0赞

版本：apache-tomcat-7.0.53

Tomcat中组件都有各自的生命周期，从组件的初始化开始，到组件的销毁，在不同的生命周期阶段中，组件会完成不同的任务，每个阶段都对应一个状态，而状态的转换会触发相应的事件。

组件事件类型

<table> 
 <tbody> 
 <tr> 
 <td> 组件状态 </td> 
 <td> 触发事件 </td> 
 <td> 事件编码值 </td> 
 <td> 说明 </td> 
 </tr> 
 <tr> 
 <td> NEW </td> 
 <td> &nbsp; </td> 
 <td> &nbsp; </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> INITIALIZING </td> 
 <td> BEFORE_INIT_EVENT </td> 
 <td> before_init </td> 
 <td> 代表组件初始化之前触发的事件 </td> 
 </tr> 
 <tr> 
 <td> INITIALIZED </td> 
 <td> AFTER_INIT_EVENT </td> 
 <td> after_init </td> 
 <td> 代表组件初始化之后触发的事件 </td> 
 </tr> 
 <tr> 
 <td> STARTING </td> 
 <td> START_EVENT </td> 
 <td> start </td> 
 <td> 组件正在开启时触发的事件 </td> 
 </tr> 
 <tr> 
 <td> STARTING_PREP </td> 
 <td> BEFORE_START_EVENT </td> 
 <td> before_start </td> 
 <td> 组件开启之前触发的事件 </td> 
 </tr> 
 <tr> 
 <td> STARTED </td> 
 <td> AFTER_START_EVENT </td> 
 <td> after_start </td> 
 <td> 组件开启之后触发的事件 </td> 
 </tr> 
 <tr> 
 <td> STOPPING </td> 
 <td> STOP_EVENT </td> 
 <td> stop </td> 
 <td> 组件正在停止时触发的事件 </td> 
 </tr> 
 <tr> 
 <td> STOPPING_PREP </td> 
 <td> BEFORE_STOP_EVENT </td> 
 <td> before_stop </td> 
 <td> 组件停止之前触发的事件 </td> 
 </tr> 
 <tr> 
 <td> STOPPED </td> 
 <td> AFTER_STOP_EVENT </td> 
 <td> after_stop </td> 
 <td> 组件停止之后触发的事件 </td> 
 </tr> 
 <tr> 
 <td> DESTROYED </td> 
 <td> AFTER_DESTROY_EVENT </td> 
 <td> after_destroy </td> 
 <td> 组件销毁之后触发的事件 </td> 
 </tr> 
 <tr> 
 <td> DESTROYING </td> 
 <td> BEFORE_DESTROY_EVENT </td> 
 <td> before_destroy </td> 
 <td> 组件销毁之前触发的事件 </td> 
 </tr> 
 <tr> 
 <td> &nbsp; </td> 
 <td> PERIODIC_EVENT </td> 
 <td> periodic </td> 
 <td> 组件正在执行定期任务的时候触发的事件 </td> 
 </tr> 
 <tr> 
 <td> STARTING </td> 
 <td> CONFIGURE_START_EVENT </td> 
 <td> configure_start </td> 
 <td> 组件开始解析配置文件的时候触发的事件 </td> 
 </tr> 
 <tr> 
 <td> STOPPING </td> 
 <td> CONFIGURE_STOP_EVENT </td> 
 <td> configure_stop </td> 
 <td> 组件解析配置文件之后候触发的事件 </td> 
 </tr> 
 <tr> 
 <td> FAILED </td> 
 <td> &nbsp; </td> 
 <td> &nbsp; </td> 
 <td> 组件启动失败的状态 </td> 
 </tr> 
 <tr> 
 <td> MUST_STOP </td> 
 <td> &nbsp; </td> 
 <td> &nbsp; </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> MUST_DESTROY </td> 
 <td> &nbsp; </td> 
 <td> &nbsp; </td> 
 <td> &nbsp; </td> 
 </tr> 
 </tbody> 
</table>

组件状态转换图

![20150301184547295][]

1、当该组件的start( )方法被调用，如果该组件的状态为NEW，程序会先调用该组件的init( )方法进行初始化工作，状态从NEW转换为INITIALIZING，再到INITIALIZED，如果该组件已经初始化过了，调用start( )方法，状态直接为STARTING\_PREP，

2、图中组件从一个状态到下一个状态，可以是调用该组件的某个方法，也可以是自动完成。比如图中INITIALIZED状态到STARTING\_PREP状态，需要其他的组件调用该组件的start()方法；组件从STARTING\_PREP状态到STARTING状态，这个过程是调用start()方法之后，组件内部自动完成的动作。

组件生命周期类图

以下是以tomcat中StandardServer组件为例，画出该组件的类图。

![20150301184558448][]

1、Lifecycle，该接口声明该组件支持哪些事件，以及为组件生命周期定义了一组公共的接口，组件类需要实现这些接口，这样可以为组件的生命周期中的开启和停止操作提供一种一致的机制。

2、LifecycleBase，该类是Lifecycle接口的基本实现，对start()、stop()和destroy()方法提供了一组基础的实现，

3、MBeanRegistration，该接口定义了一组接口，支持将对象注册到MBean server，

4、LifecycleMBeanBase，该抽象类继承了LifecycleBase类和实现了MBeanRegistration接口，表明该组件除了能够控制生命周期不同阶段外，还能将自身注册到MBean server的功能,

5、Server，一个Server组件就代表了一个servlet容器，

6、StandardServer，一个Server接口的标准实现，它继承了LifecycleMBeanBase，实现了Server接口，

组件初始化状态转换

以StandardServer组件的初始化过程为例，画出如下时序图，

![20150301184542881][]

实际上StandardServer类是继承自LifecycleMBeanBase，而LifecycleMBeanBase又继承自LifecycleBase，当其他的组件在调用init()方法的时候，是调用的是StandardServer

方法的init()方法，为了能够清晰的看出调用过程和说明问题，故意将此init调用是从LifecycleBase开始。其他的组件调用StandardServer的初始化方法，开始server的初始化，在init方法中做了3件事，

第一是调用setStateInternal()方法将StandardServer组件的状态从NEW修改为INITIALIZING，

第二是调用StandardServer组件自身的initInternal()方法，在initInternal方法中StandardServer又做了两件事情，a、调用父类LifecycleMBeanBase的initInternal()方法，父类的该方法主要完成对StandardServer组件的注册，注册到MBen Server中，b、调用StandardServer组件中关联的其他组件的init()方法，已完成对其他组件的初始化。

第三是再次调用setStateInternal()方法将StandardServer组件的状态修改为INITIALIZED。

通过以上这三步完成对StandardServer组件的初始化工作。Tomcat中还有很多的组件，这些组件都直接继承了LifecycleMBeanBase类，间接继承了LifecycleBase，LifecycleBase类规定了初始化的流程，而LifecycleMBeanBase类完成了组件的注册工作，这两件事情都是固定不变的，而变化的部分，从以上时序图中第3步可以看出，这些组件只需要实现自己的initInternal()方法，在该方法中首先调用父类的initInternal()方法完成注册，其次再写自己的初始化代码，就可以完成自己的初始化工作。

组件生命周期中的开启过程也是相似的，相比初始化的过程，少了调用父类LifecycleMBeanBase的方法。

![20150301184548076][]

组件事件的触发过程

![20150301184617129][]

1、LifecycleBase，LifecycleBase是一个组件的父类，所有组件对于监听器注册和事件的发送都在该父类中完成。LifecycleBase负责将监听器注册到LifecycleSupport对象中。

2、StandardContext，StandardContext是LifecycleBase的一个子类，一个StandardContext就代表着tomcat中一个webapp应用，

3、LifecycleSupport，每一个组件对象中都会有一个对应的LifecycleSupport对象，该对象中拥有对应组件的事件监听器集合，也就是说LifecycleSupport对象知道有哪些监听器在监听组件发出的事件。

4、LifecycleListener，监听器接口，声明了一个处理事件的接口。

5、ContextConfig，一个监听器的具体实现，该监听器监听着StandardContext组件状态的转变，

事件监听器注册

![20150301184620972][]

向StandardContext组件中添加一个ContextConfig事件监听器，可以调用StandardContext组件的addLifecycleListener()方法，

@Override
 public void addLifecycleListener(LifecycleListener listener) {
 lifecycle.addLifecycleListener(listener);
 }

Lifecycle对象是StandardContext组件中一个成员变量，它的声明如下：

private LifecycleSupport lifecycle = new LifecycleSupport(this);

向StandardContext组件中添加事件监听器，StandardContext组件会间接将该监听器通过调用LifecycleSupport 对象的addLifecycleListener方法注册到LifecycleSupport 对象，LifecycleSupport 对象拥有一个监听器集合，

private LifecycleListener listeners[] = new LifecycleListener[0];

该集合存放着StandardContext组件所有的事件监听器。

触发事件

![20150301184609900][]

在StandardContext对象的startInternal()方法中，调用fireLifecycleEvent方法，触发一个CONFIGURE\_START\_EVENT事件，

@Override
        protected synchronized void startInternal() throws LifecycleException {
            ......
                    //ContextConfig 监听该事件，主要完成解析和web应用有关的所有web.xml配置
                    fireLifecycleEvent(Lifecycle.CONFIGURE_START_EVENT, null);
         ...... 
    }
        /**
         * 将该事件发送出去，由lifecycle负责发送
         * @param type  Event type
         * @param data  Data associated with event.
         */
        protected void fireLifecycleEvent(String type, Object data) {
            lifecycle.fireLifecycleEvent(type, data);
        }

在LifecycleSupport类的fireLifecycleEvent方法中，调用每个监听器的lifecycleEvent()方法，，将该事件发送给所有的事件监听器，

/**
 * Notify all lifecycle event listeners that a particular event has
 * occurred for this Container. The default implementation performs
 * this notification synchronously using the calling thread.
 *
 * @param type Event type
 * @param data Event data
 */
 public void fireLifecycleEvent(String type, Object data) {
 
 LifecycleEvent event = new LifecycleEvent(lifecycle, type, data);
 LifecycleListener interested[] = listeners;
 for (int i = 0; i < interested.length; i++){
 	interested[i].lifecycleEvent(event);
 }
 
 }

在事件监听器ContextConfig接受到事件之后，在lifecycleEvent方法中，有选择地处理感兴趣的事件，

@Override
        public void lifecycleEvent(LifecycleEvent event) {
     
            // 从event事件对象中获取发送该事件的事件源
            try {
                context = (Context) event.getLifecycle();
            } catch (ClassCastException e) {
                log.error(sm.getString("contextConfig.cce", event.getLifecycle()), e);
                return;
            }
     
            // 处理感兴趣的事件
            if (event.getType().equals(Lifecycle.CONFIGURE_START_EVENT)) {
                configureStart();
            } else if (event.getType().equals(Lifecycle.BEFORE_START_EVENT)) {
                beforeStart();
            } else if (event.getType().equals(Lifecycle.AFTER_START_EVENT)) {
                if (originalDocBase != null) {
                    context.setDocBase(originalDocBase);
                }
            } else if (event.getType().equals(Lifecycle.CONFIGURE_STOP_EVENT)) {
                configureStop();
            } else if (event.getType().equals(Lifecycle.AFTER_INIT_EVENT)) {
                init();
            } else if (event.getType().equals(Lifecycle.AFTER_DESTROY_EVENT)) {
                destroy();
            }
        }

[20150301184547295]: /images/20220805/3d74411b17e34c8bb9d5851062c895ea.png
[20150301184558448]: /images/20220805/ccd513c5f6c84cadb6794384d58c290f.png
[20150301184542881]: /images/20220805/3333afe2f1e442e480ecfb7329242307.png
[20150301184548076]: /images/20220805/2dc1444c98fe466fa542d1a7a1695cf8.png
[20150301184617129]: /images/20220805/9cacf8421d5a4259a3fcac5ea4bd36da.png
[20150301184620972]: /images/20220805/6def5a3582904e208a47f372c45acfa1.png
[20150301184609900]: /images/20220805/52e1c72307434f22998366cfca09824e.png