浅谈NoClassDefFoundError

最近因为项目的原因,发现一个运行时错误:NoClassDefFoundError,对于这个常见的java Error进行一下总结。同时区分一下NoClassDefFoundError与ClassNotFoundException。

ClassNotFoundException

下面是一个ClassNotFoundException出现的场景,当使用JDBC去连接数据库的时候,一般会使用Class.forName()的方式去加载JDBC的驱动,如果没有将驱动放到应用的classpath下,那么会导致运行时找不到类,所以运行Class.forName()会抛出ClassNotFoundException:

public class MainClass {
    public static void main(String[] args) {
        try {
            Class.forName("oracle.jdbc.driver.OracleDriver");
        } catch (ClassNotFoundException e) {
            e.printStackTrace();
        }
    }
}

Log

java.lang.ClassNotFoundException: oracle.jdbc.driver.OracleDriver
    at java.net.URLClassLoader.findClass(URLClassLoader.java:382)
    at java.lang.ClassLoader.loadClass(ClassLoader.java:424)
    at sun.misc.Launcher$AppClassLoader.loadClass(Launcher.java:349)
    at java.lang.ClassLoader.loadClass(ClassLoader.java:357)
    at java.lang.Class.forName0(Native Method)
    at java.lang.Class.forName(Class.java:264)
    at com.ebay.app.SampleResource.main(SampleResource.java:43)

NoClassDefFoundError

NoClassDefFoundError是一个运行时异常,造成这个异常的原因,是在运行过程中,JVM无法找到运行时需要的class文件。

为什么在编译时能够通过,但是运行时却无法找到对应的class类。下面举一个例子。
有三个类,DependencyA(A),DependencyB(B),DependencyC(C)。这三个类是不同项目下的。

其中依赖关系:

  • A依赖B,并使用B中的打印方法:


  • B中依赖C,并使用了C中的方法:


pom.xml 如下:

<dependencies>
      <dependency>
           <groupId>com.test</groupId>
           <artifactId>C</artifactId>
           <scope>provided</scope>
      </dependency>
</dependencies>
  • C只是进行一个简单的输出:


NoClassDefFoundError

当执行A中的main方法时,可以看到,正常打印了A中的语句和B中的语句,但是在继续运行C的方法的时候,出现异常java.lang.NoClassDefFoundError: com/demo/c/DependencyC

  • Log


  • Pom
    由于demo中的代码使用maven进行依赖管理,需要考虑依赖问题。当查看pom文件配置后发现,程序A中只引入了B所在的jar包,但是对于B中需要的C类的jar包没有做依赖声明。
<dependencies>
      <dependency>
           <groupId>com.test</groupId>
           <artifactId>B</artifactId>
      </dependency>
</dependencies>
  • 分析
    A的做法是标准的Maven的做法,但是由于B对C的依赖是provided。而对于scope=provided的情况,maven 不会管理C,因此在class path 就没有C的jar。最常见的这类artifact是servlet-api.jar。
    当JVM在进行类加载的过程中,A依赖B,加载B的时候,从当前的依赖的Jar中找到对应的class文件,B中打印语句可以正常执行。当B依赖C,JVM开始加载C的过程中发现,无法在当前class path中找到对应的class文件,所以在这种情况下,就会报出NoClassDefFoundError。

其它出现NoClassDefFoundError的形式

其实还有更简单的形式,例如编译通过后,手动删除引用的某个class文件;修改引用的jar包名称。归根结底,NoClassDefFoundError出现的原因都是因为类加载过程中没有办法找到对应的class文件。
在源码中也明确写道,当JVM或类加载器尝试加载一个类时,这个类对应的class文件没有找到时,JVM会报出当前的错误。


/**
 * Thrown if the Java Virtual Machine or a <code>ClassLoader</code> instance
 * tries to load in the definition of a class (as part of a normal method call
 * or as part of creating a new instance using the <code>new</code> expression)
 * and no definition of the class could be found.
 * <p>
 * The searched-for class definition existed when the currently
 * executing class was compiled, but the definition can no longer be
 * found.
 *
 * @author  unascribed
 * @since   JDK1.0
 */
public
class NoClassDefFoundError extends LinkageError {
    private static final long serialVersionUID = 9095859863287012458L;

    /**
     * Constructs a <code>NoClassDefFoundError</code> with no detail message.
     */
    public NoClassDefFoundError() {
        super();
    }

    /**
     * Constructs a <code>NoClassDefFoundError</code> with the specified
     * detail message.
     *
     * @param   s   the detail message.
     */
    public NoClassDefFoundError(String s) {
        super(s);
    }
}

解决方案

以demo中演示的代码为例,只需要在A所在的Project中引入C所在的依赖,即可解决当前问题:


NoClassDefFoundError与ClassNotFoundException

如果JVM或者ClassLoader在加载类时找不到对应的类,就会引发NoClassDefFoundError和ClassNotFoundException。由于不同的ClassLoader会从不同的地方加载类,有时是错误的CLASSPATH引发这类错误,有时是某个库的jar包缺失引发这类错误。NoClassDefFoundError和ClassNotFoundException之间存在一些细微的不同点。

NoClassDefFoundError

  • 表示该类在编译阶段还可以找到,但是在运行Java应用的时候找不到了,有时静态块的初始化过程会导致NoClassDefFoundError。
  • NoClassDefFoundError是Error,是unchecked,因此也不需要使用try-catch或者finally语句块包围。
  • NoClassDefFoundError 是链接错误,发生在链接阶段,当解析引用的时候找不到对应的类,就会抛出java.lang.NoClassDefFoundError;ClassNotFoundException是异常,发生在运行阶段。

常见Case

如果开发中遇到NoClassDefFoundError,那么最有可能的原因

  • jar 包不存在
  • 存在多个类加载器和多个目标类,即我们常说的Jar包冲突。比如说上文的B ,如果有两个版本的B存在于依赖中 中, B1是compile scope , B2 是provided scope,如果maven 解析到B1,就不会有NoClassDefFoundError的问题,但是解析到B2,就有NoClassDefFoundError的问题。这种情况迷惑性比较大,第一次build 是可以的,同样的code 第二次build 就不可以了。非常难以定位。解决这种问题,通常需要用mvn dependency tree 来查看到底引用了哪些同名的Artifact,进而exclude 错误的artifacts。

ClassNotFoundException

  • 和编译期没什么关系,当你在代码中显式加载类(使用Class.forName())时没有找到对应的类,则会抛出java.lang.ClassNotFoundException。例如加载SQL驱动时,对应的类加载器找不到驱动类。
  • ClassNotFoundException是受检异常(checked Exception),因此需要使用try-catch语句块或者try-finally语句块包围,否则会导致编译错误

常见Case

调用Class.forName()、ClassLoader.findSystemClass()和ClassLoader.loadClass()等方法时可能会引起java.lang.ClassNotFoundException。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
禁止转载,如需转载请通过简信或评论联系作者。
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,546评论 6 507
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,224评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,911评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,737评论 1 294
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,753评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,598评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,338评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,249评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,696评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,888评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,013评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,731评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,348评论 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,929评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,048评论 1 270
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,203评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,960评论 2 355

推荐阅读更多精彩内容