Tomcat 7 的一次請求分析(一)處理執行緒的產生

預流發表於2018-02-01

在預設的配置下Tomcat啟動好之後會看到後臺上總共有6個執行緒在執行。其中1個使用者執行緒,剩下5個為守護執行緒(如下圖所示)。

Tomcat 7 的一次請求分析(一)處理執行緒的產生
如果你對使用者執行緒、守護執行緒等概念不熟悉,請參看前一篇文章——Tomcat 7 伺服器關閉原理。 這裡重點關注以 http-bio-8080 開頭的兩個守護執行緒(即 http-bio-8080-Acceptor-0 和 http-bio-8080-AsyncTimeout ),因為這是我們在 Tomcat 的預設配置下發布 web 應用時實際處理請求的執行緒。先看下這兩個執行緒在容器啟動時是如何產生和啟動的。

在前面將 Tomcat 啟動的系列文章中看到 Tomcat 容器啟動時會用 Digester 讀取 server.xml 檔案產生相應的元件物件並採取鏈式呼叫的方式呼叫它們的 init 和 start 方法,在 Digester 讀取到 server.xml 中的 connector 節點時是這麼處理的:

        digester.addRule("Server/Service/Connector",
                         new ConnectorCreateRule());
        digester.addRule("Server/Service/Connector",
                         new SetAllPropertiesRule(new String[]{"executor"}));
        digester.addSetNext("Server/Service/Connector",
                            "addConnector",
                            "org.apache.catalina.connector.Connector");
複製程式碼

以上程式碼見org.apache.catalina.startup.Catalina類的 366 到 372 行。所以在碰到 server.xml 檔案中的 Server/Service/Connector 節點時將會觸發 ConnectorCreateRule 類的 begin 方法的呼叫:

     1	    public void begin(String namespace, String name, Attributes attributes)
     2	            throws Exception {
     3	        Service svc = (Service)digester.peek();
     4	        Executor ex = null;
     5	        if ( attributes.getValue("executor")!=null ) {
     6	            ex = svc.getExecutor(attributes.getValue("executor"));
     7	        }
     8	        Connector con = new Connector(attributes.getValue("protocol"));
     9	        if ( ex != null )  _setExecutor(con,ex);
    10	        
    11	        digester.push(con);
    12	    }
複製程式碼

在第 8 行,會根據配置檔案中 Server/Service/Connector 節點的 protocol 屬性呼叫 org.apache.catalina.connector.Connector 類的構造方法,而預設情況下 server.xml 檔案中 Server/Service/Connector 節點共有兩處配置:

<Connector port="8080" protocol="HTTP/1.1"
               connectionTimeout="20000"
               redirectPort="8443" />

<Connector port="8009" protocol="AJP/1.3" redirectPort="8443" />
複製程式碼

先看第一個 Connector 節點,呼叫 Connector 的構造方法時會傳入字串 HTTP/1.1

     1	    public Connector(String protocol) {
     2	        setProtocol(protocol);
     3	        // Instantiate protocol handler
     4	        try {
     5	            Class<?> clazz = Class.forName(protocolHandlerClassName);
     6	            this.protocolHandler = (ProtocolHandler) clazz.newInstance();
     7	        } catch (Exception e) {
     8	            log.error(sm.getString(
     9	                    "coyoteConnector.protocolHandlerInstantiationFailed"), e);
    10	        }
    11	    }
複製程式碼

這裡先會執行 org.apache.catalina.connector.Connector 類的 setProtocol 方法:

     1	    public void setProtocol(String protocol) {
     2	
     3	        if (AprLifecycleListener.isAprAvailable()) {
     4	            if ("HTTP/1.1".equals(protocol)) {
     5	                setProtocolHandlerClassName
     6	                    ("org.apache.coyote.http11.Http11AprProtocol");
     7	            } else if ("AJP/1.3".equals(protocol)) {
     8	                setProtocolHandlerClassName
     9	                    ("org.apache.coyote.ajp.AjpAprProtocol");
    10	            } else if (protocol != null) {
    11	                setProtocolHandlerClassName(protocol);
    12	            } else {
    13	                setProtocolHandlerClassName
    14	                    ("org.apache.coyote.http11.Http11AprProtocol");
    15	            }
    16	        } else {
    17	            if ("HTTP/1.1".equals(protocol)) {
    18	                setProtocolHandlerClassName
    19	                    ("org.apache.coyote.http11.Http11Protocol");
    20	            } else if ("AJP/1.3".equals(protocol)) {
    21	                setProtocolHandlerClassName
    22	                    ("org.apache.coyote.ajp.AjpProtocol");
    23	            } else if (protocol != null) {
    24	                setProtocolHandlerClassName(protocol);
    25	            }
    26	        }
    27	
    28	    }
複製程式碼

所以此時會呼叫setProtocolHandlerClassName("org.apache.coyote.http11.Http11Protocol")從而將 Connector 類例項變數 protocolHandlerClassName 值設定為org.apache.coyote.http11.Http11Protocol,接下來在 Connector 的構造方法中就會根據 protocolHandlerClassName 變數的值產生一個org.apache.coyote.http11.Http11Protocol物件,並將該物件賦值給 Connector 類的例項變數 protocolHandler 。在 Http11Protocol 類的構造方法中會產生一個org.apache.tomcat.util.net.JIoEndpoint物件:


     1	    public Http11Protocol() {
     2	        endpoint = new JIoEndpoint();
     3	        cHandler = new Http11ConnectionHandler(this);
     4	        ((JIoEndpoint) endpoint).setHandler(cHandler);
     5	        setSoLinger(Constants.DEFAULT_CONNECTION_LINGER);
     6	        setSoTimeout(Constants.DEFAULT_CONNECTION_TIMEOUT);
     7	        setTcpNoDelay(Constants.DEFAULT_TCP_NO_DELAY);
     8	    }
