延迟加载单例模式(IoDH)引发的NoClassDefFoundError

声明：原创文章，转载请注明出处。https://www.jianshu.com/p/f48c90270fae

一、问题背景

最近题主发布在公司的SDK遇到了一个Bug。有关单例模式的，什么问题呢？
我们先回想下，单例模式怎么写。（https://www.jianshu.com/p/f71fabb46233）

简而言之：

• 私有的构造方法
• 提供一个静态可以获取实例对象的方法

其分类可大致分为：

• 非延迟加载（饿汉）
• 延迟加载（懒汉等）

问题：
题主使用的是：initialization-on-demand holder idiom 这种方法实现。然而却抛出了以下异常：

java.lang.NoClassDefFoundError: Could not initialize class SingleTon$Holder
    at SingleTon.getInstance(SingleTon.java:11)
    at SingleTon.main(SingleTon.java:24)

看下大致实现单例代码：

public class SingleTon {
    private SingleTon() {}

    private static class Holder {
        private static final SingleTon INSTANCE = new SingleTon();
    }

    public static SingleTon getInstance() {
        return Holder.INSTANCE;
    }
}

乍一看，SingleTon这个类都已经执行到了，怎么会找不到其内部类Holder呢？NoClassDefFoundError常见的场景是，类不存在或版本冲突。这里都不满足，我们复现下这个问题。

二、问题复现

如果在构造SingleTon对象时，抛出异常会怎样？

public class SingleTon {
    private SingleTon() {
        int i = 1 / 0;
    }

    private static class Holder {
        private static final SingleTon INSTANCE = new SingleTon();
    }

    public static SingleTon getInstance() {
        return Holder.INSTANCE;
    }

    public static void main(String[] args) {
        try {
            System.out.println("First");
            SingleTon.getInstance();
        } catch (Throwable t) {
            t.printStackTrace();
        }

        try {
            System.out.println("Second");
            SingleTon.getInstance();
        } catch (Throwable t) {
            t.printStackTrace();
        }
    }
}

看一下输出：

First
Second
java.lang.ExceptionInInitializerError
    at SingleTon.getInstance(SingleTon.java:11)
    at SingleTon.main(SingleTon.java:17)
Caused by: java.lang.ArithmeticException: / by zero
    at SingleTon.(SingleTon.java:3)
    at SingleTon.(SingleTon.java:1)
    at SingleTon$Holder.(SingleTon.java:7)
    ... 2 more
java.lang.NoClassDefFoundError: Could not initialize class SingleTon$Holder
    at SingleTon.getInstance(SingleTon.java:11)
    at SingleTon.main(SingleTon.java:24)

初步分析是：IoDH这种单例实现为线程安全的延迟加载方式。
第一次调用getInstance()时，由于出现了异常导致SingleTon对象没有生成，进而导致该Holder类没有成功加载。
第二次调用时，则会出现NoClassDefFoundError。

三、问题分析

IoDH(initialization on demand holder) 为一种延迟加载且线程安全的单例模式实现方式。这种方式的实现依赖于JVM对类加载过程中初始化阶段的执行。

分析下这个单例类的初始化过程：

• 当SingleTon类被JVM加载时，由于这个类没有其他静态属性，其初始化过程会顺利完成。但是内部静态类Holder直到调用getInstance()时才会被初始化。
• 当Holder第一次被执行时，JVM会加载并初始化该类。由于Holder含有静态方法INSTANCE，因此会一并初始化INSTANCE。JLS保证了类的初始化阶段是连续的。这样，所有后序的并发调用getInstance()都会返回一个正确初始化的INSTANCE而不会有额外同步开销。
• 但是，任何初始化失败都会导致单例类不可用。也就是说，IoDH这种实现方式只能用于能保证初始化不会失败的情况。