Thread.currentThread().setContextClassLoader为什么不生效与java.lang.NoClassDefFoundError之Java类加载的Parent first Classloader

众所周知，Java的类加载机制采用了双亲委派模型，导致在进行类加载的时候会有多个加载器，这种复杂的机制，有时候会导致‘Exception in thread main java.lang.NoClassDefFoundError’这个异常，虽然可能你认为相应的类和jar包就在某个类加载器中。下面的文字，会试图尝试解释为什么会发生这种情况。

 

下面提供了一个简单的java程序来帮助理解问题的发生。

 

 默认的JVM的类加载委派模型

 

默认的类加载委派模式是从下向上的，也就是双亲委派。这意味着JVM会从下往上来委托类加载器去查找和加载用户的类，如果父加载器没能加载相应的类，这时才会尝试在当前线程上下文的类加载器中去加载，一般而言是子加载器。

NoClassDefFoundError这种异常时有发生，比如，用户自己的jar包打的不对，再比如，依赖的第三方jar包或者容器注入的类型，这些情况都有可能导致问题的发生。

 

在以上这些场景中：

• JVM将程序的部分类型在父加载器中加载了（比如系统或者父加载器）
• JVM将程序的其他部分想要在子加载器中加载（比如容器或者用户自定义加载器）

当在父加载器中加载的类尝试去通过子加载器加载相应的类时会发生什么？当然是NoClassDefFoundError！

因为父加载器对子加载器一无所知。只有当引用的类在是父加载器或当前线程上下文加载器中，才可能会去加载，否则就会抛出java.lang.NoClassDefFoundError。

 

下面的代码将会展示这些问题：

 

样例Java程序

 

为了演示，程序被如下分割:

• 主程序NoClassDefFoundErrorSimulator会被打包在MainProgram.jar
• 日志输出程序JavaEETrainingUtil也被打包在MainProgram.jar
• caller类CallerClassA被打包在caller.jar
• 被引用的类ReferencingClassA被打包在referencer.jar

然后执行下面的任务：

• 创建一个子加载器(java.net.URLClassLoader)
• 将caller.jar和referencher.jar分配给上面创建的子加载器
• 将当前线程上下文加载器更改为上面的子加载器
• 尝试从当前线程上下文加载器加载和创建CallerClassA类的实例
• 日志输出用来帮助理解类加载器的变化和线程上下文加载器的状态

下面将展示错误的打包方式和默认的类加载委派模型是如何产生NoClassDefFoundError这个异常的。

 

** JavaEETrainingUtil source code can be found from the article part #2

 #### NoClassDefFoundErrorSimulator.java
 package org.ph.javaee.training3;

 import java.net.URL;
 import java.net.URLClassLoader;

 import org.ph.javaee.training.util.JavaEETrainingUtil;

 /**
  * NoClassDefFoundErrorSimulator
  * @author Pierre-Hugues Charbonneau
  *
  */
 public class NoClassDefFoundErrorSimulator {

         /**
          * @param args
          */
         public static void main(String[] args) {

                System.out.println("java.lang.NoClassDefFoundError Simulator - Training 3");
                System.out.println("Author: Pierre-Hugues Charbonneau");
                System.out.println("http://javaeesupportpatterns.blogspot.com");

                // Local variables
                String currentThreadName = Thread.currentThread().getName();
                String callerFullClassName = "org.ph.javaee.training3.CallerClassA";

                // Print current ClassLoader context & Thread
                System.out.println("\nCurrent Thread name: '"+currentThreadName+"'");
                System.out.println("Initial ClassLoader chain: "+JavaEETrainingUtil.getCurrentClassloaderDetail());

                try {
                        // Location of the application code for our child ClassLoader
                        URL[] webAppLibURL = new URL[] {new URL("file:caller.jar"),new URL("file:referencer.jar")};

                        // Child ClassLoader instance creation
                        URLClassLoader childClassLoader = new URLClassLoader(webAppLibURL);

                        /*** Application code execution... ***/

                        // 1. Change the current Thread ClassLoader to the child ClassLoader
                        Thread.currentThread().setContextClassLoader(childClassLoader);
                        System.out.println(">> Thread '"+currentThreadName+"' Context ClassLoader now changed to '"+childClassLoader+"'");
                        System.out.println("\nNew ClassLoader chain: "+JavaEETrainingUtil.getCurrentClassloaderDetail());

                        // 2. Load the caller Class within the child ClassLoader...
                        System.out.println(">> Loading '"+callerFullClassName+"' to child ClassLoader '"+childClassLoader+"'...");
                        Class<?> callerClass = childClassLoader.loadClass(callerFullClassName);

                        // 3. Create a new instance of CallerClassA
                        Object callerClassInstance = callerClass.newInstance();                    

                } catch (Throwable any) {
                        System.out.println("Throwable: "+any);
                        any.printStackTrace();
                }

                System.out.println("\nSimulator completed!");
         }
 }

 #### CallerClassA.java
 package org.ph.javaee.training3;

 import org.ph.javaee.training3.ReferencingClassA;

 /**
  * CallerClassA
  * @author Pierre-Hugues Charbonneau
  *
  */
 public class CallerClassA {

         private final static Class<CallerClassA> CLAZZ = CallerClassA.class;

         static {
                System.out.println("Class loading of "+CLAZZ+" from ClassLoader '"+CLAZZ.getClassLoader()+"' in progress...");
         }

         public CallerClassA() {
                System.out.println("Creating a new instance of "+CallerClassA.class.getName()+"...");

                doSomething();
         }

         private void doSomething() {

                // Create a new instance of ReferencingClassA
                ReferencingClassA referencingClass = new ReferencingClassA();
         }
 }

 #### ReferencingClassA.java
 package org.ph.javaee.training3;

 /**
  * ReferencingClassA
  * @author Pierre-Hugues Charbonneau
  *
  */
 public class ReferencingClassA {

         private final static Class<ReferencingClassA> CLAZZ = ReferencingClassA.class;

         static {
                System.out.println("Class loading of "+CLAZZ+" from ClassLoader '"+CLAZZ.getClassLoader()+"' in progress...");
         }

         public ReferencingClassA() {
                System.out.println("Creating a new instance of "+ReferencingClassA.class.getName()+"...");
         }

         public void doSomething() {
                //nothing to do...
         }
 }

