Java8新特性之Optional，如何优雅地处理空指针
是什么
从 Java 8 引入的一个很有趣的特性是 Optional 类。Optional 类主要解决的问题是臭名昭著的空指针异常（NullPointerException）—— 每个 Java 程序员都非常了解的异常。
本质上，这是一个包含有可选值的包装类，这意味着 Optional 类既可以含有对象也可以为空。
Optional 是 Java 实现函数式编程的强劲一步，并且帮助在范式中实现。但是 Optional 的意义显然不止于此。
我们从一个简单的用例开始。在 Java 8 之前，任何访问对象方法或属性的调用都可能导致 NullPointerException：
String isocode = user.getAddress().getCountry().getIsocode().toUpperCase();
在这个小示例中，如果我们需要确保不触发异常，就得在访问每一个值之前对其进行明确地检查：
if (user != null) {
Address address = user.getAddress();
if (address != null) {
Country country = address.getCountry();
if (country != null) {
String isocode = country.getIsocode();
if (isocode != null) {
isocode = isocode.toUpperCase();
}
}
}
}
你看到了，这很容易就变得冗长，难以维护。
为了简化这个过程，我们来看看用 Optional 类是怎么做的。从创建和验证实例，到使用其不同的方法，并与其它返回相同类型的方法相结合，下面是见证 Optional 奇迹的时刻。
怎么用
创建 Optional实例
重申一下，这个类型的对象可能包含值，也可能为空。你可以使用同名方法创建一个空的 Optional。
@Test(expected = NoSuchElementException.class)
public void whenCreateEmptyOptional_thenNull() {
Optional<User> emptyOpt = Optional.empty();
emptyOpt.get();
}
毫不奇怪，尝试访问 emptyOpt 变量的值会导致 NoSuchElementException
你可以使用 of() 和 ofNullable() 方法创建包含值的 Optional。两个方法的不同之处在于如果你把 null 值作为参数传递进去，of()方法会抛出 NullPointerException：
@Test(expected = NullPointerException.class)
public void whenCreateOfEmptyOptional_thenNullPointerException() {
Optional<User> opt = Optional.of(user);
}
你看，我们并没有完全摆脱 NullPointerException。因此，你应该明确对象不为 null 的时候使用 of()。
如果对象可能是 null 也可能是非 null，你就应该使用 ofNullable() 方法：
Optional<User> opt = Optional.ofNullable(user);
访问 Optional对象的值
从 Optional 实例中取回实际值对象的方法之一是使用 get()方法：
@Test
public void whenCreateOfNullableOptional_thenOk() {
String name = "John";
Optional<String> opt = Optional.ofNullable(name);
assertEquals("John", opt.get());
}
不过，这个方法会在值为 null 的时候抛出异常。要避免异常，你可以选择首先验证是否有值：
@Test
public void whenCheckIfPresent_thenOk() {
User user = new User();
Optional<User> opt = Optional.ofNullable(user);
assertTrue(opt.isPresent());
assertEquals(user.getEmail(), opt.get().getEmail());
}
//isPresent()两个重载方法
public boolean isPresent() {
return value != null;
}
public void ifPresent(Consumer<? super T> consumer) {
if (value != null)
consumer.accept(value);
}
检查是否有值的另一个选择是 ifPresent()方法。该方法除了执行检查，还接受一个Consumer(消费者) 参数，如果对象不是空的，就对执行传入的 Lambda 表达式：
@Test
public void whenCheckIfPresent_thenOk() {
Admin admin = new Admin("1234@qq.com", "1234");
Optional<Admin> opt = Optional.ofNullable(admin);
opt.ifPresent( u -> System.out.println(u.getEmail()));
}
这个例子中，只有 admin用户不为 null 的时候才会执行lambda表达式中的代码
接下来，我们来看看提供空值的方法。
返回默认值
Optional 类提供了 API 用以返回对象值，或者在对象为空的时候返回默认值。
这里你可以使用的第一个方法是 orElse()，它的工作方式非常直接，如果有值则返回该值，否则返回传递给它的参数值
@Test
public void whenEmptyValue_thenReturnDefault() {
User user = null;
User user2 = new User("anna@gmail.com", "1234");
User result = Optional.ofNullable(user).orElse(user2);
assertEquals(user2.getEmail(), result.getEmail());
}
这里 user 对象是空的，所以返回了作为默认值的 user2
如果对象的初始值不是 null，那么默认值会被忽略：
@Test
public void whenValueNotNull_thenIgnoreDefault() {
User user = new User("john@gmail.com","1234");
User user2 = new User("anna@gmail.com", "1234");
User result = Optional.ofNullable(user).orElse(user2);
assertEquals("john@gmail.com", result.getEmail());
}
第二个同类型的 API 是 orElseGet()—— 其行为略有不同。这个方法会在有值的时候返回值，如果没有值，它会执行作为参数传入的 Supplier(供应者) 函数式接口，并将返回其执行结果：
User result = Optional.ofNullable(user).orElseGet( () -> user2);
orElse() 和 orElseGet()的不同之处
乍一看，这两种方法似乎起着同样的作用。然而事实并非如此。我们创建一些示例来突出二者行为上的异同。
我们先来看看对象为空时他们的行为：
@Test
public void givenEmptyValue_whenCompare_thenOk() {
User user = null
logger.debug("Using orElse");
User result = Optional.ofNullable(user).orElse(createNewUser());
logger.debug("Using orElseGet");
User result2 = Optional.ofNullable(user).orElseGet(() -> createNewUser());
}
private User createNewUser() {
logger.debug("Creating New User");
return new User("extra@gmail.com", "1234");
}
上面的代码中，两种方法都调用了 createNewUser() 方法，这个方法会记录一个消息并返回 User 对象。
代码输出如下：
Using orElse
Creating New User
Using orElseGet
Creating New User
由此可见，当对象为空而返回默认对象时，行为并无差异。
我们接下来看一个类似的示例，但这里 Optional 不为空：
@Test
public void givenPresentValue_whenCompare_thenOk() {
User user = new User("john@gmail.com", "1234");
logger.info("Using orElse");
User result = Optional.ofNullable(user).orElse(createNewUser());
logger.info("Using orElseGet");
User result2 = Optional.ofNullable(user).orElseGet(() -> createNewUser());
}
这次的输出：
Using orElse
Creating New User
Using orElseGet
这个示例中，两个 Optional 对象都包含非空值，两个方法都会返回对应的非空值。不过，orElse() 方法仍然创建了 User 对象。与之相反，orElseGet() 方法不创建User对象。
在执行较密集的调用时，比如调用 Web 服务或数据查询，这个差异会对性能产生重大影响。
返回异常
除了 orElse() 和 orElseGet() 方法，Optional 还定义了 orElseThrow() API —— 它会在对象为空的时候抛出异常，而不是返回备选的值：
@Test(expected = IllegalArgumentException.class)
public void whenThrowException_thenOk() {
User result = Optional.ofNullable(user)
.orElseThrow( () -> new IllegalArgumentException());
}
这里，如果 user 值为 null，会抛出 IllegalArgumentException。
这个方法让我们有更丰富的语义，可以决定抛出什么样的异常，而不总是抛出 NullPointerException。
现在我们已经很好地理解了如何使用 Optional，我们来看看其它可以对 Optional 值进行转换和过滤的方法。
转换值
有很多种方法可以转换 Optional 的值。我们从 map() 和 flatMap() 方法开始。
先来看一个使用 map() API 的例子：
@Test
public void whenMap_thenOk() {
User user = new User(new Address("北京"));
String country = Optional.ofNullable(user)
.map(User::getAddress) //这一步返回Optional[Address{country='北京'}]
.map(Address::getCountry) //Option[北京]
.orElse("China");
}
map()将要转换的值作为参数，然后将其包装在 Optional中返回。这就使链试调用的操作成为可能
相比较下，flatMap()和map()作用类似，当参数为null时，两者都返回一个空的Optional，只不过在入参不是null时有些区别。
map()和flatMap()的区别
map会将传入的Function函数的结果进行封装，先看源码：
public<U> Optional<U> map(Function<? super T, ? extends U> mapper) {
Objects.requireNonNull(mapper);
if (!isPresent())
return empty();
else {
//会使用Optional的ofNullable方法包装Function函数返回的值
return Optional.ofNullable(mapper.apply(value));
}
}
flatMap会直接返回Function函数执行的结果，看源码：
public<U> Optional<U> flatMap(Function<? super T, Optional<U>> mapper) {
Objects.requireNonNull(mapper);
if (!isPresent())
return empty();
else {
return Objects.requireNonNull(mapper.apply(value));//直接返回Function执行的结果
}
}
public static <T> T requireNonNull(T obj) {
if (obj == null)
throw new NullPointerException();
return obj;
}
这样看，好像也看不出来两者太大的区别，不知道什么时候用map，什么时候用flatMap，首先对于下列对象的操作
public class School {
private String name;
private Optional<Tearch> tearch; //属性为Option封装的Tearch对象
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public Optional<Tearch> getTearch() {
return tearch;
}
public void setTearch(Optional<Tearch> tearch) {
this.tearch = tearch;
}
}
class Tearch{
private String name;
private Optional<Student> student;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public Optional<Student> getStudent() {
return student;
}
public void setStudent(Optional<Student> student) {
this.student = student;
}
}
class Student{
private String name;
private int age;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public int getAge() {
return age;
}
public void setAge(int age) {
this.age = age;
}
}
这时，如果给你一个School对象，让你得到Student的name属性的值，可以使用下面的方式：
public static String getStudentName(School school){
return Optional.ofNullable(school)
.map(School::getTearch)
.map(Tearch::getStudent)
.map(Student::getName)
.orElse("false");
}
你可能感觉这样写很对啊，没毛病，可惜这段代码连编译都不会通过的，我们思考一下，School::getTearch会返回School实例的tearch属性，而tearch属性是使用Optional包装的Tearch对象，所以使用了map(School::getTearch)，会返回Optional<Optional<Tearch>>对象，而不是我们所想的Optional<Tearch>，
这时就可以使用flatMap来解决这个问题，刚才已经说了，flatMap不会使用Optional包装Function执行的返回结果，所以我们可以使用flatMap来解决这个问题
public static String getStudentName(School school){
return Optional.ofNullable(school)
.flatMap(School::getTearch)
.flatMap(Tearch::getStudent)
.map(Student::getName).orElse("false");
}
这时map和flatMap的用法就清楚了
- 如果某对象实例的属性本身就为Optional包装过的类型，那么就要使用flatMap方法，就像School::getTearch返回的就是Optional
类型的，所以不能再使用Optional进行包装，这时就要选用flatMap方法 - 对于返回值是其他类型，需要Optional进行包装，如Student::getName得到是String类型的，就需要使用map方法在其外面包装一层Optional对象。
过滤值
除了转换值之外，Optional 类也提供了按条件“过滤”值的方法。
filter() 接受一个Predicate参数，返回测试结果为 true 的值。如果测试结果为 false，会返回一个空的 Optional。
来看一个根据基本的电子邮箱验证来决定接受或拒绝 User用户) 的示例：
@Test
public void whenFilter_thenOk() {
User user = new User("anna@gmail.com", "1234");
Optional<User> result = Optional.ofNullable(user)
.filter(u -> u.getEmail() != null && u.getEmail().contains("@"));
assertTrue(result.isPresent());
}
如果通过过滤器测试，result 对象会非空且包含@字符。
实战
Optional 类的链式调用（重要）
我们使用 Optional 重写文章开始处介绍的示例。
User user = null;
String country = Optional.ofNullable(user)
.map(User::getAddress)
.map(Address::getCountry)
.map(Country::getIsocode)
.orElse("default");
System.out.println(country.toUpperCase()); //DEFAULT
上面的嵌套结构可以用下面的图来表示：
常用赋值判空
User user1 = new User(new Address("JAPAN"));
User user2 = new User(new Address("CHINA"));
User user3 = new User();
//user2.getAddress()不为空ifPresent()才执行
Optional.ofNullable(user2.getAddress()).ifPresent(user1::setAddress);
System.out.println(user1.getAddress().getCountry());//CHINA
Optional.ofNullable(user3.getAddress()).ifPresent(user1::setAddress);
System.out.println(user1.getAddress().getCountry());//JAPAN
Java 9 增强
我们介绍了 Java 8 的特性，Java 9 为 Optional 类添加了三个方法：or()、ifPresentOrElse()、stream()
or() 方法与 orElse() 和 orElseGet() 类似，它们都在对象为空的时候提供了替代情况。or() 的返回值是由 Supplier 参数产生的另一个 Optional 对象。
如果对象包含值，则 Lambda 表达式不会执行：
@Test
public void whenEmptyOptional_thenGetValueFromOr() {
User result = Optional.ofNullable(user)
.or( () -> Optional.of(new User("default","1234"))).get();
assertEquals(result.getEmail(), "default");
}
上面的示例中，如果 user 变量是 null，它会返回一个 Optional，它所包含的 User 对象，其电子邮件为 “default”。
ifPresentOrElse() 方法需要两个参数：一个 Consumer 和一个 Runnable。如果对象包含值，会执行 Consumer 的动作，否则运行 Runnable。
候执行某个动作，或者只是跟踪是否定义了某个值，那么这个方法非常有用：
Optional.ofNullable(user).ifPresentOrElse( u -> logger.info("User is:" + u.getEmail()),
() -> logger.info("User not found"));
最后介绍的是新的 stream() 方法，它通过把实例转换为 *Stream* 对象，让你从广大的 Stream API 中受益。如果没有值，它会得到空的 Stream；有值的情况下，Stream 则会包含单一值。
我们来看一个把 Optional 处理成 Stream 的例子：
@Test
public void whenGetStream_thenOk() {
User user = new User("john@gmail.com", "1234");
List<String> emails = Optional.ofNullable(user)
.stream()
.filter(u -> u.getEmail() != null && u.getEmail().contains("@"))
.map( u -> u.getEmail())
.collect(Collectors.toList());
assertTrue(emails.size() == 1);
assertEquals(emails.get(0), user.getEmail());
}
这里对 Stream 的使用带来了其 filter()、map() 和 collect() 接口，以获取 List。
结语
在使用 Optional 的时候需要考虑一些事情，以决定什么时候怎样使用它。
重要的一点是Optional不是Serializable。因此，它不应该用作类的字段。
如果你需要序列化的对象包含 Optional 值，Jackson 库支持把 Optional 当作普通对象。也就是说，Jackson 会把空对象看作 null，而有值的对象则把其值看作对应域的值。这个功能在 jackson-modules-java8 项目中。
它在另一种情况下也并不怎么有用，就是在将其类型用作方法或构建方法的参数时。这样做会让代码变得复杂，完全没有必要：
User user = new User("john@gmail.com", "1234", Optional.empty());
使用重载方法来处理非要的参数要容易得多。
Optional 主要用作返回类型。在获取到这个类型的实例后，如果它有值，你可以取得这个值，否则可以进行一些替代行为。
Optional 类有一个非常有用的用例，就是将其与流或其它返回 Optional 的方法结合，以构建流畅的API。
我们来看一个示例，使用 Stream 返回 Optional 对象的 findFirst() 方法：
@Test
public void whenEmptyStream_thenReturnDefaultOptional() {
List<User> users = new ArrayList<>();
User user = users.stream().findFirst().orElse(new User("default", "1234"));
assertEquals(user.getEmail(), "default");
}
总结
Optional 是 Java 语言的有益补充 —— 它旨在减少代码中的 NullPointerExceptions，虽然还不能完全消除这些异常。
它也是精心设计，自然融入 Java 8 函数式支持的功能。
总的来说，这个简单而强大的类有助于创建简单、可读性更强、比对应程序错误更少的程序。
