学习java中的Optional

Optional类主要解决的问题是空指针异常（NullPointerException），从本质上讲，这是一个包含有可选值的包装类，这意味着Optional类既可以含有对象也可以为空。

Optional是Java实现函数式编程的强劲一步，并且帮助在范式中实现。但是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);
}

　  你看，我们并没有完全摆脱NullPointException。因此，你应该明确对象不为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("john@gmail.com", "1234");
    Optional<User> opt = Optional.ofNullable(user);
    assertTrue(opt.isPresent());

    assertEquals(user.getEmail(), opt.get().getEmail());
}

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

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

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

返回默认值

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("anna@gmail.com", "1234");
    String email = Optional.ofNullable(user)
      .map(u -> u.getEmail()).orElse("default@gmail.com");

    assertEquals(email, user.getEmail());
}

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

       相比之下，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());
}

　　

过滤值

除了转换值之外，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，你可以链接组合其大部分方法，因为它们都返回相同类似的对象。

我们使用 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);
    }

    // ...
}

　　

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。