Tomcat啟動核心流程示例詳解

Posted on by

一、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<?> startupClass = catalinaLoader
            .loadClass("org.apache.catalina.startup.Catalina");
        // 創建瞭 Catalina 實例
        Object startupInstance = startupClass.getConstructor().newInstance();
        // 省略部分代碼...
        String methodName = "setParentClassLoader";
        Class<?> 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方法。

5.核心流程的總結

我們可以通過下圖來總結下Tomcat啟動的核心流程

從圖中我們可以看到Bootstrap其實沒有做什麼核心的事情，主要還是Catalina來完成的。

以上就是Tomcat啟動核心流程示例詳解的詳細內容，更多關於Tomcat啟動流程的資料請關註WalkonNet其它相關文章！

推薦閱讀：