Java中Optional的使用指南

提到NullPointerException（简称NPE）异常，相信每个Java开发人员都不陌生，从接触编程的第1天起，它就和我们如影随形，最近处理的线上bug中，有不少都是对象没判空导致的NullPointerException异常。

1. 简单回顾

引起NullPointerException异常的地方有很多，比如调用String的trim()方法，比如对BigDecimal进行计算时，比如将包装类型转化为基本类型时，这里简单回顾下。

假设有个导入模版定义如下：

package com.zwwhnly.springbootaction.model;
import lombok.AllArgsConstructor;
import lombok.Data;
/**
* 导入模版
*/
@Data
@AllArgsConstructor
public class ImportTemplate {
/**
* 模版id
*/
private int templateId;
/**
* 模版名称
*/
private String templateName;
/**
* 模版下载url
*/
private String url;
/**
* 备注
*/
private String remark;
}

然后看下如下代码：

public static void main(String[] args) {
ImportTemplate importTemplate = getImportTemplateById(1);
System.out.println(importTemplate.getUrl());
}
public static ImportTemplate getImportTemplateById(int id) {
return new ImportTemplate(1, "销售订单-普通商品导入模版", "o_w-140e3c1f41c94f238196539558e25bf7", null);
}

正常情况下，这段代码肯定是没有问题的，但当getImportTemplateById方法返回null时，这段代码就会抛出NullPointerException异常，如下所示：

public static ImportTemplate getImportTemplateById(int id) {
return null;
}

Java中Optional的使用指南

为了程序能正常运行，就要判断importTemplate是否为null，所以代码就修改为了：

public static void main(String[] args) {
ImportTemplate importTemplate = getImportTemplateById(1);
if (importTemplate != null) {
System.out.println(importTemplate.getUrl());
}
}

项目中类似的判空代码应该有很多，大家可以自行看下自己项目的代码。

2. 使用Optional

为了避免NullPointerException异常，JDK1.8新增了Optional类来处理空指针异常，该类位于java.util包下，提供了一系列方法，

并且可以配合Lambda表达式一起使用，使代码看起来更加清晰，接下来我们看下它的使用方法。

2.1 创建实例

创建Optional实例有以下3种方式，分别为：

调用empty方法

Optional<ImportTemplate> optionalImportTemplate = Optional.empty();

调用of方法

ImportTemplate importTemplate = new ImportTemplate(1, "销售订单-普通商品导入模版",
"o_w-140e3c1f41c94f238196539558e25bf7", null);
Optional<ImportTemplate> optionalImportTemplate = Optional.of(importTemplate);

调用ofNullable方法（推荐）

ImportTemplate importTemplate = new ImportTemplate(1, "销售订单-普通商品导入模版",
"o_w-140e3c1f41c94f238196539558e25bf7", null);
Optional<ImportTemplate> optionalImportTemplate = Optional.ofNullable(importTemplate);

值得注意的是，当参数为null时，调用of方法会抛NullPointerException异常，但调用ofNullable方法不会（更符合使用场景），因此推荐使用ofNullable方法：

ImportTemplate importTemplate = null;
Optional<ImportTemplate> optionalImportTemplate = Optional.of(importTemplate);

Java中Optional的使用指南

2.2 判断是否有值

可以调用isPresent方法来判断对象是否有值（不为null），使用方法如下所示：

ImportTemplate importTemplate = null;
Optional<ImportTemplate> optionalImportTemplate = Optional.ofNullable(importTemplate);
System.out.println(optionalImportTemplate.isPresent());

以上代码的输出结果为：

Java中Optional的使用指南

ImportTemplate importTemplate = new ImportTemplate(1, "销售订单-普通商品导入模版",
"o_w-140e3c1f41c94f238196539558e25bf7", null);
Optional<ImportTemplate> optionalImportTemplate = Optional.ofNullable(importTemplate);
System.out.println(optionalImportTemplate.isPresent());

以上代码的输出结果为：

Java中Optional的使用指南

看下isPresent的源码，逻辑非常简单，就是判断了我们传入的对象是否有值，即不为null：

/**
* Return {@code true} if there is a value present, otherwise {@code false}.
*
* @return {@code true} if there is a value present, otherwise {@code false}
*/
public boolean isPresent() {
return value != null;
}

