总结
WebApp?ClassLoader的工作原理和上述有少许不同: 它先试图自己载入类(在ContextBase?/WEB-INF/...中载入类),如果无法载入,再请求父ClassLoader完成 由此可得: - 对于WEB APP线程,它的contextClassLoader是WebApp?ClassLoader - 对于Tomcat Server线程,它的contextClassLoader是CatalinaClassLoader
Tomcat启动时classloader加载顺序 Tomcat的class加载的优先顺序一览 1.最先是$JAVA_HOME/jre/lib/ext/下的jar文件。 2.环境变量CLASSPATH中的jar和class文件。 3.$CATALINA_HOME/common/classes下的class文件。 4.$CATALINA_HOME/commons/endorsed下的jar文件。 5.$CATALINA_HOME/commons/i18n下的jar文件。 6.$CATALINA_HOME/common/lib 下的jar文件。 (JDBC驱动之类的jar文件可以放在这里,这样就可以避免在server.xml配置好数据源却出现找不到JDBC Driver的情况。) 7.$CATALINA_HOME/server/classes下的class文件。 8.$CATALINA_HOME/server/lib/下的jar文件。 9.$CATALINA_BASE/shared/classes 下的class文件。 10.$CATALINA_BASE/shared/lib下的jar文件。 11.各自具体的webapp /WEB-INF/classes下的class文件。 12.各自具体的webapp /WEB-INF/lib下的jar文件。 class的搜寻顺序如下: ------------- Bootstrap classes of your JVM System class loader classses (described above) /WEB-INF/classes of your web application /WEB-INF/lib/*.jar of your web application $CATALINA_HOME/common/classes $CATALINA_HOME/common/endorsed/*.jar $CATALINA_HOME/common/i18n/*.jar $CATALINA_HOME/common/lib/*.jar $CATALINA_BASE/shared/classes $CATALINA_BASE/shared/lib/*.jar -------------- 因此放在不同webapp里的class文件,会被classloader加载成不同的实例。 例如假设下面两个不同内容的class。分别放在不同的webapp的class目录下。 package com.lizongbo; public class TestClass { private String NAME="lizongbo"; } package com.lizongbo; public class TestClass { private String NAME="li_zongbo"; } 在不同的webapp得到的com.lizongbo.NAME结果是不同的,且互不影响。 但是注意,以下包名开头的class例外: javax.* org.xml.sax.* org.w3c.dom.* org.apache.xerces.* org.apache.xalan.* ps,注意.在各个jar中的\META-INF\MAINFEST.MF文件里Class-Path键值对,也会提供jar的加载优先顺序。 例如某jar的MAINFEST.MF内容如下: Manifest-Version: 1.0 Created-By: lizongbo Class-Path: commons-beanutils.jar Class-Path: commons-collections.jar Class-Path: commons-dbcp.jar Class-Path: commons-digester.jar Class-Path: commons-logging.jar Class-Path: commons-pool.jar Class-Path: commons-services.jar Class-Path: commons-validator.jar Class-Path: jakarta-oro.jar Main-Class: com.lizongbo.MyTestClass 那么在加载这个jar的时候,会先在此jar所在目录下依次先加载commons-beanutils.jar,commons-collections.jar。。。等jar文件。 在不同的地方放置jar和class可能会产生意想不到的后果,,尤其是不同版本的jar文件,因此在实际应用部署web应用时候要特别留心. 例如 使用javamail常见的一个出错信息: javax.mail.NoSuchProviderException: No provider for smtp 其真实原因就很可能如下: 在不同的加载jar的目录下放置了不同版本的mail.jar,比如一个是javamail1.3.1的mail.jar 在D:\jakarta-tomcat-5.5.8\common\lib下,而另外一个是javamail1.3.2的mail.jar在 D:\jakarta-tomcat-5.5.8\webapps\lizongbo\WEB-INF/lib下, 那么lizongbo这个webapp中使用到javamail进行邮件发送的时候,便会出现No provider for smtp的错误。 ******************************************************************* ClassLoader in Tomcat ************************************ 1 - Tomcat 的类载入器的结构 Tomcat Server 在启动的时候将构造一个ClassLoader树,以保证模块的类库是私有的 Tomcat Server的ClassLoader结构如下: +-----------------------------+ | Bootstrap | |
Extension | | | | System | | | | | Common | | / \ | | Catalina Shared | | / \ | | WebApp1 WebApp2 | +-----------------------------+ 其中: - Extension - 载入JVM自带的类和$JAVA_HOME/jre/lib/ext/*.jar - System - 载入$CLASSPATH/*.class - Common - 载入$CATALINA_HOME/common/...,它们对TOMCAT和所有的WEB APP都可见 - Catalina - 载入$CATALINA_HOME/server/...,它们仅对TOMCAT可见,对所有的WEB APP都不可见 - Shared - 载入$CATALINA_HOME/shared/...,它们仅对所有WEB APP可见,对TOMCAT不可见(也不必见) - WebApp - 载入ContextBase?/WEB-INF/...,它们仅对该WEB APP可见 2 - ClassLoader 的工作原理 每个运行中的线程都有一个成员contextClassLoader,用来在运行时动态地载入其它类 系统默认的contextClassLoader是systemClassLoader,所以一般而言java程序在执行时可以使用JVM自带的类、$JAVA_HOME/jre/lib/ext/中的类和$CLASSPATH/中的类 可以使用 Thread.currentThread().setContextClassLoader(...); 更改当前线程的contextClassLoader,来改变其载入类的行为 ClassLoader 被组织成树形,一般的工作原理是: 1) 线程需要用到某个类,于是contextClassLoader被请求来载入该类 2) contextClassLoader请求它的父ClassLoader来完成该载入请求 3) 如果父ClassLoader无法载入类,则contextClassLoader试图自己来载入 注意 :WebApp?ClassLoader的工作原理和上述有少许不同: 它先试图自己载入类(在ContextBase?/WEB-INF/...中载入类),如果无法载入,再请求父ClassLoader完成 由此可得: - 对于WEB APP线程,它的contextClassLoader是WebApp?ClassLoader - 对于Tomcat Server线程,它的contextClassLoader是CatalinaClassLoader 3 类的查找 ClassLoader类中loadClass方法为缺省实现,用下面的顺序查找类: 1、调用findLoadedClass方法来检查是否已经被加载。如果没有则继续下面的步骤。 2、如果当前类装载器有一个指定的委托父装载器,则用委托父装载器的loadClass方法加载类,也就是委托给父装载器加载相应的类。 3、如果这个类装载器的委托层级体系没有一个类装载器加载该类,则使用类装载器定位类的特定实现机制,调用findClass方法来查找类。 4 - 部分原代码分析 4.1 - org/apache/catalina/startup/Bootstrap.java Bootstrap中定义了三个classloader:commonLoader,catalinaLoader,sharedLoader.三者关系如下: // 注意三个自己定置的ClassLoader的层次关系: // systemClassLoader (root) // +--- commonLoader // +--- catalinaLoader // +--- sharedLoader Tomcat Server 线程的起点 构造ClassLoader树,通过Thread.currentThread().setContextClassLoader(catalinaLoader)设置当前的classloader为catalinaLoader。 载入若干类,然后转入org.apache.catalina.startup.Catalina类中 4.2 org.apache.catalina.loader.StandardClassLoader.java 通过看loadClass这个方法来看tomcat是如何加载类的,顺序如下: (0) Check our previously loaded class cache查找已经装载的class clazz = findLoadedClass(name); (1) If a system class, use system class loader通过系统classloader来装载class ClassLoader loader = system; clazz = loader.loadClass(name); (2) Delegate to our parent if requested如果有代理则使用父类classloader ClassLoader loader = parent; if (loader == null) loader = system; clazz = loader.loadClass(name); (3) Search local repositories 查找本地类池,比如$CATALINA_HOME/server clazz = findClass(name); (4) Delegate to parent unconditionally 默认使用代理装载器 [ 查看代码] 4.3 - org/apache/catalina/startup/ClassLoaderFactory.java 根据设置创建并返回StandardClassLoader的实例 [ 查看代码] 4.4 - org/apache/catalina/loader/StandardClassLoader.java 类载入器 4.5 - org/apache/catalina/startup/SecurityClassLoad.java 该类仅包含一个静态方法,用来为catalinaLoader载入一些类 [ 查看代码] Appendix - 参考 [1] http://jakarta.apache.org/tomcat/ 中的Tomcat 4.1.x文档Class Loader HOW-TO 在一个 JVM 中可能存在多个 ClassLoader ,每个 ClassLoader 拥有自己的 NameSpace 。一个 ClassLoader 只能拥有一个 class 对象类型的实例,但是不同的 ClassLoader 可能拥有相同的 class 对象实例,这时可能产生致命的问题。如 ClassLoaderA ,装载了类 A 的类型实例 A1 ,而 ClassLoaderB ,也装载了类 A 的对象实例 A2 。逻辑上讲 A1=A2 ,但是由于 A1 和 A2 来自于不同的 ClassLoader ,它们实际上是完全不同的,如果 A 中定义了一个静态变量 c ,则 c 在不同的 ClassLoader 中的值是不同的。