Tomcat 源代码分析之ClassLoader

Tomcat 源代码分析之ClassLoader

此系列文章皆为Tomcat 7.0代码代码分析。

 

1. ClassLoader基础知识

1.1. Parent-Child委托模型

 

我们知道Java系统中，类加载器的默认加载方式是采用Parent-Child委托方式加载类的，即就是说，先尝试使用父类加载器加载类，如果没有找到，才自己加载该类，可以看到，这是一个递归的加载过程，核心代码大致如下：

Java代码

1. protected Class<?> loadClass(String name, boolean resolve)  
2.         throws ClassNotFoundException  
3.     {  
4.         synchronized (getClassLoadingLock(name)) {  
5.             // First, check if the class has already been loaded  
6.             Class c = findLoadedClass(name);  
7.             if (c == null) {  
8.                 ……  
9.                 try {  
10.                     if (parent != null) {  
11.                         c = parent.loadClass(name, false);  
12.                     } else {  
13.                         c = findBootstrapClassOrNull(name);  
14.                     }  
15.                 } catch (ClassNotFoundException e) {  
16.                     // ClassNotFoundException thrown if class not found  
17.                     // from the non-null parent class loader  
18.                 }  
19.   
20.                 if (c == null) {  
21.                     // If still not found, then invoke findClass in order  
22.                     // to find the class.  
23.                     …  
24.                     c = findClass(name);  
25.                     ……  
26.                 }  
27.             }  
28.             ……  
29.             return c;  
30.         }  
31.     }  

 很多ClassLoader的继承类都默认了这种加载方式，其中用途比较广泛的有URLClassLoader。

1.2. 类加载器运行时模型：

 

当一个JVM启动时，至少有三个ClassLoader会被启动：

1. Bootstrap 类加载器