2.3 获取值

可以调用get方法来获取对象的有值，使用方法如下所示：

ImportTemplate importTemplate = new ImportTemplate(1, "销售订单-普通商品导入模版",
"o_w-140e3c1f41c94f238196539558e25bf7", null);
Optional<ImportTemplate> optionalImportTemplate = Optional.ofNullable(importTemplate);
System.out.println(optionalImportTemplate.get());

以上代码的输出结果为：

Java中Optional的使用指南

值得注意的是，当我们传入的对象为null时，调用get方法会抛出java.util.NoSuchElementException异常，而不是返回null。

ImportTemplate importTemplate = null;
Optional<ImportTemplate> optionalImportTemplate = Optional.ofNullable(importTemplate);
System.out.println(optionalImportTemplate.get());

以上代码的输出结果为：

Java中Optional的使用指南

看下get方法的源码，就可以知道原因：

public T get() {
if (value == null) {
throw new NoSuchElementException("No value present");
}
return value;
}

2.4 先用isPresent，再用get（不推荐）

然后我们回顾下文初的代码：

ImportTemplate importTemplate = getImportTemplateById(1);
if (importTemplate != null) {
System.out.println(importTemplate.getUrl());
}

可能很多同学会把代码优化为下面这样的写法：

Optional<ImportTemplate> optionalImportTemplate = Optional.ofNullable(getImportTemplateById(1));
if (optionalImportTemplate.isPresent()) {
System.out.println(optionalImportTemplate.get().getUrl());
}

不推荐这么使用，因为判断的地方没减少，而且还不如原来看起来清晰。

2.5 ifPresent（推荐）

那该怎么优化呢？答案就是使用ifPresent方法，该方法接收一个Consumer类型的参数，当值不为null时，就执行，当值为null时，就不执行，源码如下所示：

public void ifPresent(Consumer<? super T> consumer) {
if (value != null)
consumer.accept(value);
}

优化之后的代码如下所示：

Optional<ImportTemplate> optionalImportTemplate = Optional.ofNullable(getImportTemplateById(1));
optionalImportTemplate.ifPresent(importTemplate -> System.out.println(importTemplate.getUrl()));

当然，也可以写更多的逻辑：

Optional<ImportTemplate> optionalImportTemplate = Optional.ofNullable(getImportTemplateById(1));
optionalImportTemplate.ifPresent(importTemplate -> {
System.out.println(importTemplate.getTemplateId());
System.out.println(importTemplate.getTemplateName());
System.out.println(importTemplate.getUrl());
System.out.println(importTemplate.getRemark());
});

2.6 自定义默认值

Optional类提供了以下2个方法来自定义默认值，用于当对象为null时，返回自定义的对象：

orElse
orElseGet

先来看下orElse方法的使用：

public static void main(String[] args) {
ImportTemplate importTemplate = null;
ImportTemplate firstImportTemplate = Optional.ofNullable(importTemplate)
.orElse(getDefaultTemplate());
System.out.println(firstImportTemplate);
importTemplate = new ImportTemplate(2, "销售订单-不定规格商品导入模版", "o_w-a7109db89f8d4508b4c6202889a1a2c1", null);
ImportTemplate secondImportTemplate = Optional.ofNullable(importTemplate)
.orElse(getDefaultTemplate());
System.out.println(secondImportTemplate);
}
public static ImportTemplate getDefaultTemplate() {
System.out.println("getDefaultTemplate");
return new ImportTemplate(1, "销售订单-普通商品导入模版", "o_w-140e3c1f41c94f238196539558e25bf7", null);
}

输出结果：

Java中Optional的使用指南

再来看下orElseGet方法的使用：

public static void main(String[] args) {
ImportTemplate importTemplate = null;
ImportTemplate firstImportTemplate = Optional.ofNullable(importTemplate)
.orElseGet(() -> getDefaultTemplate());
System.out.println(firstImportTemplate);
importTemplate = new ImportTemplate(2, "销售订单-不定规格商品导入模版", "o_w-a7109db89f8d4508b4c6202889a1a2c1", null);
ImportTemplate secondImportTemplate = Optional.ofNullable(importTemplate)
.orElseGet(() -> getDefaultTemplate());
System.out.println(secondImportTemplate);
}
public static ImportTemplate getDefaultTemplate() {
System.out.println("getDefaultTemplate");
return new ImportTemplate(1, "销售订单-普通商品导入模版", "o_w-140e3c1f41c94f238196539558e25bf7", null);
}