问题重现

 

为了复现问题，简单的将caller和referencing分别打包并且赋给不同的加载器。现在，可以先以正确的jar包部署来执行程序： 

• 主程序和工具包被部署在父加载器 (SYSTEM classpath)
• CallerClassA 和ReferencingClassA被部署在子加载器中

 ## Baseline (normal execution)
 <JDK_HOME>\bin>java -classpath MainProgram.jar org.ph.javaee.training3.NoClassDefFoundErrorSimulator

 java.lang.NoClassDefFoundError Simulator - Training 3
 Author: Pierre-Hugues Charbonneau
 http://javaeesupportpatterns.blogspot.com

 Current Thread name: 'main'
 Initial ClassLoader chain:
 -----------------------------------------------------------------
 sun.misc.Launcher$ExtClassLoader@17c1e333
 --- delegation ---
 sun.misc.Launcher$AppClassLoader@214c4ac9 **Current Thread 'main' Context ClassLoader**
 -----------------------------------------------------------------

 >> Thread 'main' Context ClassLoader now changed to 'java.net.URLClassLoader@6a4d37e5'

 New ClassLoader chain:
 -----------------------------------------------------------------
 sun.misc.Launcher$ExtClassLoader@17c1e333
 --- delegation ---
 sun.misc.Launcher$AppClassLoader@214c4ac9
 --- delegation ---
 java.net.URLClassLoader@6a4d37e5 **Current Thread 'main' Context ClassLoader**
 -----------------------------------------------------------------

 >> Loading 'org.ph.javaee.training3.CallerClassA' to child ClassLoader 'java.net.URLClassLoader@6a4d37e5'...
 Class loading of class org.ph.javaee.training3.CallerClassA from ClassLoader 'java.net.URLClassLoader@6a4d37e5' in progress...
 Creating a new instance of org.ph.javaee.training3.CallerClassA...
 Class loading of class org.ph.javaee.training3.ReferencingClassA from ClassLoader 'java.net.URLClassLoader@6a4d37e5' in progress...
 Creating a new instance of org.ph.javaee.training3.ReferencingClassA...

 Simulator completed!

在基准测试中，主程序可以正常运行，CallerClassA和他引用的类都可以被加载和实例化。

 

现在再次尝试运行程序，但是以一种错误的打包和部署方式来进行：

• 主程序和工具类都被部署在父加载器(SYSTEM classpath)
• CallerClassA和ReferencingClassA被部署在子加载器
  
