# 概述
Tomcat中对容器的抽象采用了模板模式，所有类型的容器均继承同一容器抽象对象，其生命周期的管理也是相同的，本文将对Tomcat9中容器的结构与生命周期进行浅析。
# 容器的生命周期
### 容器的结构
![在这里插入图片描述](https://img-blog.csdnimg.cn/20191024103736900.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RhaXdsMTk4OA==,size_16,color_FFFFFF,t_70)
上图为Tomcat容器的类图结构，所有容器会继承LifecycleMBeanBase，而基类LifecycleMBeanBase实现了两个接口，Lifecycle和MBeanRegistration，其中Lifecycle描述的容器的主要行为以及生命周期的变化，而MBeanRegistration则为Tomcat通过JMX进行监控。

org.apache.catalina.Lifecycle
![在这里插入图片描述](https://img-blog.csdnimg.cn/20191024104207101.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RhaXdsMTk4OA==,size_16,color_FFFFFF,t_70)
Lifecycle中主要的方法为init、start、stop、destory， Lifecycle包含12个状态，每个操作方法均对应状态的改变，构成了Tomcat容器的从初始创建到最终销毁的完整生命周期，Lifecycle的接口注释对此做出很好的解释。
```java
/*            start()
 *  -----------------------------
 *  |                           |
 *  | init()                    |
 * NEW -»-- INITIALIZING        |
 * | |           |              |     ------------------«-----------------------
 * | |           |auto          |     |                                        |
 * | |          \|/    start() \|/   \|/     auto          auto         stop() |
 * | |      INITIALIZED --»-- STARTING_PREP --»- STARTING --»- STARTED --»---  |
 * | |         |                                                            |  |
 * | |destroy()|                                                            |  |
 * | --»-----«--    ------------------------«--------------------------------  ^
 * |     |          |                                                          |
 * |     |         \|/          auto                 auto              start() |
 * |     |     STOPPING_PREP ----»---- STOPPING ------»----- STOPPED -----»-----
 * |    \|/                               ^                     |  ^
 * |     |               stop()           |                     |  |
 * |     |       --------------------------                     |  |
 * |     |       |                                              |  |
 * |     |       |    destroy()                       destroy() |  |
 * |     |    FAILED ----»------ DESTROYING ---«-----------------  |
 * |     |                        ^     |                          |
 * |     |     destroy()          |     |auto                      |
 * |     --------»-----------------    \|/                         |
 * |                                 DESTROYED                     |
 * |                                                               |
 * |                            stop()                             |
 * ----»-----------------------------»------------------------------
 */
```

下图为上一篇中Tomcat内部容器类结构图，可以看到各种类型的容器均实现了Lifecycle接口，各种类型容器按照机构进行聚合和组合，int()、start()等方法按照层级进行调用。
![在这里插入图片描述](https://img-blog.csdnimg.cn/20191024155904227.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RhaXdsMTk4OA==,size_16,color_FFFFFF,t_70)
### 观察者模式
容器的状态发生变化时，Tomcat采用观察者模式，触发注册在容器上的监听，下面以LifecycleBase.init()方法为例进行说明。

org.apache.catalina.util.LifecycleBase
```java
 @Override
    public final synchronized void init() throws LifecycleException {
        if (!state.equals(LifecycleState.NEW)) {
            invalidTransition(Lifecycle.BEFORE_INIT_EVENT);
        }

try {
            setStateInternal(LifecycleState.INITIALIZING, null, false);
            initInternal();
            setStateInternal(LifecycleState.INITIALIZED, null, false);
        } catch (Throwable t) {
            handleSubClassException(t, "lifecycleBase.initFail", toString());
        }
    }

//根据状态调用监听
private synchronized void setStateInternal(LifecycleState state, Object data, boolean check)
            throws LifecycleException {

...省略其他代码...

this.state = state;
        String lifecycleEvent = state.getLifecycleEvent();
        if (lifecycleEvent != null) {
            fireLifecycleEvent(lifecycleEvent, data);
        }
    }
    
 //调用监听
protected void fireLifecycleEvent(String type, Object data) {
        LifecycleEvent event = new LifecycleEvent(this, type, data);
        for (LifecycleListener listener : lifecycleListeners) {
            listener.lifecycleEvent(event);
        }
    }
```
- init()方法在实际方法执行前触发LifecycleState.INITIALIZING状态对应的监听，在实际方法执行后触发LifecycleState.INITIALIZED状态对应的监听
- 监听会在容器初始化时进行注册，例如在server.xml中server标签下的Listener标签
```xml
<Server port="8005" shutdown="SHUTDOWN">
  <Listener className="org.apache.catalina.startup.VersionLoggerListener" />
  
  
  <Listener className="org.apache.catalina.core.AprLifecycleListener" SSLEngine="on" />
  
  <Listener className="org.apache.catalina.core.JasperListener" />
  
  <Listener className="org.apache.catalina.core.JreMemoryLeakPreventionListener" />
  <Listener className="org.apache.catalina.mbeans.GlobalResourcesLifecycleListener" />
  <Listener className="org.apache.catalina.core.ThreadLocalLeakPreventionListener" />
```

# Tomcat运行时序图
![在这里插入图片描述](https://img-blog.csdnimg.cn/20191105140418872.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RhaXdsMTk4OA==,size_16,color_FFFFFF,t_70)

ITPub博客

Tomcat9源代码浅析-容器的结构与生命周期

最新文章