Java中的optional：为解决NPE而生

作者：MatSyx 
来源：CSDN 
原文：https://blog.csdn.net/u014604691/article/details/51956780 
 

如果你开发过Java程序，可能会有过这样的经历：调用某种数据结构的一个方法得到了返回值却不能直接将返回值作为参数去调用别的方法。而是首先判断这个返回值是否为null，只有在非空的前提下才能将其作为其他方法的参数。Java8中新加了Optional这个类正是为了解决这个问题。
Optional类的Javadoc描述如下： 
这是一个可以为null的容器对象。如果值存在则isPresent()方法会返回true，调用get()方法会返回该对象。 
以下对Optional类中常用的方法进行介绍：

of 
为非null的值创建一个Optional
of方法通过工厂方法创建Optional类。需要注意的是，创建对象时传入的参数不能为null。如果传入参数为null，则抛出NullPointerException 。

//工厂方法创建Optional实例
Optional<String> name = Optional.of("optional");
//传入参数为null，抛出NullPointerException.
Optional<String> someNull = Optional.of(null);

ofNullable 
为指定的值创建一个Optional，如果指定的值为null，则返回一个空的Optional
ofNullable与of方法相似，区别是可以接受参数为null的情况。

//创建一个值为'null'的Optional
Optional empty = Optional.ofNullable(null);

isPresent 
如果值存在返回true，否则返回false
//isPresent方法用来检查Optional实例中是否包含值
if (name.isPresent()) {
  //在Optional实例内调用get()返回已存在的值
  System.out.println(name.get());//输出optional
}

get

如果Optional有值则将其返回，否则抛出NoSuchElementException

上面的示例中，get方法用来得到Optional实例中的值。下面我们看一个抛出NoSuchElementException的例子：

//执行下面的代码会输出：No value present 
try {
  //在空的Optional实例上调用get()，抛出NoSuchElementException
  System.out.println(empty.get());
} catch (NoSuchElementException ex) {
  System.out.println(ex.getMessage());
}

ifPresent 
如果Optional实例有值则为其调用consumer，否则不做处理
要理解ifPresent方法，首先需要了解Consumer类。简答地说，Consumer类包含一个抽象方法。该抽象方法对传入的值进行处理，但没有返回值。Java8支持不用接口直接通过lambda表达式传入参数。

如果Optional实例有值，调用ifPresent()可以接受接口段或lambda表达式。类似下面的代码：

//ifPresent方法接受lambda表达式作为参数。
//lambda表达式对Optional的值调用consumer进行处理。
name.ifPresent((value) -> {
  System.out.println("The length of the value is: " + value.length());
});

orElse

如果有值则将其返回，否则返回指定的其它值

如果Optional实例有值则将其返回，否则返回orElse方法传入的参数。示例如下：

//如果值不为null，orElse方法返回Optional实例的值。
//如果为null，返回传入的消息。
//输出：There is no value!
System.out.println(empty.orElse("There is no value !"));
//输出：optional
System.out.println(name.orElse("There is some value!"));

orElseGet
orElseGet与orElse方法类似，区别在于得到的默认值。orElse方法将传入的字符串作为默认值，orElseGet方法可以接受Supplier接口的实现用来生成默认值。示例如下：

//orElseGet与orElse方法类似，区别在于orElse传入的是默认值，
//orElseGet可以接受一个lambda表达式生成默认值。
//输出：Default Value
System.out.println(empty.orElseGet(() -> "Default Value"));
//输出：optional
System.out.println(name.orElseGet(() -> "Default Value"));

orElseThrow

如果有值则将其返回，否则抛出supplier接口创建的异常

在orElseGet方法中，我们传入一个Supplier接口。然而，在orElseThrow中我们可以传入一个lambda表达式或方法，如果值不存在来抛出异常。示例如下：

