转载

死磕Tomcat系列(5)——容器

回顾

在死磕Tomcat系列(1)——整体架构中我们简单介绍了容器的概念，并且说了在容器中所有子容器的父接口是 Container 。在死磕Tomcat系列(2)——EndPoint源码解析中，我们知道了连接器将请求过来的数据解析成Tomcat需要的 ServletRequest 对象给容器。那么容器又是如何将这个对象准确的分到到对应的请求上去的呢？

容器的整体设计

Container 是容器的父接口，所有子容器都需要实现此接口，我们首先看一下 Container 接口的设计。

public interface Container extends Lifecycle {
    public void setName(String name);
    public Container getParent();
    public void setParent(Container container);
    public void addChild(Container child);
    public void removeChild(Container child);
    public Container findChild(String name);
}

Tomcat是如何管理这些容器的呢？我们可以通过接口的设计可以了解到是通过设置父子关系，形成一个树形的结构（一父多子）、链式结构（一父一子）来管理的。一想到树形的结构我们应该就立马能够联想到设计模式中的组合模式，而链式结构我们应该能够想到设计模式中的责任链设计模式。无论这两种的哪一种我们都知道这种关系是上下层级的关系。用图来表示就是如下。

死磕Tomcat系列(5)——容器

既然是父子的结构，那么连接器是如何将转换好的 ServletRequest 给到容器的呢？我们可以看 CoyoteAdapter 中的 service 方法。因为在连接器中最后一环是将解析过的 Request 给到Adapter运用适配器设计模式解析为 ServletRequest 对象。在 service 方法中我们看到有这么一句。

connector.getService().getContainer().getPipeline().getFirst().invoke(
                        request, response);

而其中的 getContainer 方法，返回的是 Engine 对象

public Engine getContainer();

这里看到了 Pipeline ， Pipeline 应该大家有所熟悉，是管道的概念，那么管道里面装的是什么呢？我们看其定义的方法

public interface Pipeline extends Contained {
  public void addValve(Valve valve);
  public Valve getBasic();
  public void setBasic(Valve valve);
  public Valve getFirst();
}

可以看到 Pipeline 管道里面装的是 Valve ，那么Valve是如何组织起来的呢？我们也可以看它的代码定义

public interface Valve {
  public Valve getNext();
  public void setNext(Valve valve);
  public void invoke(Request request, Response response)
}

可以知道每个 Valve 都是一个处理点，它的 invoke 就是相对应的处理逻辑。可以看到有 setNext 的方法，因此我们大概能够猜到是通过链表将Valve组织起来的。然后将此Valve装入 Pipeline 中。因此每个容器都有一个 Pipeline ，里面装入系统定义或者自定义的一些拦截节点来做一些相应的处理。因此只要获得了容器中 Pipeline 管道中的第一个 Valve 对象，那么后面一系列链条都会执行到。

但是不同容器之间 Pipeline 之间是如何进行触发的呢？即例如 Engine 的 Pipeline 处理完了最后一个Valve，那么如何调用 Host 的 PipeLine 管道中的Valve呢？我们可以看到每个 Pipeline 中还有一个方法。 setBasic 这个方法设置的就是Valve链条的末端节点是什么，它负责调用底层容器的 Pipeline 第一个Valve节点。用图表示就是这样的。

死磕Tomcat系列(5)——容器

Engine容器

Engine容器比较简单，只是定义了一些基本的关联关系。它的实现类是 StandardEngine 。

@Override
    public void addChild(Container child) {
        if (!(child instanceof Host))
            throw new IllegalArgumentException
                (sm.getString("standardEngine.notHost"));
        super.addChild(child);
    }
    @Override
    public void setParent(Container container) {
        throw new IllegalArgumentException
            (sm.getString("standardEngine.notParent"));

    }

需要注意Engine容器是没有父容器的。如果添加是会报错。添加子容器也只是能添加 Host 容器。

Host 容器

Host容器是Engine的子容器，一个Host在Engine中代表一个虚拟主机，这个虚拟主机的作用就是运行多个应用，它负责安装和展开这个应用，并且标识这个应用以便能够区分它们。它的子容器通常是 Context 容器。我们可以看配置文件中也能够看出 Host 文件的作用。

<Host name="localhost"  appBase="webapps"
            unpackWARs="true" autoDeploy="true">

那么 Host 容器在启动时具体干了什么呢？我们看它的 startInternal 方法看不出来什么，只是启动了相应的 Valve ，是因为在Tomcat的设计中引入了生命周期的概念，即每个模块都有自己相应的生命周期，模块的生命周期定义有 NEW、INITIALIZING、INITIALIZED、SSTARTING_PREP、STARTING、STARTED ，每个模块状态的变化都会引发一系列的动作，那么这些动作的执行是直接写在 startInternal 中吗？这样会违反开闭原则，那么如何解决这个问题呢？开闭原则说的是为了扩展性系统的功能，你不能修改系统中现有的类，但是你可以定义新的类。

于是每个模块状态的变化相当于一个事件的发生，而事件是有相应的监听器的。在监听器中实现具体的逻辑，监听器也可以方便的增加和删除。这就是典型的观察者模式。

那么Host容器在启动的时候需要扫描webapps目录下面的所有Web应用，创建相应的Context容器。那么Host的监听器就是 HostConfig ，它实现了 LifecycleListener 接口

public interface LifecycleListener {

    public void lifecycleEvent(LifecycleEvent event);
}

接口中只定义了一个方法，即监听到相应事件的处理逻辑。可以看到在 setState 方法中调用了监听器的触发。

protected void fireLifecycleEvent(String type, Object data) {
    LifecycleEvent event = new LifecycleEvent(this, type, data);
    for (LifecycleListener listener : lifecycleListeners) {
        listener.lifecycleEvent(event);
    }
}

所以容器中各组件的具体处理逻辑是在监听器中实现的。

Context 容器

一个Context对应一个Web应用

Context代表的是Servlet的Context，它具备了Servlet的运行的基本环境。Context最重要的功能就是管理它里面的Servlet实例，Servlet实例在Context中是以Wrapper出现的。Context准备运行环境是在 ContextConfig 中 lifecycleEvent 方法准备的。

@Override
public void lifecycleEvent(LifecycleEvent event) {

    // Identify the context we are associated with
    try {
        context = (Context) event.getLifecycle();
    } catch (ClassCastException e) {
        log.error(sm.getString("contextConfig.cce", event.getLifecycle()), e);
        return;
    }

    // Process the event that has occurred
    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)) {
        // Restore docBase for management tools
        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();
    }
}

Wrapper容器

Wrapper容器代表一个Servlet，包括Servlet的装载、初始化、执行以及资源的回收。Wrapper是最底层的容器，它没有子容器。

Wrapper的实现类是 StandardWrapper ，主要任务是载入Servlet类，并进行实例化。但是 StandardWrapper 类并不会调用 Servlet 的 service 方法。而是 StandardWrapperValue 类通过调用 StandardWrpper 的 allocate 方法获得相应的servlet，然后通过拦截器的过滤之后才会调用相应的Servlet的service方法