複製程式碼

幾個相關物件的構造方法呼叫時序圖如下所示,其中org.apache.coyote.AbstractProtocolorg.apache.coyote.http11.Http11Protocol的父類org.apache.tomcat.util.net.AbstractEndpointorg.apache.tomcat.util.net.JIoEndpoint的父類。

Tomcat 7 的一次請求分析(一)處理執行緒的產生
接下來容器啟動各元件時會呼叫org.apache.catalina.connector.Connector的 start 方法,如前面分析 Tomcat 啟動時所述,此時會呼叫org.apache.catalina.connector.Connector類的 startInternal 方法:

    protected void startInternal() throws LifecycleException {

        // Validate settings before starting
        if (getPort() < 0) {
            throw new LifecycleException(sm.getString(
                    "coyoteConnector.invalidPort", Integer.valueOf(getPort())));
        }

        setState(LifecycleState.STARTING);

        try {
            protocolHandler.start();
        } catch (Exception e) {
            String errPrefix = "";
            if(this.service != null) {
                errPrefix += "service.getName(): \"" + this.service.getName() + "\"; ";
            }

            throw new LifecycleException
                (errPrefix + " " + sm.getString
                 ("coyoteConnector.protocolHandlerStartFailed"), e);
        }

        mapperListener.start();
    }
複製程式碼

在第 12 行,將會呼叫例項變數 protocolHandler 的 start 方法。在上面分析 Connector 類的建構函式時發現 protocolHandler 變數的值就是org.apache.coyote.http11.Http11Protocol物件,所以此時將會呼叫該類的 start 方法。在 Http11Protocol 類中沒有定義 start 方法,這裡將會呼叫其父類org.apache.coyote.AbstractProtocol中的 start 方法:

    public void start() throws Exception {
        if (getLog().isInfoEnabled())
            getLog().info(sm.getString("abstractProtocolHandler.start",
                    getName()));
        try {
            endpoint.start();
        } catch (Exception ex) {
            getLog().error(sm.getString("abstractProtocolHandler.startError",
                    getName()), ex);
            throw ex;
        }
    }
複製程式碼

這裡會呼叫 endpoint 物件的 start 方法,而 endpoint 是org.apache.tomcat.util.net.JIoEndpoint類的例項(在上面講 Http11Protocol 類的構造方法時所提到),這裡最終會執行該類的 startInternal 方法:

     1	    @Override
     2	    public void startInternal() throws Exception {
     3	
     4	        if (!running) {
     5	            running = true;
     6	            paused = false;
     7	
     8	            // Create worker collection
     9	            if (getExecutor() == null) {
    10	                createExecutor();
    11	            }
    12	
    13	            initializeConnectionLatch();
    14	
    15	            startAcceptorThreads();
    16	
    17	            // Start async timeout thread
    18	            Thread timeoutThread = new Thread(new AsyncTimeout(),
    19	                    getName() + "-AsyncTimeout");
    20	            timeoutThread.setPriority(threadPriority);
    21	            timeoutThread.setDaemon(true);
    22	            timeoutThread.start();
    23	        }
    24	    }
複製程式碼

正是在這裡產生並啟動本文開頭提到的 http-bio-8080-Acceptor-0 和 http-bio-8080-AsyncTimeout 兩個執行緒。第 17 到 22 行就是產生和啟動 http-bio-8080-AsyncTimeout 執行緒,第 15 行這裡呼叫父類org.apache.tomcat.util.net.AbstractEndpoint的 startAcceptorThreads 方法:

     1	    protected final void startAcceptorThreads() {
     2	        int count = getAcceptorThreadCount();
     3	        acceptors = new Acceptor[count];
     4	
     5	        for (int i = 0; i < count; i++) {
     6	            acceptors[i] = createAcceptor();
     7	            String threadName = getName() + "-Acceptor-" + i;
     8	            acceptors[i].setThreadName(threadName);
     9	            Thread t = new Thread(acceptors[i], threadName);
    10	            t.setPriority(getAcceptorThreadPriority());
    11	            t.setDaemon(getDaemon());
    12	            t.start();
    13	        }
    14	    }
    15	
    16	
    17	    /**
    18	     * Hook to allow Endpoints to provide a specific Acceptor implementation.
    19	     */
    20	    protected abstract Acceptor createAcceptor();
複製程式碼

在這裡將產生和啟動 http-bio-8080-Acceptor-0 執行緒。注意在構造該執行緒時第 6 行將會呼叫第 20 行的抽象方法,該方法的具體實現是在 JIoEndpoint 類中:

    @Override
    protected AbstractEndpoint.Acceptor createAcceptor() {
        return new Acceptor();
    }
複製程式碼

以上便是本文開頭所述的兩個後臺執行緒產生和啟動的流程,其相關類呼叫的時序圖如下圖所示:

Tomcat 7 的一次請求分析(一)處理執行緒的產生
同理,ajp-bio-8009-Acceptor-0 和 ajp-bio-8009-AsyncTimeout 兩個守護執行緒的產生和啟動方式也是一致的,不再贅述。

相關文章