Tomcat 類載入器的實現

wskwbog發表於2019-05-09
Tomcat

Tomcat 內部定義了多個 ClassLoader，以便應用和容器訪問不同儲存庫中的類和資源，同時達到應用間類隔離的目的。本文首發於公眾號：頓悟原始碼。

1. Java 類載入機制

類載入就是把編譯生成的 class 檔案，載入到 JVM 記憶體中（永久代/元空間）。

類載入器之所以能實現類隔離，是因為兩個類相等的前提是它們由同一個類載入器載入，否則必定不相等。

JVM 在載入時，採用的是一種雙親委託機制，當類載入器要載入一個類時，載入順序是：

  • 首先將請求委託給父載入器，如果父載入器找不到要載入的類
  • 然後再查詢自己的儲存庫嘗試載入

這個機制的好處就是能夠保證核心類庫不被覆蓋。

而按照 Servlet 規範的建議，Webapp 載入器略有不同，它首先會在自己的資源庫中搜尋，而不是向上委託，打破了標準的委託機制，來看下 Tomcat 的設計和實現。

2. Tomcat 類載入器設計

Tomcat 整體類載入器結構如下：

Tomcat 類載入器結構

其中 JDK 內部提供的類載入器分別是：

  • Bootstrap - 啟動類載入器，屬於 JVM 的一部分，載入 <JAVA_HOME>/lib/ 目錄下特定的檔案
  • Extension - 擴充套件類載入器，載入 <JAVA_HOME>/lib/ext/ 目錄下的類庫
  • Application - 應用程式類載入器，也叫系統類載入器，載入 CLASSPATH 指定的類庫

Tomcat 自定義實現的類載入器分別是：

  • Common - 父載入器是 AppClassLoader，預設載入 ${catalina.home}/lib/ 目錄下的類庫
  • Catalina - 父載入器是 Common 類載入器，載入 catalina.properties 配置檔案中 server.loader 配置的資源，一般是 Tomcat 內部使用的資源
  • Shared - 父載入器是 Common 類載入器，載入 catalina.properties 配置檔案中 shared.loader 配置的資源，一般是所有 Web 應用共享的資源
  • WebappX - 父載入器是 Shared 載入器，載入 /WEB-INF/classes 的 class 和 /WEB-INF/lib/ 中的 jar 包
  • JasperLoader - 父載入器是 Webapp 載入器，載入 work 目錄應用編譯 JSP 生成的 class 檔案

在實現時，上圖不是繼承關係，而是通過組合體現父子關係。Tomcat 類載入器的原始碼類圖：

Tomcat 類載入器類圖

Common、Catalina 、Shared 它們都是 StandardClassLoader 的例項，在預設情況下，它們引用的是同一個物件。其中 StandardClassLoader 與 URLClassLoader 沒有區別；WebappClassLoader 則按規範實現以下順序的查詢並載入：

  1. 從 JVM 內部的 Bootstrap 倉庫載入
  2. 從應用程式載入器路徑，即 CLASSPATH 下載入
  3. 從 Web 程式內的 /WEB-INF/classes 目錄
  4. 從 Web 程式內的 /WEB-INF/lib 中的 jar 檔案
  5. 從容器 Common 載入器倉庫，即所有 Web 程式共享的資源載入

接下來看下原始碼實現。

3. 自定義載入器的初始化

common 類載入器是在 Bootstrap 的 initClassLoaders 初始化的，原始碼如下：

private void initClassLoaders() {
  try {
    commonLoader = createClassLoader("common", null);
    if( commonLoader == null ) {
        // no config file, default to this loader - we might be in a 'single' env.
        commonLoader=this.getClass().getClassLoader();
    }
    // 指定倉庫路徑配置檔案字首和父載入器，建立 ClassLoader 例項
    catalinaLoader = createClassLoader("server", commonLoader);
    sharedLoader = createClassLoader("shared", commonLoader);
  } catch (Throwable t) {
    log.error("Class loader creation threw exception", t);
    System.exit(1);
  }
}

可以看到分別建立了三個類載入器，createClassLoader 就是根據配置獲取資源倉庫地址，最後返回一個 StandardClassLoader 例項，核心程式碼如下:

private ClassLoader createClassLoader(String name, ClassLoader parent)
    throws Exception {

    String value = CatalinaProperties.getProperty(name + ".loader");
    if ((value == null) || (value.equals("")))
        return parent; // 如果沒有配置，則返回傳入的父載入器
    ArrayList repositoryLocations = new ArrayList();
    ArrayList repositoryTypes = new ArrayList();
    ...
    // 獲取資源倉庫路徑
    String[] locations = (String[]) repositoryLocations.toArray(new String[0]);
    Integer[] types = (Integer[]) repositoryTypes.toArray(new Integer[0]);
    // 建立一個 StandardClassLoader 物件
    ClassLoader classLoader = ClassLoaderFactory.createClassLoader
            (locations, types, parent);
    ...
    return classLoader;
}

