详解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 15 Java/Android
SpringBoot实现异步事件驱动的方法
Jun 28 Java/Android
利用Java设置Word文本框中的文字旋转方向的实现方法
Jun 28 Java/Android
使用@Value值注入及配置文件组件扫描
Jul 09 Java/Android
聊聊Lombok中的@Builder注解使用教程
Nov 17 Java/Android
Java并发编程之原子性-Atomic的使用
Mar 16 Java/Android
SpringBoot整合minio快速入门教程(代码示例)
Apr 03 Java/Android
Android开发之WECHAT微信小程序路由跳转的两种形式
Apr 12 Java/Android
Jmerte 分布式压测及分布式压测配置
Apr 30 Java/Android
java版 简单三子棋游戏
May 04 Java/Android
解决spring.thymeleaf.cache=false不起作用的问题
Jun 10 Java/Android
Spring Boot 的创建和运行示例代码详解
Jul 23 Java/Android
解析Java中的static关键字
Java实现斗地主之洗牌发牌
MybatisPlus代码生成器的使用方法详解
教你用Java在个人电脑上实现微信扫码支付
Java内存模型之happens-before概念详解
Java实战之用Swing实现通讯录管理系统
在Java中Collection的一些常用方法总结
You might like
Smarty结合Ajax实现无刷新留言本实例
2007/01/02 PHP
php面向对象全攻略 (六)__set() __get() __isset() __unset()的用法
2009/09/30 PHP
Linux下实现PHP多进程的方法分享
2012/08/16 PHP
解决ajax+php中文乱码的方法详解
2013/06/09 PHP
C#使用PHP服务端的Web Service通信实例
2014/04/08 PHP
php批量添加数据与批量更新数据的实现方法
2014/12/16 PHP
php从数据库中读取特定的行(实例)
2017/06/02 PHP
javaScript checkbox 全选/反选及批量删除
2010/04/28 Javascript
JQuery跨Iframe选择实现代码
2010/08/19 Javascript
js分解url参数(面向对象-极简主义法应用)
2012/08/09 Javascript
Javascript Object 对象学习笔记
2014/12/17 Javascript
JS代码实现根据时间变换页面背景效果
2016/06/16 Javascript
video.js 实现视频只能后退不能快进的思路详解
2018/08/09 Javascript
浅谈在Vue.js中如何实现时间转换指令
2019/01/06 Javascript
JS实现动态添加外部js、css到head标签的方法
2019/06/05 Javascript
vue-router为激活的路由设置样式操作
2020/07/18 Javascript
从源码角度来回答keep-alive组件的缓存原理
2021/01/18 Javascript
[01:09:24]Ti4开幕式
2014/07/19 DOTA
[10:54]Team Spirit vs Navi
2018/06/07 DOTA
python 巧用正则寻找字符串中的特定字符的位置方法
2018/05/02 Python
​如何愉快地迁移到 Python 3
2019/04/28 Python
使用python采集Excel表中某一格数据
2020/05/14 Python
PyQt5-QDateEdit的简单使用操作
2020/07/12 Python
如何真正的了解python装饰器
2020/08/14 Python
jupyter notebook快速入门及使用详解
2020/11/13 Python
HTML5之SVG 2D入门11—用户交互性(动画)介绍及应用
2013/01/30 HTML / CSS
加拿大约会网站:EliteSingles.ca
2018/01/12 全球购物
Marlies Dekkers内衣美国官方网上商店:高端内衣品牌
2018/11/12 全球购物
面向对象编程OOP的优点
2013/01/22 面试题
int *p=NULL和*p= NULL有什么区别
2014/10/23 面试题
大学自主招生自荐信范文
2014/02/26 职场文书
关于环保的建议书
2014/05/12 职场文书
霸气队列口号
2014/06/18 职场文书
舞蹈教育学专业求职信
2014/06/29 职场文书
2014年路政工作总结
2014/12/10 职场文书
MySQL事务的隔离级别详情
2022/07/15 MySQL