Tomcat 類(lèi)加載器的實(shí)現(xiàn)方法及實(shí)例代碼

Tomcat 內(nèi)部定義了多個(gè) ClassLoader，以便應(yīng)用和容器訪問(wèn)不同存儲(chǔ)庫(kù)中的類(lèi)和資源，同時(shí)達(dá)到應(yīng)用間類(lèi)隔離的目的。

1. Java 類(lèi)加載機(jī)制

類(lèi)加載就是把編譯生成的 class 文件，加載到 JVM 內(nèi)存中（永久代/元空間）。

類(lèi)加載器之所以能實(shí)現(xiàn)類(lèi)隔離，是因?yàn)閮蓚€(gè)類(lèi)相等的前提是它們由同一個(gè)類(lèi)加載器加載，否則必定不相等。

JVM 在加載時(shí)，采用的是一種雙親委托機(jī)制，當(dāng)類(lèi)加載器要加載一個(gè)類(lèi)時(shí)，加載順序是：

首先將請(qǐng)求委托給父加載器，如果父加載器找不到要加載的類(lèi)然后再查找自己的存儲(chǔ)庫(kù)嘗試加載

這個(gè)機(jī)制的好處就是能夠保證核心類(lèi)庫(kù)不被覆蓋。

而按照 Servlet 規(guī)范的建議，Webapp 加載器略有不同，它首先會(huì)在自己的資源庫(kù)中搜索，而不是向上委托，打破了標(biāo)準(zhǔn)的委托機(jī)制，來(lái)看下 Tomcat 的設(shè)計(jì)和實(shí)現(xiàn)。

2. Tomcat 類(lèi)加載器設(shè)計(jì)

Tomcat 整體類(lèi)加載器結(jié)構(gòu)如下：

其中 JDK 內(nèi)部提供的類(lèi)加載器分別是：

Bootstrap - 啟動(dòng)類(lèi)加載器，屬于 JVM 的一部分，加載 <JAVA_HOME>/lib/ 目錄下特定的文件Extension - 擴(kuò)展類(lèi)加載器，加載 <JAVA_HOME>/lib/ext/ 目錄下的類(lèi)庫(kù)Application - 應(yīng)用程序類(lèi)加載器，也叫系統(tǒng)類(lèi)加載器，加載 CLASSPATH 指定的類(lèi)庫(kù)

Tomcat 自定義實(shí)現(xiàn)的類(lèi)加載器分別是：

Common - 父加載器是 AppClassLoader，默認(rèn)加載 ${catalina.home}/lib/ 目錄下的類(lèi)庫(kù)Catalina - 父加載器是 Common 類(lèi)加載器，加載 catalina.properties 配置文件中 server.loader 配置的資源，一般是 Tomcat 內(nèi)部使用的資源Shared - 父加載器是 Common 類(lèi)加載器，加載 catalina.properties 配置文件中 shared.loader 配置的資源，一般是所有 Web 應(yīng)用共享的資源WebappX - 父加載器是 Shared 加載器，加載 /WEB-INF/classes 的 class 和 /WEB-INF/lib/ 中的 jar 包JasperLoader - 父加載器是 Webapp 加載器，加載 work 目錄應(yīng)用編譯 JSP 生成的 class 文件

在實(shí)現(xiàn)時(shí)，上圖不是繼承關(guān)系，而是通過(guò)組合體現(xiàn)父子關(guān)系。Tomcat 類(lèi)加載器的源碼類(lèi)圖：

Common、Catalina 、Shared 它們都是 StandardClassLoader 的實(shí)例，在默認(rèn)情況下，它們引用的是同一個(gè)對(duì)象。其中 StandardClassLoader 與 URLClassLoader 沒(méi)有區(qū)別；WebappClassLoader 則按規(guī)范實(shí)現(xiàn)以下順序的查找并加載：

從 JVM 內(nèi)部的 Bootstrap 倉(cāng)庫(kù)加載從應(yīng)用程序加載器路徑，即 CLASSPATH 下加載從 Web 程序內(nèi)的 /WEB-INF/classes 目錄從 Web 程序內(nèi)的 /WEB-INF/lib 中的 jar 文件從容器 Common 加載器倉(cāng)庫(kù)，即所有 Web 程序共享的資源加載

接下來(lái)看下源碼實(shí)現(xiàn)。

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

common 類(lèi)加載器是在 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();
 }
 // 指定倉(cāng)庫(kù)路徑配置文件前綴和父加載器，創(chuàng)建 ClassLoader 實(shí)例
 catalinaLoader = createClassLoader("server", commonLoader);
 sharedLoader = createClassLoader("shared", commonLoader);
 } catch (Throwable t) {
 log.error("Class loader creation threw exception", t);
 System.exit(1);
 }
}

可以看到分別創(chuàng)建了三個(gè)類(lèi)加載器，createClassLoader 就是根據(jù)配置獲取資源倉(cāng)庫(kù)地址，最后返回一個(gè) StandardClassLoader 實(shí)例，核心代碼如下:

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

 String value = CatalinaProperties.getProperty(name + ".loader");
 if ((value == null) || (value.equals("")))
  return parent; // 如果沒(méi)有配置，則返回傳入的父加載器
 ArrayList repositoryLocations = new ArrayList();
 ArrayList repositoryTypes = new ArrayList();
 ...
 // 獲取資源倉(cāng)庫(kù)路徑
 String[] locations = (String[]) repositoryLocations.toArray(new String[0]);
 Integer[] types = (Integer[]) repositoryTypes.toArray(new Integer[0]);
 // 創(chuàng)建一個(gè) StandardClassLoader 對(duì)象
 ClassLoader classLoader = ClassLoaderFactory.createClassLoader
   (locations, types, parent);
 ...
 return classLoader;
}

