【Java】使用Optional优雅避免空指针异常

本文已收录至Github，推荐阅读 Java随想录

摘要

空指针异常（NullPointerException）可以说是Java程序员最容易遇到的问题了，影响说大不大，说小也不小。为了解决这个问题，Java 8 版本中推出了 Optional 类。Optional 类是一个容器对象，它可以包含或不包含非空值。使用 Optional 类可以有效地避免空指针异常的问题。在本篇博客中，我将向大家介绍 JDK Optional 类及其使用方法。

Optional 介绍

Optional 类是一个容器对象，它可以包含或不包含非空值。如果一个对象可能为空，那么我们就可以使用 Optional 类来代替该对象。Optional 类型的变量可以有两种状态：存在值和不存在值。Optional类有两个重要的方法：of和ofNullable。of方法用于创建一个非空的Optional对象，如果传入的参数为null，则会抛出NullPointerException异常。而ofNullable方法用于创建一个可以为空的Optional对象。如果传入的参数为空，则返回一个空的Optional对象。当 Optional 对象存在值时，调用 get() 方法可以返回该值；当 Optional 对象不存在值时，调用 get() 方法会抛出 NoSuchElementException 异常。

下面是一个使用 Optional 类的例子：

Optional<String> optional = Optional.of("Hello World");
System.out.println(optional.get()); //输出 Hello World

在上面的例子中，我们首先使用 of() 方法创建了一个包含字符串 “Hello World” 的 Optional 对象，然后使用 get() 方法获取该对象的值并将其打印出来。

注意，如果我们尝试创建一个 null 值的 Optional 对象，则会抛出 NullPointerException 异常。而且，在使用 Optional 类时，我们应该尽量避免使用 isPresent() 和 get() 方法，因为这些方法可能会引起空指针异常。比较推荐使用Optional.ofNullable来创建Optional 对象。

Optional 使用

创建 Optional 对象

我们可以使用以下几种方式来创建 Optional 对象：

1. Optional.of(value)：创建一个包含非空值的 Optional 对象。
2. Optional.empty()：创建一个不包含任何值的空 Optional 对象。
3. Optional.ofNullable(value)：创建一个可能包含 null 值的 Optional 对象。如果 value 不为 null，则该方法会创建一个包含该值的 Optional 对象；否则，创建一个空 Optional 对象。

下面是一个使用 Optional.ofNullable() 方法的例子：

String str = null;
Optional<String> optional = Optional.ofNullable(str);
System.out.println(optional.isPresent()); //输出 false

在上面的例子中，我们首先声明了一个空字符串 str，并将其赋值为 null。然后，我们使用 ofNullable() 方法创建了一个 Optional 对象。由于 str 是 null，因此创建的 Optional 对象也是空的。最后，我们使用 isPresent() 方法检查 Optional 对象是否包含值。

orElse()与orElseGet()

orElse()方法接收一个参数，即为默认值。如果Optional对象中的值不为空，则返回该值，否则返回传入的默认值。具体用法如下：

Optional<String> optional = Optional.ofNullable(null);
String result = optional.orElse("default");
System.out.println(result); // 输出 "default"

orElseGet()方法与orElse()方法类似，也是用于获取默认值的方法。但是，orElseGet()方法接收的参数是一个Supplier函数式接口，用于在需要返回默认值时生成该值。具体用法如下：

Optional<String> optional = Optional.ofNullable(null);
String result = optional.orElseGet(() -> "default");
System.out.println(result); // 输出 "default"

orElse() 和 orElseGet()的区别

orElse() 和 orElseGet()特别相似，有必要抽离出来讲下他们之间的区别。

orElse() 方法无论 Optional 对象是否为空都会执行，因此它总是会创建一个新的对象。orElseGet() 方法只有在 Optional 对象为空时才会执行，因此它可以用来延迟创建新的对象。