類載入器初始化完畢後，會建立一個 Catalina 物件，最終會呼叫它的 load 方法，解析 server.xml 初始化容器內部元件。那麼容器，比如 Engine，又是怎麼關聯到這個設定的父載入器的呢？

Catalina 物件有一個 parentClassLoader 成員變數，它是所有元件的父載入器，預設是 AppClassLoader，在此物件建立完畢時，會反射呼叫它的 setParentClassLoader 方法，將父載入器設為 sharedLoader。

而 Tomcat 內部頂級容器 Engine 在初始化時，Digester 有一個 SetParentClassLoaderRule 規則，會將 Catalina 的 parentClassLoader 通過 Engine.setParentClassLoader 方法關聯起來。

4. 如何打破雙親委託機制

答案是使用 Thread.getContextClassLoader() - 當前執行緒的上下文載入器，該載入器可通過 Thread.setContextClassLoader() 在程式碼執行時動態設定。

預設情況下，Thread 上下文載入器繼承自父執行緒，也就是說所有執行緒預設上下文載入器都與第一個啟動的執行緒相同，也就是 main 執行緒，它的上下文載入器是 AppClassLoader。

Tomcat 就是在 StandardContext 啟動時首先初始化一個 WebappClassLoader 然後設定為當前執行緒的上下文載入器，最後將其封裝為 Loader 物件，藉助容器之間的父子關係，在載入 Servlet 類時使用。

5. Web 應用的類載入

Web 應用的類載入是由 WebappClassLoader 的方法 loadClass(String, boolean) 完成，核心程式碼如下：

public synchronized Class loadClass(String name, boolean resolve)
    throws ClassNotFoundException {
  ...
  Class clazz = null;
  // (0) 檢查自身內部快取中是否已經載入
  clazz = findLoadedClass0(name);
  if (clazz != null) {
    if (log.isDebugEnabled())
      log.debug("  Returning class from cache");
    if (resolve) resolveClass(clazz);
    return (clazz);
  }
  // (0.1) 檢查 JVM 的快取中是否已經載入
  clazz = findLoadedClass(name);
  if (clazz != null) {
    if (log.isDebugEnabled())
      log.debug("  Returning class from cache");
    if (resolve) resolveClass(clazz);
    return (clazz);
  }
  // (0.2) 嘗試使用系統類載入載入，防止覆蓋 J2SE 類
  try {
    clazz = system.loadClass(name);
    if (clazz != null) {
      if (resolve) resolveClass(clazz);
      return (clazz);
    }
  } catch (ClassNotFoundException e) {// Ignore}
  // (0.5) 使用 SecurityManager 檢查是否有此類的訪問許可權
  if (securityManager != null) {
    int i = name.lastIndexOf('.');
    if (i >= 0) {
      try {
        securityManager.checkPackageAccess(name.substring(0,i));
      } catch (SecurityException se) {
        String error = "Security Violation, attempt to use " +
            "Restricted Class: " + name;
        log.info(error, se);
        throw new ClassNotFoundException(error, se);
      }
    }
  }
  boolean delegateLoad = delegate || filter(name);
  // (1) 是否委託給父類，這裡預設為 false
  if (delegateLoad) {
      ...
  }
  // (2) 嘗試查詢自己的儲存庫並載入
  try {
    clazz = findClass(name);
    if (clazz != null) {
      if (log.isDebugEnabled())
        log.debug("  Loading class from local repository");
      if (resolve) resolveClass(clazz);
      return (clazz);
    }
  } catch (ClassNotFoundException e) {}
  // (3) 如果此時還載入失敗，那麼將載入請求委託給父載入器
  if (!delegateLoad) {
    if (log.isDebugEnabled())
      log.debug("  Delegating to parent classloader at end: " + parent);
    ClassLoader loader = parent;
    if (loader == null)
      loader = system;
    try {
      clazz = loader.loadClass(name);
      if (clazz != null) {
        if (log.isDebugEnabled())
          log.debug("  Loading class from parent");
        if (resolve) resolveClass(clazz);
        return (clazz);
      }
    } catch (ClassNotFoundException e) {}
  }
  // 最後載入失敗，丟擲異常
  throw new ClassNotFoundException(name);
}

在防止覆蓋 J2SE 類的時候，版本 Tomcat 6，使用的是 AppClassLoader，rt.jar 核心類庫是由 Bootstrap Classloader 載入的，但是在 Java 程式碼是獲取不了這個載入器的，在高版本做了以下優化：

ClassLoader j = String.class.getClassLoader();
if (j == null) {
  j = getSystemClassLoader();
  while (j.getParent() != null) {
    j = j.getParent();
  }
}
this.javaseClassLoader = j;

也就是使用盡可能接近 Bootstrap 載入器的類載入器。

6. 小結

相信大部分人都遇到過 ClassNotFoundException 這個異常，這背後就涉及到了類載入器，對載入的原理有一定的瞭解，有助於排查問題。

相關文章