加载Java核心包，它们被置放在(<JAVA_HOME>/lib目录下，这部分是JVM的一部分，往往使用native code完成

2. Extensions类加载器

加载Java扩展包，即位于<JAVA_HOME>/lib/ext下的包，这里要注意的是，有些JVM的这个加载器和Bootstrap类加载器是同一个加载器，而Sun是把二者分开的，其实现类为sun.misc.Launcher$ExtClassLoader。

3. System类加载器

这个类加载器加载CLASSPATH下的类，Sun的 默认实现是sun.misc.Launcher$ExtClassLoader。

这三者之间的父子关系是：Bootstrap类加载器是Extensions类加载器的父类加载器，而Extensions类加载器是System类加载器的父类加载器。

2. Tomcat Classloader模型

Tomcat 7.0的ClassLoader加载层次模型如下图所示：

 

 这个模型和之前Tomcat 5.5之前有些不同，因为之前的除过Common类加载器之外，还有Catalina类加载器和Shared类加载器，这个只能导致更多的配置和概念，已经不再使用了，虽然还可以进行配置。

1. Common类加载器：加载$CATALINA_HOME/lib和$CATALINA_BASE/lib下的class文件和jar包以及旗下的资源文件，这些文件将会被所有Web应用共有，也会被Tomcat运行时用到。其配置在catalina.properties下，如果没有配置，则默认使用System类加载器，配置示例：

common.loader=${catalina.home}/lib,${catalina.home}/lib/*.jar

2. App类加载器：Web 应用的类加载器，Web应用下的资源文件，class文件盒jar包，按照Java Web规范的标准，它们位于Web应用的/WEB-INF/classes和/WEB-INF/lib文件夹下。

3. 类加载器的实现

 

Tomcat类加载器其实有三个类实现：StandardClassLoader，WebappClassLoader和JasperLoader，这三个类加载器都是URLClassLoader的子类。不同的是，StandardClassLoader并没有客户化URLClassLoader方法，即，它也是采用委托的方式加载类的。而其他都覆写了loadClass()方法。

1. StandardClassLoader类加载器会创建Common类加载器的实例。

2. WebappClassLoader为每个应用创建类加载器实例，对于加载Web应用的类时，我们并非推荐使用父子委托模型，但是必须保证以java.*和javax.*开头的包必须由System类加载器加载，即最终由Bootstrap加载器加载。

核心代码如下：

Java代码 

1. public Class loadClass(String name, boolean resolve)  
2.         throws ClassNotFoundException {  
3.   
4.        ……  
5.   
6.         // (0) Check our previously loaded local class cache  
7.         clazz = findLoadedClass0(name);  
8.         if (clazz != null) {  
9.             if (log.isDebugEnabled())  
10.                 log.debug("  Returning class from cache");  
11.             if (resolve)  
12.                 resolveClass(clazz);  
13.             return (clazz);  
14.         }  
15.   
16.         // (0.1) Check our previously loaded class cache  
17.         clazz = findLoadedClass(name);  
18.         if (clazz != null) {  
19.             if (log.isDebugEnabled())  
20.                 log.debug("  Returning class from cache");  
21.             if (resolve)  
22.                 resolveClass(clazz);  
23.             return (clazz);  
24.         }  
25.   
26.         // (0.2) Try loading the class with the system class loader, to prevent  
27.         //       the webapp from overriding J2SE classes  
28.        //保证以java.*和javax.*开头的包必须由System类加载器加载  
29.         try {  
30.             clazz = system.loadClass(name);  
31.             if (clazz != null) {  
32.                 if (resolve)  
33.                     resolveClass(clazz);  
34.                 return (clazz);  
35.             }  
36.         } catch (ClassNotFoundException e) {  
37.             // Ignore  
38.         }  
39.   
40.         ……  
41.   
42.         boolean delegateLoad = delegate || filter(name);  
43.   
44.         // (1) Delegate to our parent if requested  
45.         //Mbeans加载时，是否采用delegate方式  
46.         if (delegateLoad) {  
47.             if (log.isDebugEnabled())  
48.                 log.debug("  Delegating to parent classloader1 " + parent);  
49.             ClassLoader loader = parent;  
50.             if (loader == null)  
51.                 loader = system;  
52.             try {  
53.                 clazz = loader.loadClass(name);  
54.                 if (clazz != null) {  
55.                     if (log.isDebugEnabled())  
56.                         log.debug("  Loading class from parent");  
57.                     if (resolve)  
58.                         resolveClass(clazz);  
59.                     return (clazz);  
60.                 }  
61.             } catch (ClassNotFoundException e) {  
62.                 ;  
63.             }  
64.         }  
65.   
66.         // (2) Search local repositories  
67.        //先本地加载，不委托父加载器加载  
68.         if (log.isDebugEnabled())  
69.             log.debug("  Searching local repositories");  
70.         try {  
71.             clazz = findClass(name);  
72.             if (clazz != null) {  
73.                 if (log.isDebugEnabled())  
74.                     log.debug("  Loading class from local repository");  
75.                 if (resolve)  
76.                     resolveClass(clazz);  
77.                 return (clazz);  
78.             }  
79.         } catch (ClassNotFoundException e) {  
80.             ;  
81.         }  
82.   
83.         // 最后使用父加载器加载  
84.         if (!delegateLoad) {  
85.             if (log.isDebugEnabled())  
86.                 log.debug("  Delegating to parent classloader at end: " + parent);  
87.             ClassLoader loader = parent;  
88.             if (loader == null)  
89.                 loader = system;  
90.             try {  
91.                 clazz = loader.loadClass(name);  
92.                 if (clazz != null) {  
93.                     if (log.isDebugEnabled())  
94.                         log.debug("  Loading class from parent");  
95.                     if (resolve)  
96.                         resolveClass(clazz);  
97.                     return (clazz);  
98.                 }  
99.             } catch (ClassNotFoundException e) {  
100.                 ;  
101.             }  
102.         }  
103.   
104.         throw new ClassNotFoundException(name);  
105.     }  

可以看到，并非简单的父子委托方式加载类

3. JasperLoader是为了加载jsp编译成的servlet而创建的类加载器，它覆写了loadClass()方法，除过加载org.apache.jsp.*的文件外，其他的均使用父加载器加载。

核心代码如下：

Java代码

1. public Class loadClass(final String name, boolean resolve)  
2.         throws ClassNotFoundException {  
3.   
4.         Class clazz = null;                  
5.                                              
6.         // (0) Check our previously loaded class cache  
7.         clazz = findLoadedClass(name);       
8.         if (clazz != null) {                 
9.             if (resolve)                     
10.                 resolveClass(clazz);         
11.             return (clazz);          
12.         }                            
13.                             
14.         // (.5) Permission to access this class when using a SecurityManager  
15.         ……  
16.   
17.     if( !name.startsWith(Constants.JSP_PACKAGE_NAME) ) {  
18.             // Class is not in org.apache.jsp, therefore, have our  
19.             // parent load it  
20.             clazz = parent.loadClass(name);              
21.         if( resolve )  
22.         resolveClass(clazz);  
23.         return clazz;  
24.     }  
25.         //所有的以org.apache.jsp.*开头的文件都由该类加载器加载。  
26.     return findClass(name);  
27.     }  

 

 

今天就讲到这里了。