• CallerClassA (caller.jar)也被部署在父加载器

 ## Problem reproduction run (static variable initializer failure)
 <JDK_HOME>\bin>java -classpath MainProgram.jar;caller.jar org.ph.javaee.training3.NoClassDefFoundErrorSimulator

 java.lang.NoClassDefFoundError Simulator - Training 3
 Author: Pierre-Hugues Charbonneau
 http://javaeesupportpatterns.blogspot.com

 Current Thread name: 'main'
 Initial ClassLoader chain:
 -----------------------------------------------------------------
 sun.misc.Launcher$ExtClassLoader@17c1e333
 --- delegation ---
 sun.misc.Launcher$AppClassLoader@214c4ac9 **Current Thread 'main' Context ClassLoader**
 -----------------------------------------------------------------

 >> Thread 'main' Context ClassLoader now changed to 'java.net.URLClassLoader@6a4d37e5'

 New ClassLoader chain:
 -----------------------------------------------------------------
 sun.misc.Launcher$ExtClassLoader@17c1e333
 --- delegation ---
 sun.misc.Launcher$AppClassLoader@214c4ac9
 --- delegation ---
 java.net.URLClassLoader@6a4d37e5 **Current Thread 'main' Context ClassLoader**
 -----------------------------------------------------------------

 >> Loading 'org.ph.javaee.training3.CallerClassA' to child ClassLoader 'java.net.URLClassLoader@6a4d37e5'...
 Class loading of class org.ph.javaee.training3.CallerClassA from ClassLoader 'sun.misc.Launcher$AppClassLoader@214c4ac9' in progress...// Caller is loaded from the parent class loader, why???
 Creating a new instance of org.ph.javaee.training3.CallerClassA...
 Throwable: java.lang.NoClassDefFoundError: org/ph/javaee/training3/ReferencingClassA
 java.lang.NoClassDefFoundError: org/ph/javaee/training3/ReferencingClassA
         at org.ph.javaee.training3.CallerClassA.doSomething(CallerClassA.java:27)
         at org.ph.javaee.training3.CallerClassA.<init>(CallerClassA.java:21)
         at sun.reflect.NativeConstructorAccessorImpl.newInstance0(Native Method)
         at sun.reflect.NativeConstructorAccessorImpl.newInstance(Unknown Source)
         at sun.reflect.DelegatingConstructorAccessorImpl.newInstance(Unknown Source)
         at java.lang.reflect.Constructor.newInstance(Unknown Source)
         at java.lang.Class.newInstance0(Unknown Source)
         at java.lang.Class.newInstance(Unknown Source)
         at org.ph.javaee.training3.NoClassDefFoundErrorSimulator.main(NoClassDefFoundErrorSimulator.java:51)
 Caused by: java.lang.ClassNotFoundException: org.ph.javaee.training3.ReferencingClassA
         at java.net.URLClassLoader$1.run(Unknown Source)
         at java.net.URLClassLoader$1.run(Unknown Source)
         at java.security.AccessController.doPrivileged(Native Method)
         at java.net.URLClassLoader.findClass(Unknown Source)
         at java.lang.ClassLoader.loadClass(Unknown Source)
         at sun.misc.Launcher$AppClassLoader.loadClass(Unknown Source)
         at java.lang.ClassLoader.loadClass(Unknown Source)
         ... 9 more

 Simulator completed!

发生什么了?

• 主程序和工具类都正常的从父加载器加载成功 (sun.misc.Launcher$AppClassLoader)
• 线程上下文加载器被更改为包含caller和reference的子加载器。
• 但是我们会看到CallerClassA 会被父加载器加载 (sun.misc.Launcher$AppClassLoader) ，并没有被子加载器加载
• 由于ReferencingClassA 没有被部署在父加载器, 所以他不能在当前加载器中加载，又由于父加载器对子加载器的无知，所以也不可能被子加载器加载。然后就报错NoClassDefFoundError。

 

关键点在于理解为什么CallerClassA会被父加载器加载。答案就在于默认的类加载委派模型，尽管子加载器和父加载器都包含caller的jar包，但默认的委派模型是父优先，这就导致caller只会在父加载器中被加载。但同时caller引用的ReferencingClassA却被部署在了子加载器，所以java.lang.NoClassDefFoundError自然会发生。

 正如你所见，由于默认的类加载委托模型的存在，代码的打包或者第三方的api都会导致这个问题的发生。所以，很重要的事情就是，你需要检视你的类加载器链条，确定是否有相同的代码或类库被重复部署在不同的父加载器和子加载器中。

 

建议和策略

 

如下是给出的建议和策略：

• 仔细检视异常java.lang.NoClassDefFoundError并确定到底是哪个类导致问题
• 检视受影响的程序的打包方式，看看是否能找到是相应的类存在重复或者错误的部署方式。(SYSTEM class path, EAR file, Java EE container itself etc.).
• 如果找到了，那就需要将响应的类库从受影响的类加载器中移除。(有时会很复杂)
• 启用jvm的属性verbose，比如–verbose:class很有帮助，会帮助你定位类是从哪个加载器中加载的。

翻译自：https://javaeesupportpatterns.blogspot.com/2012/08/javalangnoclassdeffounderror-parent.html