阅读 201

吸猫就吸Tomcat之Pipeline-Valve巧妙设计

前言

于每一个Java工程师而言,tomcat这只小橘猫算是我们的老朋友了,同时tomcat作为一款服务器中间件具备了很强的扩展性,内部对于Request和Response的逻辑处理都是何种方式来实现的呢?本文将主要介绍tomcat的Pipeline-Valve设计来一窥究竟。

接口介绍

首先我们看看Valve接口

image-20190526123653021

可以从Valve看到很多链表的影子,我们可以根据Valve来构造一条Valve链。接下来看看Pipeline接口

Pipeline接口的主要方法

image-20190526120956032

可以看到Pipeline的主要方法提供了对Valve的增删查改操作,其中有两个关键的方法setBasic(Valve)与addValve(Valve)我们跟进源码看一看。其中StandardPipeline是Pipeline接口的实现类,下面我截取了setBasic最核心的逻辑,可以看出basic实际上就是Pipeline维护的Valve链里最末尾的一个Valve

Valve current = first;
while (current != null) {
if (current.getNext() == oldBasic) {
current.setNext(valve);
break;
}
current = current.getNext();
}

this.basic = valve;
复制代码

同样的我们来看一看addValve的源码,以下是最核心的部分

Valve current = first;
while (current != null) {
if (current.getNext() == basic) {
current.setNext(valve);
valve.setNext(basic);
break;
}
复制代码

通过addValve添加的Valve被加在了basic的前一个,也就是说basic永远指向Valve链里的最后一个Valve,不会被轻易替代,那么这种设计有什么意义呢?待会给出答案~

Valve到底是什么?

image-20190526133007212

上图都是Valve接口的实现类,包含了负载均衡、单点登录等tomcat容器本身的逻辑。通过查看Valve接口invoke方法的实现可以知道,每一个Valve的invoke方法主要做两件事情

  1. 本身的逻辑
  2. 通过getNext().invoke(request, response)调用下一个Valve的逻辑

这是很经典的责任链设计模式。简单的说一个valve就是一个逻辑体。

跟踪basic

image-20190526125355280

可以看到setBasic的使用方主要是tomcat内置的四大容器,Context、Engine、Host以及Wrapper,先简单对四大容器做个介绍

  • Wrapper:对Servlet定义的组件概念,一个Wrapper代表一个Servlet
  • Context:表示我们的应用程序,比如一个运行中Java Web程序,一个程序里面自然有多个Servlet,所以Conxtet和Wrapper的关系是1对n
  • Host:表示虚拟主机的概念,因为一台服务器不仅能够对product.yangkw.com提供服务,同时也可以对test.yangkw.com提供服务,同时每个虚拟主机都可以运行多个Java Web程序,所以Host和Context的关系也是1对n
  • Engine:Tomcat连接器(Connector) 将接收到的连接提交给Engine处理,作为整个Servlet引擎的组件概念,用来管理多个虚拟站点,Engine和Host也是一对n的关系

下面是关于四大容器一个简单的类图关系

image-20190526131102483

那么四大容器是如何被关联在一起的呢?StandardEngineValve是Engine容器的basic valve,笔者简化了代码实现,保留最主要的逻辑

@Override
public final void invoke(Request request, Response response)
throws IOException, ServletException {

// Select the Host to be used for this Request
Host host = request.getHost();

...
// Ask this Host to process this request
host.getPipeline().getFirst().invoke(request, response);

}
复制代码

可以看到Engine容器的basic valve负责触发host容器pipeline 答案出来了:每个容器的basic valve会去触发子容器的pipeline,所以basic作为一个valve不仅要执行自身相应的逻辑,同时也扮演了一个外交官的角色负责去和其子容器逻辑的对接。

总结

img

  • pipeline可以看做是valve的容器
  • 四大容器里每个容器都维护有自身专属的pipeline
  • basic负责触发子容器的第一个valve
  • wrapper的basic会去调用filter,然后再执行servlet的逻辑
  • FilterChain和Pipeline-Valve很相似,区别是filterChain是业务层面里的而Pipeline-Valve是tomcat自身层面的。

参考资料

  • 《Tomcat 架构解析》
  • 极客时间《深入拆解Tomcat&Jetty》
关注下面的标签,发现更多相似文章
评论