详解JAVA中的OPTIONAL
一、概述
本质上,这是一个包含有可选值的包装类,这意味着 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);
2.1、访问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 的时候才会执行断言。
接下来,我们来看看提供空值的方法。
2.2、返回默认值
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);
2.3、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 服务或数据查询,这个差异会对性能产生重大影响。
2.4、返回异常
除了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()); }
3.1、过滤值
除了转换值之外,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); } // ... }
上面的嵌套结构可以用下面的图来表示:
现在可以删除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");
结果现在的代码看起来比之前采用条件分支的冗长代码简洁多了。
五、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对象,让你从广大的streamapi 中受益。如果没有值,它会得到空的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的时候需要考虑一些事情,以决定什么时候怎样使用它。
重要的一点是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 函数式支持的功能。
总的来说,这个简单而强大的类有助于创建简单、可读性更强、比对应程序错误更少的程序。
以上就是详解java中的optional的详细内容,更多关于java optional的资料请关注其它相关文章!