输出结果：

Java中Optional的使用指南

从输出结果看，2个方法好像差不多，第1次调用都返回了默认模版，第2次调用都返回了传入的模版，但其实仔细观察，你会发现当使用

orElse方法时，getDefaultTemplate方法执行了2次，但调用orElseGet方法时，getDefaultTemplate方法只执行了2次（只在第1次传入模版为null时执行了）。

为什么会这样呢？带着这个疑问，我们看下这2个方法的源码，其中orElse方法的源码如下所示：

public T orElse(T other) {
return value != null ? value : other;
}

可以看到，参数other是个对象，这个参数肯定是要传的，但只有value为空时，才会用到（返回）这个对象。

orElseGet方法的源码如下所示：

public T orElseGet(Supplier<? extends T> other) {
return value != null ? value : other.get();
}

可以看到，参数other并不是直接传入对象，如果value为null，才会执行传入的参数获取对象，如果不为null，直接返回value。

2.7 自定义异常

Optional类提供了orElseThrow方法，用于当传入的对象为null时，抛出自定义的异常，使用方法如下所示：

public static void main(String[] args) {
ImportTemplate importTemplate = new ImportTemplate(2, "销售订单-不定规格商品导入模版", "o_w-a7109db89f8d4508b4c6202889a1a2c1", null);
ImportTemplate firstImportTemplate = Optional.ofNullable(importTemplate)
.orElseThrow(() -> new IndexOutOfBoundsException());
System.out.println(firstImportTemplate);
importTemplate = null;
ImportTemplate secondImportTemplate = Optional.ofNullable(importTemplate)
.orElseThrow(() -> new IndexOutOfBoundsException());
System.out.println(secondImportTemplate);
}

输出结果：

Java中Optional的使用指南

2.8 过滤数据

Optional类提供了filter方法来过滤数据，该方法接收一个Predicate参数，返回匹配条件的数据，如果不匹配条件，返回一个空的Optional，使用方法如下所示：

public static void main(String[] args) {
ImportTemplate importTemplate = getImportTemplateById(1);
Optional<ImportTemplate> filterById = Optional.ofNullable(importTemplate)
.filter(f -> f.getTemplateId() == 1);
System.out.println(filterById.isPresent());
Optional<ImportTemplate> filterByName = Optional.ofNullable(importTemplate)
.filter(f -> f.getTemplateName().contains("发货单"));
System.out.println(filterByName.isPresent());
}
public static ImportTemplate getImportTemplateById(int id) {
return new ImportTemplate(1, "销售订单-普通商品导入模版", "o_w-140e3c1f41c94f238196539558e25bf7", null);
}

输出结果：

Java中Optional的使用指南

2.9 转换值

Optional类提供了以下2个方法来转换值：

map
flatMap

map方法的使用方法如下所示：

public static void main(String[] args) {
ImportTemplate importTemplate = getImportTemplateById(1);
Optional<String> optionalUrl = Optional.ofNullable(importTemplate)
.map(f -> "url:" + f.getUrl());
System.out.println(optionalUrl.isPresent());
System.out.println(optionalUrl.get());
}
public static ImportTemplate getImportTemplateById(int id) {
return new ImportTemplate(1, "销售订单-普通商品导入模版", "o_w-140e3c1f41c94f238196539558e25bf7", null);
}

输出结果：

Java中Optional的使用指南

flatMap方法和map方法类似，不过它支持传入Optional，使用方法如下所示：

public static void main(String[] args) {
ImportTemplate importTemplate = getImportTemplateById(1);
Optional<String> optionalUrl = Optional.ofNullable(importTemplate)
.flatMap(f -> Optional.ofNullable(f.getUrl()));
System.out.println(optionalUrl.isPresent());
System.out.println(optionalUrl.get());
}
public static ImportTemplate getImportTemplateById(int id) {
return new ImportTemplate(1, "销售订单-普通商品导入模版", "o_w-140e3c1f41c94f238196539558e25bf7", null);
}