从一个 NullPointerException 探究 Java 的自动装箱拆箱机制

前天遇到了一个 NullPointerException，触发的代码类似下面这样：

public class Test {
    public static long test(long value) {
        return value;
    }

    public static void main(String[] args) {
        Long value = null;
        // ...
        test(value);
    }
}

main 方法里的代码实际上相当于调用 test(null);，为什么不直接这样写呢？因为编译不过，会报 错误: 不兼容的类型: <空值>无法转换为long。

抛出问题

运行时提示 test(value); 这一行抛出 NullPointerException，但是看着以上代码会有些许困惑：以上代码里一个对象方法都没有调用啊，NullPointerException 从何而来？

原因分析

这时，如果留意到 test 方法接受的参数是 long 类型，而我们传入的是 Long 类型（虽然其实是 null），就会想到这会经历一次从类型 Long 到基本数据类型 long 的自动拆箱过程，那会不会是这个过程中抛出的 NullPointerException 呢？因为以前只知道 Java 为一些基础数据类型与对应的包装器类型之间提供了自动装箱拆箱机制，而并不知这机制的具体实现方法是怎么样的，正好学习一下。

用命令 javap -c Test 将以上代码编译出的 Test.class 文件进行反汇编，可以看到如下输出：

Compiled from "Test.java"
public class Test {
  public Test();
    Code:
       0: aload_0
       1: invokespecial #1                  // Method java/lang/Object."<init>":()V
       4: return

  public static long test(long);
    Code:
       0: lload_0
       1: lreturn

  public static void main(java.lang.String[]);
    Code:
       0: aconst_null
       1: astore_1
       2: aload_1
       3: invokevirtual #2                  // Method java/lang/Long.longValue:()J
       6: invokestatic  #3                  // Method test:(J)J
       9: pop2
      10: return
}

从以上字节码及对应的注释可以看出，test(value); 这一行被编译后等同于如下代码：

1 2	long primitive = value.longValue(); test(promitive);

相比实际代码，多出的 long primitive = value.longValue(); 这一行看起来就是自动拆箱的过程了，而我们传入的 value 为 null，value.longValue() 会抛出 NullPointerException，一切就解释得通了。用更简洁的代码表达出了更丰富的含义，这就是所谓的语法糖了。

证实猜想

那么我们上面得出的自动拆箱机制的结论是否正确呢？选择一种其它基本数据类型，比如 int，来佐证一下：

public class Test {
    public static void main(String[] args) {
        Integer value = 10;
        int primitive = value;
    }
}

反汇编后对应的字节码：

Compiled from "Test.java"
public class Test {
  public Test();
    Code:
       0: aload_0
       1: invokespecial #1                  // Method java/lang/Object."<init>":()V
       4: return

  public static void main(java.lang.String[]);
    Code:
       0: bipush        10
       2: invokestatic  #2                  // Method java/lang/Integer.valueOf:(I)Ljava/lang/Integer;
       5: astore_1
       6: aload_1
       7: invokevirtual #3                  // Method java/lang/Integer.intValue:()I
      10: istore_2
      11: return
}

由以上字节码我们可以印证下文里的知识点了。

自动装箱与拆箱

自动装箱与拆箱是 Java 1.5 引入的新特性，是一种语法糖。

在此之前，我们要创建一个值为 10 的 Integer 对象，只能写作：

1	Integer value = new Integer(10);

而现在，我们可以更方便地写为：

1	Integer value = 10;

定义与实现机制

自动装箱，是指从基本数据类型值到其对应的包装类对象的自动转换。比如 Integer value = 10;，是通过调用 Integer.valueOf 方法实现转换的。

自动拆箱，是指从包装类对象到其对应的基本数据类型值的自动转换。比如 int primitive = value;，是通过调用 Integer.intValue 方法实现转换的。

基本数据类型	包装类型	装箱方法	拆箱方法
boolean	Boolean	Boolean.valueOf(boolean)	Boolean.booleanValue()
byte	Byte	Byte.valueOf(byte)	Byte.byteValue()
char	Character	Character.valueOf(char)	Character.charValue()
short	Short	Short.valueOf(short)	Short.shortValue()
int	Integer	Integer.valueOf(int)	Integer.intValue()
long	Long	Long.valueOf(long)	Long.longValue()
float	Float	Float.valueOf(float)	Float.floatValue()
double	Double	Double.valueOf(double)	Double.doubleValue()

发生时机

自动装箱与拆箱主要发生在以下四种时机：

赋值时；
比较时；
算术运算时；
方法调用时。

常见应用场景

Case 1:

1
2
3

Integer value = 10; // 自动装箱（赋值时）

int primitive = value; // 自动拆箱（方法调用时）

Case 2:

Integer value = 1000;
// ...
if (value <= 1000) { // 自动拆箱（比较时）
    // ...
}

Case 3:

List<Integer> list = new ArrayList<>();
list.add(10); // 自动装箱（方法调用时）

int i = list.get(0); // 自动拆箱（赋值时）

注：集合（Collections）里不能直接放入原始类型，集合只接收对象。

Case 4:

