代码收藏家技术教程 2023-12-23

Tomcat部署常见问题汇总及解决方法

一.Jar包冲突

由于项目当中依赖了一些框架，而这些框架无法直接修改时，就直接本地代码写了一个同名同包路径的类，可以直接覆盖框架的类,但是心里不免有疑问，为啥本地写的同名同路径的类，可以覆盖三方框架的类呢？如果我依赖了jarA和jarB，俩jar包有一个同名同路径的类，那JVM会加载哪一个类呢？

我新增一个jar包中的某个类的方法,就在同名同路径下覆盖了这个类,本地机器好用,到了测试的容器,报方法找不到的错误,java.lang.NoSuchMethodError,一般是jar包冲突引起的,此类问题其他错误诸如java.lang.ClassNotFoundException与java.lang.NoClassDefFoundError

根据报错信息，可以明显知道，就是方法找不到，加载时读取了原有的jar包里的类和方法，没有读取新加的类和方法。

不同的机器会有不一样,平时没有问题,所以也没细想过,为什么有的机器会加载正确的类,有的是错误的类,为了根本上解决问题,特意花了些时间研究了下。

本次事件是lib与class中的方法冲突，如果项目中引用相同名不同版本的jar包，如果要确定项目中引用了哪个版本的jar包，只需要看最后打完包后，打进lib下是哪个jar包就可以了

加载顺序

1.查看加载顺序

方法一：通过JVM参数获取加载路径:java -verbose:class -jar yourApplication.jar

方法二: JDK工具 jinfo pid

方法三：idea中VM options中配置JVM参数:-XX:+TraceClassPaths在控制台搜索 java.class.path 就能看到具体的配置；java.class.path 的顺序就是 jvm 加载class以及 jar包的顺序；排在前面的会优先加载；

2.tomcat启动加载顺序

当我们启动一个tomcat的服务的时候，jar包和claess文件是是以怎么样的顺序被加载进来的？

加载顺序：

1. $java_home/lib 目录下的java核心api

2. $java_home/lib/ext 目录下的java扩展jar包

3. java -classpath/-Djava.class.path所指的目录下的类与jar包

4. $CATALINA_HOME/common目录下按照文件夹的顺序从上往下依次加载

5. $CATALINA_HOME/server目录下按照文件夹的顺序从上往下依次加载

6. $CATALINA_BASE/shared目录下按照文件夹的顺序从上往下依次加载

7. 我们的项目路径/WEB-INF/classes下的class文件

8. 我们的项目路径/WEB-INF/lib下的jar文件

在同一个文件夹下，jar包是按顺序从上到下依次加载

由ClassLoader的双亲委托模式加载机制我们可以知道，假设两个包名和类名完全相同的class文件不再同一个jar包，如果一个class文件已经被加载java虚拟机里了，那么后面的相同的class文件就不会被加载了

JVM不是一开始就把所有的类都加载进内存中，而是只有第一次遇到某个需要运行的类时才会加载，且只加载一次。

3.为什么相同的war，不同机器有的冲突有的没有

不同环境，有的可以，有的不可以。很多业务提出了为啥我的服务在测试环境啥问题都没有，发布生产就出问题了，第一反应是配置不一样?实际上部分原因可能还与发布的容器有关，比如Tomcat8，比如jar冲突。

Tomcat通过解压运行，加载默认通过File，会把lib下得jar按照字母排序，加载jar的顺序固定，所有环境一样，要么都冲突，要么都正常，环境验证好就不存在类冲突问题。

具体可以分析不同版本的下面两个文件

org.apache.catalina.loader.WebappLoader和org.apache.catalina.loader.WebappLoader

大致是顺序与服务器的信息有关，导致Tomcat8在不同服务器WEB-INF/lib的jar的顺序不一样，加载的类如果有冲突会不一样。

tomcat8之前，按照jar包字母顺序加载，寻找类和方法 ,tomcat8及之后版本，不再按照字母顺序加载，在不同服务器上受到影响，加载的顺序可以能不一致

实际上Tomcat7是不存在问题的，Tomcat8就会出现类冲突的情况，本质还是Tomcat8暴露了类冲突的情况，并不是Tomcat7解决问题，而是隐藏了问题。

最终对比和测试后发现，和服务器操作系统以及Tomcat版本有关。Windows上是可以的，Tomcat7 也可以，但是centos7 + Tomcat 8.5 就会报错。

针对Tomcat8以及以上版本，可以通过修改Tomcat服务器里conf下的context.xml，来指定优先加载部分需要的jar包。

spring boot又是怎么处理的呢，通过jarFile的迭代器迭代的，所以是顺序的，并且jar启动的的jar的BOOT-INF/lib也是不会顺序变换的

仅仅是Tomcat使用读取文件的方式启动就会根不同机器的环境相关，顺序不一致而出现类冲突的暴露问题，说明了不同环境问题出现的原因也会跟执行容器相关。这可能也是spring boot发展的一个原因。当然Tomcat也可以war读取，不解压运行，就不会有这个问题了，只是不知道什么原因不常用。