try {
  //orElseThrow与orElse方法类似。与返回默认值不同，
  //orElseThrow会抛出lambda表达式或方法生成的异常 
  empty.orElseThrow(ValueAbsentException::new);
} catch (Throwable e) {
  //输出: No value present in the Optional instance
  System.out.println(e.getMessage());
}

//ValueAbsentException定义
class ValueAbsentException extends Throwable {

  public ValueAbsentException() {
    super();
  }

  public ValueAbsentException(String msg) {
    super(msg);
  }

  @Override
  public String getMessage() {
    return "No value present in the Optional instance";
  }
}


map 
如果有值，则对其执行调用mapping函数得到返回值。如果返回值不为null，则创建包含mapping返回值的Optional作为map方法返回值，否则返回空Optional
map方法用来对Optional实例的值执行一系列操作。通过一组实现了Function接口的lambda表达式传入操作。如果你对Function接口不熟悉可以看我这篇文章，map方法示例如下：

//map方法执行传入的lambda表达式参数对Optional实例的值进行修改。
//为lambda表达式的返回值创建新的Optional实例作为map方法的返回值。
Optional<String> upperName = name.map((value) -> value.toUpperCase());
System.out.println(upperName.orElse("No value found"));

flatMap

如果有值，为其执行mapping函数返回Optional类型返回值，否则返回空Optional。flatMap与map（Funtion）方法类似，区别在于flatMap中的mapper返回值必须是Optional。调用结束时，flatMap不会对结果用Optional封装。

flatMap方法与map方法类似，区别在于mapping函数的返回值不同。map方法的mapping函数返回值可以是任何类型T，而flatMap方法的mapping函数必须是Optional。

示例如下：

//flatMap与map（Function）非常类似，区别在于传入方法的lambda表达式的返回类型。
//map方法中的lambda表达式返回值可以是任意类型，在map函数返回之前会包装为Optional。 
//但flatMap方法中的lambda表达式返回值必须是Optionl实例。 
upperName = name.flatMap((value) -> Optional.of(value.toUpperCase()));
System.out.println(upperName.orElse("No value found"));//输出OPTIONAL

filter 
如果有值并且满足断言条件返回包含该值的Optional，否则返回空Optional
filter个方法通过传入限定条件对Optional实例的值进行过滤。对于filter函数我们应该传入实现了Predicate接口的lambda表达式。

现在我来看看filter的各种用法，下面的示例介绍了满足限定条件和不满足两种情况：

//filter方法检查给定的Option值是否满足某些条件。
//如果满足则返回同一个Option实例，否则返回空Optional。
Optional<String> longName = name.filter((value) -> value.length() > 6);
System.out.println(longName.orElse("The name is less than 6 characters"));//输出optional

//另一个例子是Optional值不满足filter指定的条件。
Optional<String> anotherName = Optional.of("Tom");
Optional<String> shortName = anotherName.filter((value) -> value.length() > 6);
//输出：The name is less than 6 characters
System.out.println(shortName.orElse("The name is less than 6 characters"));
 

 

博客2 ：https://www.runoob.com/java/java8-optional-class.html

Optional 类是一个可以为null的容器对象。如果值存在则isPresent()方法会返回true，调用get()方法会返回该对象。

Optional 是个容器：它可以保存类型T的值，或者仅仅保存null。Optional提供很多有用的方法，这样我们就不用显式进行空值检测。

Optional 类的引入很好的解决空指针异常。

类声明

以下是一个 java.util.Optional<T> 类的声明：

public final class Optional<T> extends Object

类方法

