Tomcat源码分析(阀门)

1.Tomcat组件及关系

Server
   --Service
        --Connector
        --Engine
            --Host
                 --Context
                     --Wrapper(Servlet)

Server代表Tomcat应用服务器，它可以包含多个Service服务；一个Service服务包含多个Connector和一个Engine；一个Engine可以包含多个虚拟主机Host；一个Host可以包含多个Web应用Context，而每个Web下有可以包含多个Wrapper(Servlet的包装器)
组件及其关系可以参考Tomcat的Server.xml及Web.xml文件


2.当一个请求到达时，Connector会把它包装成Request对象，同时生成Response对象；然后Connector会调用Engine的invoke方法，它又会调用Host的invoke 方法，Host的invoke方法又会调用Context的invoke方法，最后，Context的invoke方法调用Wrapper的invoke方法，至此，责任链调用结束。


接口及实现:
a.Pipeline ， 此接口的实现主要用于维护阀门及先后关系，实现见  org.apache.catalina.core.StandardPipleline

 public interface Pipeline {
    
    //获取最后一个阀门 
    public Valve getBasic();
    
    //设置最后一个阀门
    public void setBasic(Valve valve);

    //添加阀门
    public void addValve(Valve valve);

    public Valve[] getValves();

    public void removeValve(Valve valve);

    //获取第一个阀门
    public Valve getFirst();

}  

b.Valve ， 阀门接口，主要用于做过滤工作

  public interface Valve {

    public String getInfo();

    //获取下一个阀门
    public Valve getNext();

    //设置下一个阀门
    public void setNext(Valve valve);

    public void backgroundProcess();

    //阀门过滤
    public void invoke(Request request, Response response)
        throws IOException, ServletException;

}

c.下面是与责任链有关的实现代码，以Engine的标准实现StandardEngine为例

StandardEngine{
    
    public StandardEngine() {
        super();
        //设置StandardEngineValve为Engine的最后一个阀门
        pipeline.setBasic(new StandardEngineValve()); 
    }
    
   //添加阀门
    public synchronized void addValve(Valve valve) {
        pipeline.addValve(valve);
    }

    //此方法被Connector调用
    public void invoke(Request request, Response response)
        throws IOException, ServletException {
        pipeline.getFirst().invoke(request, response);
    }
}

  
d.StandardEngine简单阀门的实现

SimpleValve implements Valve{
   ....
   //阀门过滤方法
    public void invoke(Request request, Response response)
        throws IOException, ServletException{
       //do something
       //调用下一个阀门的invoke方法
       getNext().invoke(Request request, Response response);
       //do something
   }
}

e.StandardEngine最后一个阀门(StandardEngineValve)的实现

StandardEngineValve extends ValveBase{
   ...
   public void invoke(Request request, Response response)
        throws IOException, ServletException{
        Host host = request.getHost();
        
        //至此，StandardEngine中的阀门都已处理完毕，下面把request、
         //response对象交给host处理
        host.getPipeline().getFirst().invoke(request, response);
}

c,d,e代码即为StandardEngine责任链调用的主要代码，Host、Context、Wrapper的责任链调用相关代码与其类似，阀门可以在Server.xml及Web.xml中配置