详解JAVA中的OPTIONAL


Posted in Java/Android onJune 14, 2021

一、概述

本质上,这是一个包含有可选值的包装类,这意味着 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);
    }

    // ...
}

上面的嵌套结构可以用下面的图来表示:

详解JAVA中的OPTIONAL

现在可以删除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的资料请关注三水点靠木其它相关文章!

Java/Android 相关文章推荐
分享一些Java的常用工具
Jun 11 Java/Android
SpringCloud Alibaba 基本开发框架搭建过程
Jun 13 Java/Android
Java用自带的Image IO给图片添加水印
Jun 15 Java/Android
Feign调用传输文件异常的解决
Jun 24 Java/Android
HashMap实现保存两个key相同的数据
Jun 30 Java/Android
SpringCloud之@FeignClient()注解的使用方式
Sep 25 Java/Android
OpenCV实现反阈值二值化
Nov 17 Java/Android
SpringBoot中获取profile的方法详解
Apr 08 Java/Android
解决springboot druid数据库连接失败后一直重连的方法
Apr 19 Java/Android
Java实现带图形界面的聊天程序
Jun 10 Java/Android
阿里面试Nacos配置中心交互模型是push还是pull原理解析
Jul 23 Java/Android
app场景下uniapp的扫码记录
Jul 23 Java/Android
解析Java中的static关键字
Java实现斗地主之洗牌发牌
MybatisPlus代码生成器的使用方法详解
教你用Java在个人电脑上实现微信扫码支付
Java内存模型之happens-before概念详解
Java实战之用Swing实现通讯录管理系统
在Java中Collection的一些常用方法总结
You might like
浅析Apache中RewriteCond规则参数的详细介绍
2013/06/30 PHP
Yii实现的多级联动下拉菜单
2016/07/13 PHP
javascript 动态调整图片尺寸实现代码
2009/12/28 Javascript
javascript getElementsByClassName实现代码
2010/10/11 Javascript
两个多选select(multiple左右)添加、删除选项和取值实例
2014/05/12 Javascript
JavaScript获取网页表单提交方式的方法
2015/04/02 Javascript
详解JavaScript对W3C DOM模版的支持情况
2015/06/16 Javascript
z-blog SyntaxHighlighter 长代码无法换行解决办法(基于jquery)
2015/11/18 Javascript
JavaScript类型系统之基本数据类型与包装类型
2016/01/06 Javascript
jQuery Ajax File Upload实例源码
2016/12/12 Javascript
jQuery的extend方法【三种】
2016/12/14 Javascript
Bootstrap提示框效果的实例代码
2017/07/12 Javascript
JS跳转手机站url的若干注意事项
2017/10/18 Javascript
vue的无缝滚动组件vue-seamless-scroll实例
2017/12/18 Javascript
django使用channels2.x实现实时通讯
2018/11/28 Javascript
详解小程序中h5页面onShow实现及跨页面通信方案
2019/05/30 Javascript
Layui数据表格 前后端json数据接收的方法
2019/09/19 Javascript
[04:01]2014DOTA2国际邀请赛 TITAN告别Ohaiyo期望明年再战
2014/07/15 DOTA
[07:01]DOTA2-DPC中国联赛正赛 Aster vs Magma 3月5日 赛后选手采访
2021/03/11 DOTA
Python中的推导式使用详解
2015/06/03 Python
python实现DES加密解密方法实例详解
2015/06/30 Python
Python通过调用有道翻译api实现翻译功能示例
2018/07/19 Python
python3用PIL把图片转换为RGB图片的实例
2019/07/04 Python
django 实现将本地图片存入数据库,并能显示在web上的示例
2019/08/07 Python
python笔记_将循环内容在一行输出的方法
2019/08/08 Python
对Django中内置的User模型实例详解
2019/08/16 Python
解决Python对齐文本字符串问题
2019/08/28 Python
tensorflow 实现打印pb模型的所有节点
2020/01/23 Python
pandas map(),apply(),applymap()区别解析
2021/02/24 Python
BIBLOO捷克:购买女装、男装、童装、鞋和配件
2017/01/27 全球购物
电子商务网站的创业计划书
2014/01/05 职场文书
聚美优品恶搞广告词
2014/03/14 职场文书
个人担保书格式范文
2014/05/12 职场文书
学校火灾防控方案
2014/06/09 职场文书
毕业生爱心捐书倡议书
2015/04/27 职场文书
Springboot配置suffix指定mvc视图的后缀方法
2021/07/03 Java/Android