ThreadLocal<Integer> local = new ThreadLocal<Integer>();
local.set(10); // 自动装箱（方法调用时）

int i = local.get(); // 自动拆箱（赋值时）

注：ThreadLocal 不能存储基本数据类型，只接收引用类型。

Case 5:

public void fun1(Integer value) {
    //
}

public void fun2(int value) {
    //
}

public void test() {
    fun1(10); // 自动装箱（方法调用时）

    Integer value = 10;
    fun2(value); // 自动拆箱（方法调用时）
}

Case 6:

Integer v1 = new Integer(10);
Integer v2 = new Integer(20);
int v3 = 30;

int sum = v1 + v2; // 自动拆箱（算术运算时）
sum = v1 + 30; // 自动拆箱（算术运算时）

相关知识点

比较

除 == 以外，包装类对象与基本数据类型值的比较，包装类对象与包装类对象之间的比较，都是自动拆箱后对基本数据类型值进行比较，所以，要注意这些类型间进行比较时自动拆箱可能引发的 NullPointerException。

== 比较特殊，因为可以用于判断左右是否为同一对象，所以两个包装类对象之间 ==，会用于判断是否为同一对象，而不会进行自动拆箱操作；包装类对象与基本数据类型值之间 ==，会自动拆箱。

示例代码：

Integer v1 = new Integer(10);
Integer v2 = new Integer(20);

if (v1 < v2) { // 自动拆箱
    // ...
}

if (v1 == v2) { // 不拆箱
    // ...
}

if (v1 == 10) { // 自动拆箱
    // ...
}

缓存

Java 为整型值包装类 Byte、Character、Short、Integer、Long 设置了缓存，用于存储一定范围内的值，详细如下：

类型	缓存值范围
Byte	-128 ~ 127
Character	0 ~ 127
Short	-128 ~ 127
Integer	-128 ~ 127（可配置）
Long	-128 ~ 127

在一些情况下，比如自动装箱时，如果值在缓存值范围内，将不创建新对象，直接从缓存里取出对象返回，比如：

Integer v1 = 10;
Integer v2 = 10;
Integer v3 = new Integer(10);
Integer v4 = 128;
Integer v5 = 128;
Integer v6 = Integer.valueOf(10);

System.out.println(v1 == v2); // true
System.out.println(v1 == v3); // false
System.out.println(v4 == v5); // false
System.out.println(v1 == v6); // true

缓存实现机制：

这里使用了设计模式享元模式。

以 Short 类实现源码为例：

// ...
public final class Short extends Number implements Comparable<Short> {
    // ...
    private static class ShortCache {
        private ShortCache(){}

        static final Short cache[] = new Short[-(-128) + 127 + 1];

        static {
            for(int i = 0; i < cache.length; i++)
                cache[i] = new Short((short)(i - 128));
        }
    }

    // ...
    public static Short valueOf(short s) {
        final int offset = 128;
        int sAsInt = s;
        if (sAsInt >= -128 && sAsInt <= 127) { // must cache
            return ShortCache.cache[sAsInt + offset];
        }
        return new Short(s);
    }
    // ...
}

在第一次调用到 Short.valueOf(short) 方法时，将创建 -128 ~ 127 对应的 256 个对象缓存到堆内存里。

这种设计，在频繁用到这个范围内的值的时候效率较高，可以避免重复创建和回收对象，否则有可能闲置较多对象在内存中。

使用不当的情况

自动装箱和拆箱这种语法糖为我们写代码带来了简洁和便利，但如果使用不当，也有可能带来负面影响。

性能的损耗

Integer sum = 0;
for (int i = 1000; i < 5000; i++) {
    // 1. 先对 sum 进行自动拆箱
    // 2. 加法
    // 3. 自动装箱赋值给 sum，无法命中缓存，会 new Integer(int)
    sum = sum + i;
}

在循环过程中会分别调用 4000 次 Integer.intValue() 和 Integer.valueOf(int)，并 new 4000 个 Integer 对象，而这些操作将 sum 的类型改为 int 即可避免，节约运行时间和空间，提升性能。

java.lang.NullPointerException

尝试对一个值为 null 的包装类对象进行自动拆箱，就有可能造成 NullPointerException。

比如：

Integer v1 = null;
int v2 = v1; // NullPointerException

if (v1 > 10) { // NullPointerException
    // ...
}

int v3 = v1 + 10; // NullPointerException

还有一种更隐蔽的情形，感谢 @周少补充：

public class Test {
    public static void main(String[] args) {
        long value = true ? null : 1; // NullPointerException
    }
}

这实际上还是对一个值为 null 的 Long 类型进行自动拆箱，反汇编代码：

Compiled from "Test.java"
public class Test {
  public Test();
    Code:
       0: aload_0
       1: invokespecial #1                  // Method java/lang/Object."<init>":()V
       4: return

  public static void main(java.lang.String[]);
    Code:
       0: aconst_null
       1: checkcast     #2                  // class java/lang/Long
       4: invokevirtual #3                  // Method java/lang/Long.longValue:()J
       7: lstore_1
       8: return
}