还在重复写空指针检查代码？考虑使用 Optional 吧！

一、前言

如果要给 Java 所有异常弄个榜单，我会选择将

NullPointerException

还记得刚入行程序员的时候，三天两头碰到空指针异常引发的 Bug，解决完一个，又在另一处碰到。那时候师兄就教我，不要相信任何『对象』，特别是别人给你的，这些地方都加上判断。于是代码通常为会变成下面这样：

if(obj!=null){
// do something
}

有了这个防御之后，虽然不用再担心空指针异常，但是过多的判断语句使得代码变得臃肿。

假设我们存在如下对象关系

原本为了获取图中的

name

Staff staff=..;
staff.getDepartment().getCompany().getName();

但是很不幸，为了代码的安全性，我们不得不加入空指针判断代码。

Staff staff=..;
if (staff != null) {
Department department = staff.getDepartment();
if (department != null) {
Company company = department.getCompany();
if (company != null) {
return company.getName();
}
}
}
return "Unknown";

null

虽然上面代码变得更加安全，但是过多嵌套 if 语句降低代码整体可读性，提高复杂度。

所幸 Java 8 引入引入一个新类

Java.util.Optional<T>

二、Optional API

2.1、Optional#of 与 Optional#ofNullable

Optional 本质是一个容器，需要我们将对象实例传入该容器中。

Optional

private

Optional

Optional

• Optional.of(obj)

  ,如果对象为 null，将会抛出 NPE。

• Optional.ofNullable(obj)

  ,如果对象为 null,将会创建不包含值的 empty

  Optional

  对象实例。

• Optional.empty()

  等同于

  Optional.ofNullable(null)

• 

只有在确定对象不会为 null 的情况使用

Optional#of

Optional#ofNullable

2.2、Optional#get 与 Optional#isPresent

对象实例存入

Optional

Optional#get

get

NoSuchElementException

为了防止异常抛出，可以使用

Optional#isPresent

示例代码如下:

Optional<Company> optCompany = Optional.ofNullable(company);
// 与直接使用空指针判断没有任何区别
if (optCompany.isPresent()) {
System.out.println(optCompany.get().getName());
}

仔细对比，可以发现上面用法与空指针检查并无差别。刚接触到

Optional

后来接触到

Optional

Optional

2.3、Optional#ifPresent

通常情况下，空指针检查之后，如果对象不为空，将会进行下一步处理，比如打印该对象。

Company company = ...;
if(company!=null){
System.out.println(company);
}

上面代码我们可以使用

Optional#ifPresent

Optional<Company> optCompany = ...;
optCompany.ifPresent(System.out::println);

使用

ifPresent

Optional

2.4、Optional#filter

有时候我们需要某些属性满足一定条件，才进行下一步动作。这里假设我们当 Company name 属性为 Apple，打印输出 ok。

if (company != null && "Apple".equals(company.getName())) {
System.out.println("ok");
}

下面使用

Optional#filter

Optional#ifPresent

Optional<Company> companyOpt=...;
companyOpt
.filter(company -> "Apple".equals(company.getName()))
.ifPresent(company -> System.out.println("ok"));

filter

Optional

2.5、Optional#orElse 与 Optional#orElseThrow

当一个对象为 null 时，业务上通常可以设置一个默认值，从而使流程继续下去。

String name = company != null ? company.getName() : "Unknown";

或者抛出一个内部异常，记录失败原因，快速失败。

if (company.getName() == null) {
throw new RuntimeException();
}

Optional

orElse

orElseThrow

// 设置默认值
String name=companyOpt.orElse(new Company("Unknown")).getName();

// 抛出异常
String name=companyOpt.orElseThrow(RuntimeException::new).getName();

如果

Optional

2.6、Optional#map 与 Optional#flatMap

熟悉 Java8 Stream 同学的应该了解，

Stream#map

Optional#map

Optional<Company> optCompany = ...;
Optional<String> nameopt = optCompany.map(Company::getName);

map 方法可以将原先

Optional<Company>

Optional<String>

Optional

另外 Optional 还有一个

flatMap

Department#getCompany

Optional<Company>

三、代码重构

上面我们学习了

Optional

Optional

代码重构前：

if (staff != null) {
Department department = staff.getDepartment();
if (department != null) {
Company company = department.getCompany();
if (company != null) {
return company.getName();
}
}
}
return "Unknown";

首先我们需要将

Staff

Department

Optional

public class Staff {
private Department department;
public Optional<Department> getDepartment() {
return Optional.ofNullable(department);
}
...
}
public class Department {

private Company company;
public Optional<Company> getCompany() {
return Optional.ofNullable(company);
}
...
}

public class Company {
private String name;
public String getName() {
return name;
}
...
}

然后综合使用 Optional API 重构代码如下：

Optional<Sta
576
ff> staffOpt =...;
staffOpt
.flatMap(Staff::getDepartment)
.flatMap(Department::getCompany)
.map(Company::getName)
.orElse("Unknown");

可以看到重构之后代码利用

Optional

四、帮助文章

1、Tired of Null Pointer Exceptions? Consider Using Java SE 8's Optional!
3、Optionals: Patterns and Good Practices
3、Java8 in Action