用一个例子感受一下：

    @Test
    void test() {
        System.out.println("--------不为null的情况----------");
        //不为 null
        String str1 = "hello";
        String result11 = Optional.ofNullable(str1).orElse(get(str1 + ":orElse()方法被执行了"));
        String result12 = Optional.ofNullable(str1).orElseGet(() -> get(str1 + ":orElseGet()方法被执行了"));
        System.out.println(result11);
        System.out.println(result12);
        System.out.println("--------为null的情况----------");
        //为 null
        String str2 = null;
        String result21 = Optional.ofNullable(str2).orElse(get(str1 + ":orElse()方法被执行了"));
        String result22 = Optional.ofNullable(str2).orElseGet(() -> get(str2 + ":orElseGet()方法被执行了"));
        System.out.println(result21);
        System.out.println(result22);
    }


    public String get(String name) {
        System.out.println(name);
        return name;
    }

输出结果如下：

--------不为null的情况----------
hello:orElse()方法被执行了
hello
hello
--------为null的情况----------
hello:orElse()方法被执行了
null:orElseGet()方法被执行了
hello:orElse()方法被执行了
null:orElseGet()方法被执行了

因此，一般来说，如果你希望在 Optional 对象为空时才创建新的对象，可以使用 orElseGet() 方法。否则，如果你希望总是创建新的对象，无论 Optional 对象是否为空，可以使用 orElse() 方法，通常来说orElseGet()更佳，个人也是推荐使用orElseGet()。

map()与flatMap()

map() 方法接受一个函数作为参数，该函数将被应用于 Optional 对象中的值。如果 Optional 对象存在值，则将该值传递给函数进行转换，否则返回一个空 Optional 对象。

下面是一个使用 map() 方法的例子：

String str = "Hello";
Optional<String> optional = Optional.of(str);
Optional<String> upperCaseOptional = optional.map(String::toUpperCase);
System.out.println(upperCaseOptional.get()); //输出 HELLO

在上面的例子中，我们首先使用 of() 方法创建了一个包含字符串 “Hello” 的 Optional 对象。然后，我们使用 map() 方法将该字符串转换为大写形式，并将结果存储到另一个 Optional 对象 upperCaseOptional 中。最后，我们使用 get() 方法获取 upperCaseOptional 对象中的值并打印出来。

flatMap() 方法与 map() 方法类似，都接受一个函数作为参数。但是，flatMap() 方法返回的是一个 Optional 类型的值。如果函数返回的是一个 Optional 对象，则该方法会将其“展开”，否则返回一个空 Optional 对象。

下面是一个使用 flatMap() 方法的例子：

String str = "hello world";
Optional<String> optional = Optional.of(str);
Optional<Character> result = optional.flatMap(s -> {
    if (s.length() > 0)
        return Optional.of(s.charAt(0));
    else
        return Optional.empty();
});
System.out.println(result.get()); //输出 h

在上面的例子中，我们首先创建了一个包含字符串 “hello world” 的 Optional 对象。然后，我们使用 flatMap() 方法将该字符串转换为第一个字符，并将结果存储到另一个 Optional 对象 result 中。最后，我们使用 get() 方法获取 result 对象中的值并打印出来。

filter()

filter() 方法接受一个谓词（Predicate）作为参数，返回一个 Optional 类型的值。如果 Optional 对象存在值且满足谓词的条件，则返回该 Optional 对象；否则返回一个空 Optional 对象。

下面是一个使用 filter() 方法的例子：

Integer number = 10;
Optional<Integer> optional = Optional.of(number);
Optional<Integer> result = optional.filter(n -> n % 2 == 0);
System.out.println(result.isPresent()); //输出 true

在上面的例子中，我们首先创建了一个包含整数 10 的 Optional 对象。然后，我们使用 filter() 方法过滤出该数字是否为偶数，并将结果存储到另一个 Optional 对象 result 中。最后，我们使用 isPresent() 方法检查 result 对象是否存在值。

总结

Optional类是Java 8引入的一个非常有用的特性，通过使用 Optional 类，我们可以更加简洁、安全和易读地编写 Java 代码，避免空指针异常等问题。因此，在编写 Java 代码时，我们应该尽可能地使用 Optional 类来处理可能造成空指针的变量。

但是，Optional类并不是万能的，它也有一些不足之处。它可能会增加代码的复杂性和执行时间，因为它需要我们在使用值之前检查是否存在值。因此在使用Optional类时需要谨慎权衡利弊。