一. 前言
从 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
1. 创建 Optional 实例
Optional对象可能包含值,也可能为空,有以下三种创建方法
- 使用 **empty() **方法创建一个空的 Optional。
Optional<User> emptyOpt = Optional.empty();
emptyOpt.get();
毫不奇怪,尝试访问 emptyOpt 变量的值会导致 NoSuchElementException。
- 使用** _of() _方法创建**包含值的 Optional,不能传入null类型,会抛出 NullPointerException:
Optional<User> opt = Optional.of(user);
- 使用 **ofNullable()** **方法创建**包含值的 Optional,可以传入null类型
Optional<User> opt = Optional.ofNullable(user);
2. 访问 Optional 对象的值
- 使用** _get()_ **方法获取值,这个方法会在值为 null 的时候抛出异常
String name = "John";
Optional<String> opt = Optional.ofNullable(name);
assertEquals("John", opt.get());
x
- 使用** _ifPresent()** 方法获取值,该方法除了执行检查,还接受一个_Consumer(消费者) 参数,如果对象不是空的,就对执行传入的 Lambda 表达式:
opt.ifPresent( u -> assertEquals(user.getEmail(), u.getEmail()));
这个例子中,只有 user 用户不为 null 的时候才会执行断言。
接下来,我们来看看提供空值的方法。
3. 返回默认值
Optional 类提供了 API 用以返回对象值,或者在对象为空的时候返回默认值。
- 使用 orElse() **返回默认值**,如果有值则返回该值,否则返回传递给它的参数值:
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,那么默认值会被忽略:
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());
- 使用 **orElseGet()** 返回默认值 ,这个方法会在有值的时候返回值,如果没有值,它会执行作为参数传入的 Supplier(供应者) 函数式接口,并将返回其执行结果:
User result = Optional.ofNullable(user).orElseGet( () -> user2);
orElse() 和 orElseGet() 的不同之处?
**
乍一看,这两种方法似乎起着同样的作用。然而事实并非如此。我们创建一些示例来突出二者行为上的异同。
- 当Optional对象为空时
@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 服务或数据查询,这个差异会对性能产生重大影响。
4. 返回异常
除了 orElse() 和 orElseGet() 方法,Optional 还定义了_ orElseThrow()** _API
它会在对象为空的时候抛出异常,而不是返回备选的值**
User result = Optional.ofNullable(user).orElseThrow( () -> new IllegalArgumentException());
这里,如果 user 值为 null,会抛出 IllegalArgumentException。
这个方法让我们有更丰富的语义,可以决定抛出什么样的异常,而不总是抛出 NullPointerException。
现在我们已经很好地理解了如何使用 Optional,我们来看看其它可以对 Optional 值进行转换和过滤的方法。
5. 转换值
有很多种方法可以转换 Optional 的值。我们从 map() 和 flatMap() 方法开始。
- 使用** _map()_ 方法转换 Optional 的值**
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() **方法转换 Optional 的值,
也需要函数作为参数,并对值调用这个函数,然后直接返回结果。下面的操作中,我们给 User 类添加了一个方法,用来返回 Optional:
public class User {
private String position;
public Optional<String> getPosition() {
return Optional.ofNullable(position);
}
}
既然 getter 方法返回 String 值的 Optional,你可以在对 User __的 Optional 对象调用 flatMap() 时,用它作为参数,返回的值是解除包装的 String 值:
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());
6. 过滤值
除了转换值之外,Optional 类也提供了按条件“过滤”值的方法。
filter() 接受一个 Predicate 参数,测试结果为 false,会返回一个空的 Optional,否则正常返回
来看一个根据基本的电子邮箱验证来决定接受或拒绝 User__(用户) 的示例:
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());
7. 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);
}
// ...
}
public class Country {
private String isocode ;
// ...
}
上面的嵌套结构可以用下面的图来表示:
现在可以删除 null 检查,替换为 Optional 的方法:
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");
8. Java 9 增强
我们介绍了 Java 8 的特性,**Java 9 为 Optional 类添加了三个方法:or()、ifPresentOrElse() 和 stream()。
**
- or() 方法与 orElse() 和 orElseGet() 类似,它们都在对象为空的时候提供了替代情况。
or() 的返回值是由 Supplier 参数产生的另一个 Optional 对象,如果对象包含值,则 Lambda 表达式不会执行:
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 的例子:
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。
9. Optional 应该怎样用?
在使用 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 函数式支持的功能。
总的来说,这个简单而强大的类有助于创建简单、可读性更强、比对应程序错误更少的程序。