Java8新特性探索之Optional类

为什么引入Optional类？

身为一名Java程序员，大家可能都有这样的经历：调用一个方法得到了返回值却不能直接将返回值作为参数去调用别的方法。我们首先要判断这个返回值是否为null，只有在非空的前提下才能将其作为其他方法的参数。之前，Google Guava项目曾提出用Optional类来包装对象从而解决NullPointerException。受此影响，JDK8的类中也引入了Optional类，在新版的SpringData Jpa和Spring Redis Data中都已实现了对该方法的支持。Optional是可以包含或不包含非null值的容器对象，如果存在值，则isPresent()将返回true，而get()将返回该值。

如何使用Optional类？

Optional类方法汇总如下：

API	说明
of	把指定的值封装为Optional对象，如果指定的值为null，则抛出NullPointerException
ofNullable	把指定的值封装为Optional对象，如果指定的值为null，则创建一个空的Optional对象
get	如果创建的Optional中有值存在，则返回此值，否则抛出NoSuchElementException
isPresent	如果创建的Optional中的值存在，返回true，否则返回false
ifPresent	如果创建的Optional中的值存在，则执行该方法的调用，否则什么也不做
orElse	如果创建的Optional中有值存在，则返回此值，否则返回一个默认值
orElseGet	如果创建的Optional中有值存在，则返回此值，否则返回一个由Supplier接口生成的值
empty	创建一个空的Optional对象
orElseThrow	如果创建的Optional中有值存在，则返回此值，否则抛出一个由指定的Supplier接口生成的异常
filter	如果创建的Optional中的值满足filter中的条件，则返回包含该值的Optional对象，否则返回一个空的Optional对象
map	如果创建的Optional中的值存在，对该值执行提供的Function函数调用
flagMap	如果创建的Optional中的值存在，就对该值执行提供的Function函数调用，返回一个Optional类型的值，否则就返回一个空的Optional对象

创建Optional实例

1. 使用empty()

   重申一下，这个类型的对象可能包含值，也可能为空。你可以使用同名方法创建一个空的 Optional。

   @Test(expected = NoSuchElementException.class)
   public void createOptional_empty() {
       Optional<User> emptyOpt = Optional.empty();
       emptyOpt.get();
   }
   

   毫不奇怪，尝试访问 emptyOpt 变量的值会导致 NoSuchElementException。

2. 使用of()

   在使用of()方法创建包含值得Optional实例，值得注意的是如果你把 null 值作为参数传递进去，of() 方法会抛出 NullPointerException：

   @Test(expected = NullPointerException.class)
   public void createOptional_of() {
       Optional<User> opt = Optional.of(user);
   }
   

   我们并没有完全摆脱 NullPointerException。因此，你应该明确对象不为 null 的时候使用 of()。

3. 使用ofNullable()

   如果对象即可能是 null 也可能是非 null，那么就应该使用 ofNullable() 方法：

   Optional<User> opt = Optional.ofNullable(user);
   

使用get()访问Optional对象包装的值

从 Optional 实例中取回实际值对象的方法是使用 get() 方法：

@Test
public void getOptionalValue_ofNullable() {
    String name = "Johnson";
    Optional<String> opt = Optional.ofNullable(name);
    assertEquals("Johnson", opt.get());
}

不过，这个方法会在值为 null 的时候抛出异常。要避免异常，可以使用isPresent()验证是否有值：

@Test
public void getOptionalValue_isPresent() {
    User user = new User("johnson", "123");
    Optional<User> opt = Optional.ofNullable(user);
    assertTrue(opt.isPresent());
    assertEquals(user.getName(), opt.get().getName());
}

检查是否有值的另一个选择是 ifPresent() 方法。该方法除了执行检查，还接受一个Consumer(消费者) 参数，如果对象不是空的，就对执行传入的 Lambda 表达式：

opt.ifPresent( u -> assertEquals(user.getName(), u.getName()));

这个例子中，只有 user 用户不为 null 的时候才会执行断言。

Optional包装对象为空情况返回默认值

Optional 类提供了 API 用以返回对象值，或者在对象为空的时候返回默认值。

1. 使用orElse()

   可以使用orElse()方法，它的工作方式非常直接，如果有值则返回该值，否则返回传递给它的参数值：

   @Test
   public void whenEmptyValue_thenReturnDefault() {
       User user = null;
       User user2 = new User("johnson", "1234");
       User result = Optional.ofNullable(user).orElse(user2);
       assertEquals(user2.getName(), result.getName());
   }
   

   这里 user 对象是空的，所以返回了作为默认值的 user2。

   如果对象的初始值不是 null，那么默认值会被忽略：

   @Test
   public void whenValueNotNull_thenIgnoreDefault() {
       User user = new User("johnson","1234");
       User user2 = new User("johnson", "1234");
       User result = Optional.ofNullable(user).orElse(user2);
       assertEquals("johnson", result.getName());
   }
   