序号	方法 & 描述
1	static <T> Optional<T> empty() 返回空的 Optional 实例。
2	boolean equals(Object obj) 判断其他对象是否等于 Optional。
3	Optional<T> filter(Predicate<? super <T> predicate) 如果值存在，并且这个值匹配给定的 predicate，返回一个Optional用以描述这个值，否则返回一个空的Optional。
4	<U> Optional<U> flatMap(Function<? super T,Optional<U>> mapper) 如果值存在，返回基于Optional包含的映射方法的值，否则返回一个空的Optional
5	T get() 如果在这个Optional中包含这个值，返回值，否则抛出异常：NoSuchElementException
6	int hashCode() 返回存在值的哈希码，如果值不存在 返回 0。
7	void ifPresent(Consumer<? super T> consumer) 如果值存在则使用该值调用 consumer , 否则不做任何事情。
8	boolean isPresent() 如果值存在则方法会返回true，否则返回 false。
9	<U>Optional<U> map(Function<? super T,? extends U> mapper) 如果有值，则对其执行调用映射函数得到返回值。如果返回值不为 null，则创建包含映射返回值的Optional作为map方法返回值，否则返回空Optional。
10	static <T> Optional<T> of(T value) 返回一个指定非null值的Optional。
11	static <T> Optional<T> ofNullable(T value) 如果为非空，返回 Optional 描述的指定值，否则返回空的 Optional。
12	T orElse(T other) 如果存在该值，返回值， 否则返回 other。
13	T orElseGet(Supplier<? extends T> other) 如果存在该值，返回值， 否则触发 other，并返回 other 调用的结果。
14	<X extends Throwable> T orElseThrow(Supplier<? extends X> exceptionSupplier)   如果存在该值，返回包含的值，否则抛出由 Supplier 继承的异常
15	String toString() 返回一个Optional的非空字符串，用来调试

注意： 这些方法是从 java.lang.Object 类继承来的。

---

Optional 实例

我们可以通过以下实例来更好的了解 Optional 类的使用：

Java8Tester.java 文件

