Tomcat服务器启动错误之Offending class: javax/servlet/Servlet.class

     引子   

    最近在基于Wex5项目开发中，遇到使用过程中与Tomcat功能有关的错误提示， 如题所示。最终的解决方法就是删除掉项目上与tomcat冲突的jar包。

org.apache.catalina.loader.WebappClassLoader validateJarFile ??: validateJarFile(/Users/zxzpc/Downloads/X5/WeX5_V3.4mac/apache-tomcat/webapps/../../runtime/BaasServer/WEB-INF/lib/servlet-api.jar) - jar not loaded. See Servlet Spec 2.3, section 9.7.2. Offending class: javax/servlet/Servlet.class

      顺便查找了一些资料，整理如下：

      Tomcat 启动后先将tomcat/common/lib目录下的jar包全部读入内存，如果webapps目录里的应用程序中WEB-INF/lib目录下有相同的包，将无法加载，估计不同版本的包之间也会造成类似问题。因此建议尽量不要把jar包放入tomcat/common/lib目录下，应该放入WEB- INF/lib目录下。

    Tomcat类加载顺序小结

    Tomcat下的文件目录 

1. /bin：存放启动和关闭tomcat的脚本文件；

2.  /conf：存放tomcat的各种配置文件，比如：server.xml 

3. /server/lib：存放tomcat服务器所需要的各种jar文件（jar文件只可被tomcat 服务器访问） 

4. /server/webapps：存放tomcat自带的两个web应用：admin应用和manager应用。 

5. /common/lib：存放tomcat服务器以及所有web应用都可以访问的jar文件夹（web和tomcat服务器都可访问此jar）

6. /shared/lib：存放web都可访问的jar文件。（可以被所有的web访问，但不能被tomcat访问）

7.  /logs：存放tomcat的日志文件 

8. /webapps：当发布web应用时，默认情况下把web应用文件放于此目录下 

9. /work：tomcat把由jsp生成的Servlet放于此目录 
   
   另：在web应用中，WEB-Inf目录下，也可以建立lib子目录，在此子目录下可以存放各种jar文件，这些jar文件只能被当前web应用访问。其中，在web-inf目录下的lib与classes目录，Tomcat类装载器先装载classes目录下的类，再装载lib目录下的类。因为类同名时，classes优先。 
   
   其中jsp运行时，查找class的顺序为：项目文件夹（WEB-INF\lib）―>容器文件夹（tomcat\common\lib）―>jdk文件夹(jdk\jre\lib\ext) 
   
   

    默认情况下，Tomcat是一种向上寻找的层次结构，也有向下的，或者是可配置的。 

    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文件可以放在这里，避免配置好数据源却找不到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的搜寻顺序

/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加载成不同的实例。 在不同的webapp加载相同类名的类互不影响。 

但是注意，以下包名开头的class例外： 
javax.* 
org.xml.sax.* 
org.w3c.dom.* 
org.apache.xerces.* 
org.apache.xalan.* 

值得注意的是：在各个jar中的\META-INF\MAINFEST.MF文件里Class-Path键值对，也会提供jar的加载优先顺序。 
例如某jar的MAINFEST.MF内容如下： 
Manifest-Version: 1.0 
Created-By: Zianed 
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: Test 

那么在加载这个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\mialtest\WEB-INF/lib下, 那么mialtest中使用到javamail进行邮件发送的时候，便会出现No provider for smtp的错误。