2. 使用orElseGet()

   可以使用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("johnson", "1234");
}

上面的代码中，两种方法都调用了 createNewUser() 方法，这个方法会记录一个消息并返回 User 对象。

代码输出如下：

Using orElse
Creating New User
Using orElseGet
Creating New User

由此可见，当对象为空而返回默认对象时，行为并无差异。

我们接下来看一个类似的示例，但这里 Optional 不为空：

@Test
public void givenPresentValue_whenCompare_thenOk() {
    User user = new User("johnson", "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 服务或数据查询，这个差异会对性能产生重大影响。

Optional包装对象为空情况返回异常

除了 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 值进行转换和过滤的方法。

map()和flatMap()转换Optional包装的值

有很多种方法可以转换 Optional 的值。我们从 map() 和 flatMap() 方法开始。

1. 使用map()

   先来看一个使用 map() 的例子：

   @Test
   public void whenMap_thenOk() {
       User user = new User("johnson", "1234");
       String email = Optional.ofNullable(user)
         .map(u -> u.getEmail()).orElse("johnson");
       assertEquals(email, user.getName());
   }
   

   map()对值应用(调用)作为参数的函数，然后将返回的值包装在 Optional中。这就使对返回值进行链试调用的操作成为可能 —— 这里的下一环就是 orElse()。

2. 使用flatMap()

   相比这下，flatMap() 也需要函数作为参数，并对值调用这个函数，然后直接返回结果。

   下面的操作中，我们给 User 类添加了一个方法，用来返回 Optional：

   public class User {    
       private String position;
   
       public Optional<String> getPosition() {
           return Optional.ofNullable(position);
       }
   }
   

   既然 getter 方法返回 String 值的 Optional，你可以在对 User 的 Optional 对象调用 flatMap() 时，用它作为参数。其返回的值是解除包装的 String 值：

   @Test
   public void whenFlatMap_thenOk() {
       User user = new User("anna@gmail.com", "1234");
       user.setPosition("Developer");
       String position = Optional.ofNullable(user)
         .flatMap(u -> u.getPosition()).orElse("default");
   
       assertEquals(position, user.getPosition().get());
   }
   

filter()过滤值

除了转换值之外，Optional 类也提供了按条件“过滤”值的方法。

filter()接受一个Predicate参数，返回测试结果为 true 的值。如果测试结果为 false，会返回一个空的 Optional。

来看一个根据基本的名称验证来决定接受或拒绝 User(用户) 的示例：

@Test
public void whenFilter_thenOk() {
    User user = new User("johnson", "1234");
    Optional<User> result = Optional.ofNullable(user)
      .filter(u -> u.getName() != null && u.getName().contains("@"));
    assertTrue(result.isPresent());
}

如果通过过滤器测试，result 对象会包含非空值。

Optional类的链式方法

为了更充分的使用 Optional，你可以链接组合其大部分方法，因为它们都返回相同类似的对象。

我们使用 Optional 重写最早介绍的示例。

首先，重构类，使其 getter 方法返回 Optional 引用：

public class User {
    private Address address;

    public Optional<Address> getAddress() {
        return Optional.ofNullable(address);
    }

    // ...
}
public class Address {
    private Country country;

    public Optional<Country> getCountry() {
        return Optional.ofNullable(country);
    }

    // ...
}

现在可以删除 null 检查，替换为 Optional 的方法：

@Test
public void whenChaining_thenOk() {
    User user = new User("anna@gmail.com", "1234");

    String result = Optional.ofNullable(user)
      .flatMap(u -> u.getAddress())
      .flatMap(a -> a.getCountry())
      .map(c -> c.getIsocode())
      .orElse("default");

    assertEquals(result, "default");
}

上面的代码可以通过方法引用进一步缩减：

String result = Optional.ofNullable(user)
  .flatMap(User::getAddress)
  .flatMap(Address::getCountry)
  .map(Country::getIsocode)
  .orElse("default");

结果现在的代码看起来比之前采用条件分支的冗长代码简洁多了。

总结

Optional 是 Java 语言的有益补充 —— 它旨在减少代码中的 NullPointerExceptions，虽然还不能完全消除这些异常。它也是精心设计，自然融入 Java 8 函数式支持的功能。总的来说，这个简单而强大的类有助于创建简单、可读性更强、比对应程序错误更少的程序。