Tomcat啟動核心流程範例詳解

2022-08-18 18:00:20

一、Tomcat的啟動核心流程

前面給大家介紹了Tomcat中的生命週期的設計，掌握了這塊對於我們分析Tomcat的核心流程是非常有幫助的，也就是我們需要建立相關的核心元件，比如Server，Service肯定都繞不開生命週期的方法。

1.啟動的入口

你可以通過指令碼來啟動Tomcat服務(startup.bat),但如果你看過指令碼的命令，你會發現最終呼叫的還是Bootstrap中的main方法，所以我們需要從main方法來開始

然後我們去看main方法中的程式碼，我們需要重點關注的方法有三個

bootstrap.init()方法
load()方法
start()方法

也就是在這三個方法中會完成Tomcat的核心操作。

2.init方法

我們來看下init方法中的程式碼，非核心的我們直接去掉

    public void init() throws Exception {
        // 建立相關的類載入器
        initClassLoaders();
        // 省略部分程式碼...
        // 通過反射建立了 Catalina 類物件
        Class&lt;?&gt; startupClass = catalinaLoader
            .loadClass("org.apache.catalina.startup.Catalina");
        // 建立了 Catalina 範例
        Object startupInstance = startupClass.getConstructor().newInstance();
        // 省略部分程式碼...
        String methodName = "setParentClassLoader";
        Class&lt;?&gt; paramTypes[] = new Class[1];
        paramTypes[0] = Class.forName("java.lang.ClassLoader");
        Object paramValues[] = new Object[1];
        paramValues[0] = sharedLoader;
        // 把 sharedLoader 設定為了 commonLoader的父載入器
        Method method =
            startupInstance.getClass().getMethod(methodName, paramTypes);
        method.invoke(startupInstance, paramValues);
        // Catalina 範例 賦值給了 catalinaDaemon
        catalinaDaemon = startupInstance;
    }

首先是呼叫了initClassLoaders()方法，這個方法會完成對應的ClassLoader的建立，這個比較重要，後面專門寫一篇文章來介紹。
通過反射的方式建立了Catalina的類物件，並通過反射建立了Catalina的範例
設定了類載入器的父子關係
用過成員變數catalinaDaemon記錄了我們建立的Catalina範例

這個是通過bootstrap.init()方法我們可以獲取到的有用的資訊。然後我們繼續往下面看。

3.load方法

然後我們來看下load方法做了什麼事情，程式碼如下：

    private void load(String[] arguments) throws Exception {
        // Call the load() method
        String methodName = "load"; // load方法的名稱
        Object param[];
        Class<?> paramTypes[];
        if (arguments==null || arguments.length==0) {
            paramTypes = null;
            param = null;
        } else {
            paramTypes = new Class[1];
            paramTypes[0] = arguments.getClass();
            param = new Object[1];
            param[0] = arguments;
        }
        // catalinaDaemon 就是在 init中建立的 Catalina 物件
        Method method =
            catalinaDaemon.getClass().getMethod(methodName, paramTypes);
        if (log.isDebugEnabled()) {
            log.debug("Calling startup class " + method);
        }
        // 會執行 Catalina的load方法
        method.invoke(catalinaDaemon, param);
    }

上面的程式碼非常簡單，通過註釋我們也可以看出該方法的作用是呼叫 Catalina的load方法。所以我們還需要加入到Catalina的load方法中來檢視，程式碼同樣比較長，只留下關鍵程式碼

    public void load() {
        if (loaded) {
            return; // 只能被載入一次
        }
        loaded = true;
        initDirs(); // 廢棄的方法
        // Before digester - it may be needed
        initNaming(); // 和JNDI 相關的內容 忽略
        // Create and execute our Digester
        // 建立並且執行我們的 Digester 物件  Server.xml
        Digester digester = createStartDigester();
        // 省略掉了 Digester檔案處理的程式碼
        getServer().setCatalina(this); // Server物件繫結 Catalina物件
        getServer().setCatalinaHome(Bootstrap.getCatalinaHomeFile());
        getServer().setCatalinaBase(Bootstrap.getCatalinaBaseFile());
        // Stream redirection
        initStreams();
        // 省略掉了部分程式碼...
         getServer().init(); // 完成 Server  Service Engine Connector等元件的init操作
    }

把上面的程式碼簡化後我們發現這個Load方法其實也是蠻簡單的，就做了兩件事。

通過Apache下的Digester元件完成了Server.xml檔案的解析
通過getServer().init() 方法完成了Server,Service,Engin,Connector等核心元件的初始化操作，這塊和前面的LifecycleBase呼應起來了。

如果生命週期的內容不清楚，請看前面內容介紹

4.start方法

最後我們來看下start方法的程式碼。

    public void start() throws Exception {
        if (catalinaDaemon == null) {
            init(); // 如果 catalinaDaemon 為空 初始化操作
        }
        // 獲取的是 Catalina 中的 start方法
        Method method = catalinaDaemon.getClass().getMethod("start", (Class [])null);
        // 執行 Catalina 的start方法
        method.invoke(catalinaDaemon, (Object [])null);
    }

上面的程式碼邏輯也很清楚，就是通過反射的方式呼叫了Catalina物件的start方法。所以進入Catalina的start方法中檢視。

    public void start() {
        if (getServer() == null) {
            load(); // 如果Server 為空 重新 init 相關的元件
        }
        if (getServer() == null) {
            log.fatal("Cannot start server. Server instance is not configured.");
            return;
        }
        // Start the new server  關鍵方法---&gt;啟動Server
        try {
            getServer().start();
        } catch (LifecycleException e) {
            // 省略...
        }
        // 省略...
        // Register shutdown hook  註冊關閉的勾點
        if (useShutdownHook) {
            // 省略...
        }
        if (await) {
            await();
            stop();
        }
    }

通過上面的程式碼我們可以發現核心的程式碼還是getServer.start()方法，也就是通過Server物件來巢狀的呼叫相關注解的start方法。