4.Tomcat配置优先加载某个jar包,解决相同类名冲突

当项目中存在相同的类，但具体的方法不同时，classloader加载了一个类之后，不会再加载第二个相同的类，但是你要用的类正好是那个没有被加载的类，此时，直接删了那个不用的类？可以解决，但最好是不删，万一那个类也是需要的呢，毕竟，在协同开发中，不要轻易的删除小伙伴的东西。还有，如果冲突的那个类在jar包中呢，而jar包中还有其他有用的类，这个时候，你只能告诉虚拟机（或者是说web容器，这里就是tomcat）优先加载哪个jar包。

配置方法：具体有两种方法，第一种，在${CATALINA_HOME}/conf/context.xml全局配置文件中配置（有可能会影响其他的项目，不推荐）；第二种，在项目的META-INF/context.xml中配置。

<?xml version="1.0" encoding="UTF-8"?>
<Context>
    <Resources>
        <PreResources base="${catalina.home}\webapps\grc\WEB-INF\lib\grc-common-1.0-SNAPSHOT.jar"
                      className="org.apache.catalina.webresources.JarResourceSet"
                      webAppMount="/WEB-INF/classes"/>
    </Resources>
</Context>

设置 classpath

设置多个类路径；多个类路径以分号分隔

D:> java -classpath C:\java\MyClasse1;C:\java\MyClass2 com.yiibai.MainApp

设置多个jar的路径顺序：多个jar使用英文冒号进行分割

-classpath /data/tomcat_8081/bin/bootstrap.jar:/data/tomcat_8081/bin/tomcat-juli.jar

CATALINA_HOME与CATALINA_BASE

catalina.home是指Tomcat服务器安装的根目录路径，也是Tomcat服务器启动时的默认工作目录。

在Tomcat服务器的目录结构中，catalina.home包括了bin、conf、lib、logs、temp和webapps等几个子目录，分别存放Tomcat服务器的可执行文件、配置文件、库文件、日志文件、临时文件和Web应用程序。

CATALINA_HOME：代表Tomcat安装的根路径。

CATALINA_BASE：代表特定的Tomcat实例在运行时配置的根路径。如果希望在一台计算机上有多个Tomcat实例，请使用CATALINA_BASE属性。

官方文档

tomcat文档:https://tomcat.apache.org/tomcat-8.0-doc/config/resources.html

排序

除了上面描述的资源集之外，标准实现还维护ClassResources，它表示映射到/WEB-INF/classes的JAR文件中包含的类。这使得其他组件只需一个调用就可以搜索类，而不是先搜索/WEB-INF/classes，然后再搜索/WEB-INF/lib中的jar文件。当web应用程序启动时，ClassResources从映射到/WEB-INF/lib的jar文件中填充。

因此，完整的搜索顺序为:

PreResources

MainResources

ClassResources

JarResources

PostResources

二.META-INF

META-INF, 相当于一个信息包，用于存放一些meta information相关的文件。用来配置应用程序、扩展程序、类加载器和服务manifest.mf文件，在用jar打包时自动生成。

这个文件夹应该被看作是JAVA工程的一个内部META目录，所以这个目录下的文件应该都是build工具来生成的

三.WEB-INF

简介

WEB-INF 是 Java 的 web 应用的安全目录。所谓安全就是客户端无法访问，只有服务端可以访问的目录。也就是说，这个目录是给服务端看的，那么，如果想要在客户端进行访问的话，就必须通过 web.xml 文件或是采用注解的方式对要访问的文件进行映射。

并且整个 web 应用程序的目录结构应该合理，文件应该放置在正确的位置，否则可能会出现 “404无法访问” 的问题。

作用

/WEB-INF/web.xml

Web应用程序配置文件，描述了 servlet 和其他的应用组件配置及命名规则。

/WEB-INF/classes/

包含了站点所有用的 class 文件，包括 servlet class 和非servlet class，他们不能包含在 .jar文件中。

/WEB-INF/lib/

存放web应用需要的各种JAR文件，放置仅在这个应用中要求使用的jar文件,如数据库驱动jar文件。

/WEB-INF/tags/

存放了自定义标签文件，该目录并不一定为 tags，可以根据自己的喜好和习惯为自己的标签文件库命名，当使用自定义的标签文件库名称时，在使用标签文件时就必须声明正确的标签文件库路径。例如：当自定义标签文件库名称为 simpleTags 时，在使用 simpleTags 目录下的标签文件时，就必须在 jsp 文件头声明为：<%@ taglibprefix="tags" tagdir="/WEB-INF /simpleTags" % >。

静态资源的访问

此处的静态资源包括：html、css、js、img 等。在上面第二条中说到，此目录为安全目录，则其中的如 jsp 文件等都需要利用控制器进行跳转访问，而这些静态资源也不例外，不能被目录外的其他文件进行访问。

这些静态资源一般放在 static 文件夹下，而 jsp 则放在相应的 jsp文件夹下，所以 jsp 文件要访问这些静态资源时需要通过相对路径来引用

webapp结构和tomcat下webapps下部署时结构对比