天天看點

Tomcat源碼篇-啟動核心流程-沒你想的那麼難哦

Tomcat源碼篇-啟動核心流程-沒你想的那麼難哦

Tomcat的啟動核心流程

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

Tomcat源碼篇-啟動核心流程-沒你想的那麼難哦

1.啟動的入口

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

Tomcat源碼篇-啟動核心流程-沒你想的那麼難哦

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

  1. bootstrap.init()方法
  2. load()方法
  3. 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;
    }      
  1. 首先是調用了initClassLoaders()方法,這個方法會完成對應的ClassLoader的建立,這個比較重要,後面專門寫一篇文章來介紹。
  2. 通過反射的方式建立了Catalina的類對象,并通過反射建立了Catalina的執行個體
  3. 設定了類加載器的父子關系
  4. 用過成員變量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方法其實也是蠻簡單的,就做了兩件事。

  1. 通過Apache下的Digester元件完成了Server.xml檔案的解析
  2. 通過getServer().init() 方法完成了Server,Service,Engin,Connector等核心元件的初始化操作,這塊和前面的LifecycleBase呼應起來了。
Tomcat源碼篇-啟動核心流程-沒你想的那麼難哦

  如果生命周期的内容不清楚,請看上一篇文章的介紹。

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  關鍵方法--->啟動Server
        try {
            getServer().start();
        } catch (LifecycleException e) {
            // 省略...
        }

        // 省略...

        // Register shutdown hook  注冊關閉的鈎子
        if (useShutdownHook) {
            // 省略...
        }

        if (await) {
            await();
            stop();
        }
    }      

  通過上面的代碼我們可以發現核心的代碼還是getServer.start()方法,也就是通過Server對象來嵌套的調用相關注解的start方法。

Tomcat源碼篇-啟動核心流程-沒你想的那麼難哦

5.核心流程的總結

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

Tomcat源碼篇-啟動核心流程-沒你想的那麼難哦