import java.util.Optional; public class Java8Tester { public static void main(String args[]){ Java8Tester java8Tester = new Java8Tester(); Integer value1 = null; Integer value2 = new Integer(10); // Optional.ofNullable - 允许传递为 null 参数 Optional<Integer> a = Optional.ofNullable(value1); // Optional.of - 如果传递的参数是 null，抛出异常 NullPointerException Optional<Integer> b = Optional.of(value2); System.out.println(java8Tester.sum(a,b)); } public Integer sum(Optional<Integer> a, Optional<Integer> b){ // Optional.isPresent - 判断值是否存在 System.out.println("第一个参数值存在: " + a.isPresent()); System.out.println("第二个参数值存在: " + b.isPresent()); // Optional.orElse - 如果值存在，返回它，否则返回默认值 Integer value1 = a.orElse(new Integer(0)); //Optional.get - 获取值，值需要存在 Integer value2 = b.get(); return value1 + value2; } }

执行以上脚本，输出结果为：

$ javac Java8Tester.java 
$ java Java8Tester
第一个参数值存在: false
第二个参数值存在: true
10

博客三：https://www.cnblogs.com/wenbochang/p/10426171.html

写在前头

今天再看阿里的Java开发手册，里面异常处理第10条提到这样一个建议。

【推荐】防止 NPE ，是程序员的基本修养，注意 NPE 产生的场景：
1 ） 返回类型为基本数据类型，return 包装数据类型的对象时，自动拆箱有可能产生 NPE。
反例： public int f() { return Integer 对象}， 如果为 null ，自动解箱抛 NPE 。
2 ） 数据库的查询结果可能为 null 。
3 ） 集合里的元素即使 isNotEmpty ，取出的数据元素也可能为 null 。
4 ） 远程调用返回对象时，一律要求进行空指针判断，防止 NPE 。
5 ） 对于 Session 中获取的数据，建议 NPE 检查，避免空指针。
6 ） 级联调用 obj . getA() . getB() . getC()； 一连串调用，易产生 NPE 。
正例：使用 JDK8 的 Optional 类来防止 NPE 问题。

里面的正确示例提示我们用Java8的Optional类来防止NPE的问题。

那我们今天就看看这个Optional类吧

 

Optional类

• 类方法

序号	方法 & 描述
1	static <T> Optional<T> empty() 返回空的 Optional 实例。
2	boolean equals(Object obj) 判断其他对象是否等于 Optional。
3	Optional<T> filter(Predicate<? super <T> predicate) 如果值存在，并且这个值匹配给定的 predicate，返回一个Optional用以描述这个值，否则返回一个空的Optional。
4	<U> Optional<U> flatMap(Function<? super T,Optional<U>> mapper) 如果值存在，返回基于Optional包含的映射方法的值，否则返回一个空的Optional
5	T get() 如果在这个Optional中包含这个值，返回值，否则抛出异常：NoSuchElementException
6	int hashCode() 返回存在值的哈希码，如果值不存在 返回 0。
7	void ifPresent(Consumer<? super T> consumer) 如果值存在则使用该值调用 consumer , 否则不做任何事情。
8	boolean isPresent() 如果值存在则方法会返回true，否则返回 false。
9	<U>Optional<U> map(Function<? super T,? extends U> mapper) 如果有值，则对其执行调用映射函数得到返回值。如果返回值不为 null，则创建包含映射返回值的Optional作为map方法返回值，否则返回空Optional。
10	static <T> Optional<T> of(T value) 返回一个指定非null值的Optional。
11	static <T> Optional<T> ofNullable(T value) 如果为非空，返回 Optional 描述的指定值，否则返回空的 Optional。
12	T orElse(T other) 如果存在该值，返回值， 否则返回 other。
13	T orElseGet(Supplier<? extends T> other) 如果存在该值，返回值， 否则触发 other，并返回 other 调用的结果。
14	<X extends Throwable> T orElseThrow(Supplier<? extends X> exceptionSupplier)   如果存在该值，返回包含的值，否则抛出由 Supplier 继承的异常
15	String toString() 返回一个Optional的非空字符串，用来调试

 

我们可以看到Optional总共也就10+个方法，其中有三个static方法。并且Optional的构造方法是private，不能new出来。

所以我们一般用这三个static来获取Optional的对象。

 

•  of && ofNullable

1 public static <T> Optional<T> of(T value) {
2     return new Optional<>(value);
3 }
4 
5 public static <T> Optional<T> ofNullable(T value) {
6     return value == null ? empty() : of(value);
7 }

很明显 of 对null对象没有做任何处理，ofNullable才做了处理。所以当我们不知道传入的对象是否为null的时候，我们应该选择用 ofNullable来做处理。

• map 

1 public<U> Optional<U> map(Function<? super T, ? extends U> mapper) {
2     Objects.requireNonNull(mapper);
3     if (!isPresent())
4         return empty();
5     else {
6         return Optional.ofNullable(mapper.apply(value));
7     }
8 }

如果我们想获取Object里面的值的话，我们就需要用到这个map。

 

例子

 1 public class OptionalTest {
 2     public static void main(String[] args) {
 3         Person person = new Person("zhangsan", 18);
 4         String name = getName(person);
 5         System.out.println(name);
 6     }
 7 
 8     private static String getName(Person person) {
 9         if (Objects.isNull(person)) {
10             return "unKnown";
11         }
12         return person.getName();
13     }
14 
15 }

我们看上面的这个例子。

我们有一个函数 getName 作用是获取Person对象的名字。但我并不知道这个Person是否为Null。

所以我要进行一个判断，判断Person是否为空，在做决定。

但如果我们使用Optional类的话，我们可以这样写

 1 public class OptionalTest {
 2     public static void main(String[] args) {
 3         Person person = new Person("zhangsan", 18);
 4         String name = getName(person);
 5         System.out.println(name);
 6     }
 7 
 8     private static String getName(Person person) {
 9         String name = Optional.ofNullable(person).map(x -> x.getName())
10                 .orElse("unKnown");
11         return name;
12     }
13 }

如果传入的为空，它会自动new一个  Optional<T> t = (Optional<T>) EMPTY; 

有效的处理到了null的问题，而且还非常的简洁。