彻底搞懂Optional,从此告别空指针
相信有的小伙伴已经被项目中莫名的空指针异常(Null Pointer Exception)搞的头昏脑涨,这也是每个 Java 程序员都非常了解的一个异常,那么我们今天就要尽可能的利用Java8的新特性 Optional来尽量简化代码同时高效处理空指针异常
认识Optional
从 Java 8 引入的一个很有趣的特性是 Optional 类。该类在java.util
包下诞生的意义就是为我们解决臭名昭著的空指针异常`(NullPointerException),同时Optional 的存在可以让代码更加简单,可读性跟高,代码写起来更高效。
我们从一个简单的用例开始。在 Java 8 之前,任何访问对象方法或属性的调用都可能导致 NullPointerException:
String countryCode = new User().getAddress().getCountry().getCode().toUpperCase();
在这个小示例中,如果我们需要确保不触发异常,就得在访问每一个值之前对其进行明确地检查 代码如下:
User user = new User();
if(user != null){
Address address = user.getAddress();
if(address != null){
Country country = address.getCountry();
if(country != null){
String code = country.getCode();
if(code != null){
code.toUpperCase();
}
}
}
}
试问谁看到上述代码心态不发生一点小变化呢?冗余,可读性差,不好维护
为了简化这个过程,我们来看看用 Optional 类是怎么做的。从创建和验证实例,到使用其不同的方法,并与其它返回相同类型的方法相结合,下面是见证 Optional 奇迹的时刻。
String code = Optional.of(user)
.flatMap(User::getAddressOptional)
.flatMap(Address::getCountryOptional)
.map(Country::getCode)
.map(String::toUpperCase)
.orElse("ct-code");
如果你好奇 Optional 是如何做到的,那请你与我一同往下探究
创建 Optional 实例
重申一下,这个类型的对象可能包含值,也可能为空。你可以使用同名方法创建一个空的 Optional。
Optional<User> emptyOpt = Optional.empty();
emptyOpt.get();
毫不奇怪,尝试访问 emptyOpt 变量的值会导致 NoSuchElementException。
你可以使用 of() 和 ofNullable() 方法创建包含值的 Optional。两个方法的不同之处在于如果你把 null 值作为参数传递进去,of() 方法会抛出 NullPointerException:
Optional<User> opt = Optional.of(user);
你看,我们并没有完全摆脱 NullPointerException。因此,你应该明确对象不为 null 的时候使用 of()。
如果对象即可能是 null 也可能是非 null,你就应该使用 ofNullable() 方法:
Optional<User> opt = Optional.ofNullable(user);
获取Optional 对象的值
从 Optional 实例中取回实际值对象的方法之一是使用 get() 方法:
private static String getStr(){
String name = "ct-code";
Optional<String> opt = Optional.ofNullable(name);
return opt.get();
}
不过,你看到了,这个方法会在值为 null 的时候抛出异常。要避免异常,你可以选择首先验证是否有值:
private static String whenCheckIfPresent(){
String name = null;
Optional<String> opt = Optional.ofNullable(name);
if(opt.isPresent()){
return opt.get();
}
return null;
}
检查是否有值的另一个选择是 ifPresent() 方法 返回是一个Boolean值。该方法除了执行检查,还接受一个Consumer(消费者) 参数,如果值不是空的,就对执行传入的 Lambda 表达式:
opt.ifPresent( String::toString);
接下来,我们来看看提供空值的方法。
返回默认值
Optional 类提供了 API 用以返回对象值,或者在对象为空的时候返回默认值。
这里你可以使用的第一个方法是 orElse(),它的工作方式非常直接,如果有值则返回该值,否则返回传递给它的参数值:
private static String isNullDefReturn(){
String name = null;
return Optional.ofNullable(name).orElse("ct-code");
}
这里 user 对象是空的,所以返回了作为默认值的 user2。
如果对象的初始值不是 null,那么默认值会被忽略:
private static String isNotNullDefReturn(){
String name = "up";
return Optional.ofNullable(name).orElse("ct-code");
}
第二个同类型的 API 是 orElseGet() —— 其行为略有不同。这个方法会在有值的时候返回值,如果没有值,它会执行作为参数传入的 Supplier(供应者) 函数式接口,并将返回其执行结果:
User result = Optional.ofNullable(user).orElseGet( () -> user2);
orElse() 和 orElseGet() 的不同之处
Optional.of("ct-code").orElse(getDefault()); // 会执行
Optional.of("ct-code").orElseGet(() -> getDefault()); // 不会执行
public static String getDefault() {
System.out.println("do invoke");
return "default";
}
- 当
Optonal
为空时,无论orElse
还是orElseGet
都会执行; - 当
Optional
有值时,orElse
会执行,而orElseGet
不会执行。
乍一看确实有点懵,明明有值,为什么还执行,怎么都觉得跟orElse
的语义违背
怀着好奇心,我看了下orElse
的源码:
public T orElse(T other) {
return value != null ? value : other;
}
一开始有点没明白,我传的是一个类调用,这里接收的是一个对象,然后突然就想明白了。。。
其实不管是orElse还是orElseGet都会进到对应的方法里面的,所以在要执行orElse之前,那参数的值我总要知道吧,所以肯定先要执行传入的方法才行。
实际跟踪代码也会发现,进到orElse之前,getDefault方法就已经执行了。
对比看下orElseGet
的源码就更清楚为啥它就不会执行:
public T orElseGet(Supplier<? extends T> other) {
return value != null ? value : other.get();
}
思考一下,我感觉我似乎明白了orElse
和orElseGet
的语义
- 当else的值的对象是现有的时,使用
orElse
直接返回该对象; - 涉及到方法获取else值的时候,用
orElseGet
前者立即计算,后者是延迟计算。所以如果备选值是无需计算的,现在已有的,那就用orElse。如果值还没得到,那最好用orElseGet延迟执行。一般最多的情况是类似字符串拼装、创建新对象这样的,都应该用orElseGet。在执行较密集的调用时,比如调用 Web 服务或数据查询,这个差异会对性能产生重大影响
返回异常
除了 orElse() 和 orElseGet() 方法,Optional 还定义了 orElseThrow() API —— 它会在对象为空的时候抛出异常,而不是返回备选的值:
private static void getExceptionOptional() throws Exception {
Optional.ofNullable(null).orElseThrow(()->new Exception("test threow"));
}
这里,如果 user 值为 null,会抛出 Exception。
这个方法让我们有更丰富的语义,可以决定抛出什么样的异常,而不总是抛出 NullPointerException。
现在我们已经很好地理解了如何使用 Optional,我们来看看其它可以对 Optional 值进行转换和过滤的方法。
转换值
map()
有很多种方法可以转换 Optional 的值。我们从 map() 和 flatMap() 方法开始。
先来看一个使用 map() API 的例子:
private static String map(){
User user = new User();
user.setName("ct-code");
return Optional.ofNullable(user).map(User::getName).orElse("");
}
***map()* 对值应用(调用)作为参数的*函数*,然后将返回的值包装在 *Optional* 中。**这就使对返回值进行链试调用的操作成为可能 —— 这里的下一环就是 orElse()。
flatMap()
相比这下,flatMap() 也需要函数作为参数,并对值调用这个函数,然后直接返回结果。
下面的操作中,我们给 User 类添加了一个方法,用来返回 Optional:
public Optional<Address> getAddressOptional() {
return Optional.ofNullable(address);
}
既然 getter 方法返回 String 值的 Optional,你可以在对 User 的 Optional 对象调用 flatMap() 时,用它作为参数。其返回的值是解除包装的 String 值:
User user = new User();
Optional<Address> address = Optional.ofNullable(user).flatMap(u -> u.getAddressOptional()).orElse(new Address());
Address a = address.get()
map和flatMap的区别
咋们从源码进行分析
map会将传入的Function函数的结果进行封装,看源码:
public<U> Optional<U> map(Function<? super T, ? extends U> mapper) {
Objects.requireNonNull(mapper);
if (!isPresent())
return empty();
else {
return Optional.ofNullable(mapper.apply(value));//会使用Optional的ofNullable方法包装Function函数返回的值
}
}
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执行的结果
}
}
如果需要判断有层级关系的属性时建议使用 flatMap,因为使用map()会导致嵌套结构,尽管它可以使用,但是使用起来非常麻烦,并且不提供任何附加的null安全性,因此最好保留平坦的结构。
过滤值
除了转换值之外,Optional 类也提供了按条件“过滤”值的方法。
*filter()* 接受一个 *Predicate* 参数,返回测试结果为 true 的值。如果测试结果为 false,会返回一个空的 Optional。
User user = new User("ct-code", "1234");
Optional<User> result = Optional.ofNullable(user)
.filter(u -> u.getUser() != null );
如果通过过滤器测试,result 对象会包含非空值。
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("ct-code","up"))).get();
上面的示例中,如果 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("ct-code", "1234");
List<String> emails = Optional.ofNullable(user)
.stream()
.filter(u -> u.getEmail() != null)
.map( u -> u.getEmail())
.collect(Collectors.toList());
这里对 Stream 的使用带来了其 filter()、map() 和 collect() 接口,以获取 List。
总结
Optional 是 Java 语言的有益补充 —— 它旨在减少代码中的 NullPointerExceptions,虽然还不能完全消除这些异常。它也是精心设计,自然融入 Java 8 函数式支持的功能。总的来说,这个简单而强大的类有助于创建简单、可读性更强、比对应程序错误更少的程序。
注意:Option类是判断空指针异常时用的,对于其他的if…else只要不是判断空指针的问题,就不要使用Option类,不要陷入一个误区,以为学了Option类,看见if…else就往Option来想,这么做真是大作特错。用Option的情况时在判断值是否为null时,Option就发挥作用了。