類(lèi)加載器初始化完畢后，會(huì)創(chuàng)建一個(gè) Catalina 對(duì)象，最終會(huì)調(diào)用它的 load 方法，解析 server.xml 初始化容器內(nèi)部組件。那么容器，比如 Engine，又是怎么關(guān)聯(lián)到這個(gè)設(shè)置的父加載器的呢？

Catalina 對(duì)象有一個(gè) parentClassLoader 成員變量，它是所有組件的父加載器，默認(rèn)是 AppClassLoader，在此對(duì)象創(chuàng)建完畢時(shí)，會(huì)反射調(diào)用它的 setParentClassLoader 方法，將父加載器設(shè)為 sharedLoader。

而 Tomcat 內(nèi)部頂級(jí)容器 Engine 在初始化時(shí)，Digester 有一個(gè) SetParentClassLoaderRule 規(guī)則，會(huì)將 Catalina 的 parentClassLoader 通過(guò) Engine.setParentClassLoader 方法關(guān)聯(lián)起來(lái)。

4. 如何打破雙親委托機(jī)制

答案是使用 Thread.getContextClassLoader() - 當(dāng)前線程的上下文加載器，該加載器可通過(guò) Thread.setContextClassLoader() 在代碼運(yùn)行時(shí)動(dòng)態(tài)設(shè)置。

默認(rèn)情況下，Thread 上下文加載器繼承自父線程，也就是說(shuō)所有線程默認(rèn)上下文加載器都與第一個(gè)啟動(dòng)的線程相同，也就是 main 線程，它的上下文加載器是 AppClassLoader。

Tomcat 就是在 StandardContext 啟動(dòng)時(shí)首先初始化一個(gè) WebappClassLoader 然后設(shè)置為當(dāng)前線程的上下文加載器，最后將其封裝為 Loader 對(duì)象，借助容器之間的父子關(guān)系，在加載 Servlet 類(lèi)時(shí)使用。

5. Web 應(yīng)用的類(lèi)加載

Web 應(yīng)用的類(lèi)加載是由 WebappClassLoader 的方法 loadClass(String, boolean) 完成，核心代碼如下：

在防止覆蓋 J2SE

public synchronized Class loadClass(String name, boolean resolve)
 throws ClassNotFoundException {
 ...
 Class clazz = null;
 // (0) 檢查自身內(nèi)部緩存中是否已經(jīng)加載
 clazz = findLoadedClass0(name);
 if (clazz != null) {
 if (log.isDebugEnabled())
  log.debug(" Returning class from cache");
 if (resolve) resolveClass(clazz);
 return (clazz);
 }
 // (0.1) 檢查 JVM 的緩存中是否已經(jīng)加載
 clazz = findLoadedClass(name);
 if (clazz != null) {
 if (log.isDebugEnabled())
  log.debug(" Returning class from cache");
 if (resolve) resolveClass(clazz);
 return (clazz);
 }
 // (0.2) 嘗試使用系統(tǒng)類(lèi)加載加載，防止覆蓋 J2SE 類(lèi)
 try {
 clazz = system.loadClass(name);
 if (clazz != null) {
  if (resolve) resolveClass(clazz);
  return (clazz);
 }
 } catch (ClassNotFoundException e) {// Ignore}
 // (0.5) 使用 SecurityManager 檢查是否有此類(lèi)的訪問(wèn)權(quán)限
 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) 是否委托給父類(lèi)，這里默認(rèn)為 false
 if (delegateLoad) {
  ...
 }
 // (2) 嘗試查找自己的存儲(chǔ)庫(kù)并加載
 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) 如果此時(shí)還加載失敗，那么將加載請(qǐng)求委托給父加載器
 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 類(lèi)的時(shí)候，版本 Tomcat 6，使用的是 AppClassLoader，rt.jar 核心類(lèi)庫(kù)是由 Bootstrap Classloader 加載的，但是在 Java 代碼是獲取不了這個(gè)加載器的，在高版本做了以下優(yōu)化：
ClassLoader j = String.class.getClassLoader();
if (j == null) {
 j = getSystemClassLoader();
 while (j.getParent() != null) {
 j = j.getParent();
 }
}
this.javaseClassLoader = j;

類(lèi)的時(shí)候，版本 Tomcat 6，使用的是 AppClassLoader，rt.jar 核心類(lèi)庫(kù)是由 Bootstrap Classloader 加載的，但是在 Java 代碼是獲取不了這個(gè)加載器的，在高版本做了以下優(yōu)化：

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

也就是使用盡可能接近 Bootstrap 加載器的類(lèi)加載器。

6. 小結(jié)

相信大部分人都遇到過(guò) ClassNotFoundException 這個(gè)異常，這背后就涉及到了類(lèi)加載器，對(duì)加載的原理有一定的了解，有助于排查問(wèn)題。

以上所述是小編給大家介紹的Tomcat 類(lèi)加載器的實(shí)現(xiàn)方法及實(shí)例代碼,希望對(duì)大家有所幫助，如果大家有任何疑問(wèn)請(qǐng)給我留言，小編會(huì)及時(shí)回復(fù)大家的。在此也非常感謝大家對(duì)腳本之家網(wǎng)站的支持！
如果你覺(jué)得本文對(duì)你有幫助，歡迎轉(zhuǎn)載，煩請(qǐng)注明出處，謝謝！