# optional

返回:java8

关于Optional

从 Java 8 引入的一个很有趣的特性是 Optional 类。Optional 类主要解决的问题是臭名昭著的空指针异常(NullPointerException) —— 每个 Java 程序员都非常了解的异常。
本质上,这是一个包含有可选值的包装类,这意味着 Optional 类既可以含有对象也可以为空。 Optional 是 Java 实现函数式编程的强劲一步,并且帮助在范式中实现。但是 Optional 的意义显然不止于此。

我们从一个简单的用例开始。在 Java 8 之前,任何访问对象方法或属性的调用都可能导致NullPointerException

  • 1、Optional 是为核心类库新设计的一个数据类型,用来替换 null 值。
  • 2、人们对原有的 null 值有很多抱怨,甚至连发明这一概念的Tony Hoare也是如此,他曾说这是自己的一个“价值连城的错误”
  • 3、用处很广,不光在lambda中,哪都能用
  • 4、Optional.of(T),T为非空,否则初始化报错
  • 5、Optional.ofNullable(T),T为任意,可以为空
  • 6、isPresent(),相当于 !=null
  • 7、ifPresent(T), T可以是一段lambda表达式 ,或者其他代码,非空则执行
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();
            }
        }
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13

你看到了,这很容易就变得冗长,难以维护。
为了简化这个过程,我们来看看用 Optional 类是怎么做的。
从创建和验证实例,到使用其不同的方法,并与其它返回相同类型的方法相结合,下面是见证 Optional 奇迹的时刻。

# 创建Optional实例

back

调用empty API, 创建一个空的Optional对象;

@Test
public void whenCreatesEmptyOptional_thenCorrect() {
    Optional<String> empty = Optional.empty();
    assertFalse(empty.isPresent());
}
1
2
3
4
5

isPresent API 是用来检查Optional对象中是否有值。只有当我们创建了一个含有非空值的Optional时才返回true。

高能提醒

重申一下,这个类型的对象可能包含值,也可能为空。你可以使用同名方法创建一个空的 Optional。

@Test(expected = NoSuchElementException.class)
public void whenCreateEmptyOptional_thenNull() {
    Optional<AlarmBo> emptyOpt = Optional.empty();
    emptyOpt.get();
}
1
2
3
4
5

毫不奇怪,尝试访问 emptyOpt 变量的值会导致 NoSuchElementException
你可以使用 of()ofNullable() 方法创建包含值的 Optional。两个方法的不同之处在于如果你把 null 值作为参数传递进去,of() 方法会抛出 NullPointerException

@Test(expected = NullPointerException.class)
public void whenCreateOfEmptyOptional_thenNullPointerException() {
    Optional<User> opt = Optional.of(user);
}
1
2
3
4

你看,我们并没有完全摆脱 NullPointerException。因此,你应该明确对象不为 null 的时候使用 of()。
如果对象即可能是 null 也可能是非 null,你就应该使用 ofNullable() 方法:

Optional<User> opt = Optional.ofNullable(user);
1

# 返回默认值

back

Optional 类提供了 API 用以返回对象值,或者在对象为空的时候返回默认值。
这里你可以使用的第一个方法是 orElse(),它的工作方式非常直接,如果有值则返回该值,否则返回传递给它的参数值:

@Test
public void whenEmptyValue_thenReturnDefault() {
    User user = null;
    User user2 = new User("ffaith@gmail.com", "1234");
    User result = Optional.ofNullable(user).orElse(user2);

    assertEquals(user2.getEmail(), result.getEmail());
}
1
2
3
4
5
6
7
8

第二个同类型的 API 是 orElseGet() —— 其行为略有不同。
这个方法会在有值的时候返回值,如果没有值,它会执行作为参数传入的 Supplier(供应者) 函数式接口,并将返回其执行结果:

User result = Optional.ofNullable(user).orElseGet( () -> user2);
1

# 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");
}
1
2
3
4
5
6
7
8
9
10
11
12
13

上面的代码中,两种方法都调用了 createNewUser() 方法,这个方法会记录一个消息并返回 User 对象。
代码输出如下:

Using orElse
Creating New User
Using orElseGet
Creating New User
1
2
3
4

由此可见,当对象为空而返回默认对象时,行为并无差异。
我们接下来看一个类似的示例,但这里 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());
}
1
2
3
4
5
6
7
8

这次的输出:

Using orElse
Creating New User
Using orElseGet
1
2
3

这个示例中,两个 Optional 对象都包含非空值,两个方法都会返回对应的非空值。
不过,orElse() 方法仍然创建了 User 对象
与之相反,orElseGet() 方法不创建 User 对象
在执行较密集的调用时,比如调用 Web 服务或数据查询,这个差异会对性能产生重大影响。

# 返回异常orElseThrow()

back

除了 orElse() 和 orElseGet() 方法,Optional 还定义了 orElseThrow() API —— 它会在对象为空的时候抛出异常,而不是返回备选的值:

@Test(expected = IllegalArgumentException.class)
public void whenThrowException_thenOk() {
    User result = Optional.ofNullable(user)
      .orElseThrow( () -> new IllegalArgumentException());
}
1
2
3
4
5

这里,如果 user 值为 null,会抛出 IllegalArgumentException
这个方法让我们有更丰富的语义,可以决定抛出什么样的异常,而不总是抛出 NullPointerException。
现在我们已经很好地理解了如何使用 Optional,我们来看看其它可以对 Optional 值进行转换和过滤的方法。

# 使用isPresent()检查值

back

我们可以使用这个API检查一个Optional对象中是否有值,只有值非空才返回true。

@Test
public void whenOptionalFilterWorks_thenCorrect() {
    Integer year = 2016;
    Optional<Integer> yearOptional = Optional.of(year);
    boolean is2016 = yearOptional.filter(y -> y == 2016).isPresent();
    assertTrue(is2016);
    boolean is2017 = yearOptional.filter(y -> y == 2017).isPresent();
    assertFalse(is2017);
}
1
2
3
4
5
6
7
8
9

# 使用get()

back

@Test
public void givenOptional_whenGetsValue_thenCorrect() {
    Optional<String> opt = Optional.of("baeldung");
    String name = opt.get();

    assertEquals("baeldung", name);
}
1
2
3
4
5
6
7

使用get() API 也可以返回被包裹着的值。但是必须是值存在时,当值不存在时,它会抛出一个NoSuchElementException异常,如下所示:

@Test(expected = NoSuchElementException.class)
public void givenOptionalWithNull_whenGetThrowsException_thenCorrect() {
    Optional<String> opt = Optional.ofNullable(null);
    String name = opt.get();
}
1
2
3
4
5

因为这个方法与我们使用Optional的目的相违背,所以可以预见在不久将来它或许会被抛弃,建议还是使用其他的方法。

# filter()

back

接收一个函数式接口,当符合接口时,则返回一个Optional对象,否则返回一个空的Optional对象。

这个API作用一般就是拒绝掉不符合条件的,比如拒绝掉错误的电子邮箱.
以下更有意义的一个实例:

/**
     - 测试年龄是否在范围内(18-29)
     */
    @Test
    public void testPersonAge(){
        assertTrue(ageInRange(18,29,new PersonModel("1",26,"2")));
        System.out.println("在");
        assertFalse(ageInRange(18,29,new PersonModel("1",36,"2")));
        assertFalse(ageInRange(18,29,null));
        assertFalse(ageInRange(18,29,new PersonModel("1",null,"2")));
    }

    public boolean ageInRange(Integer minAge, Integer maxAge, PersonModel personModel){
        return Optional.ofNullable(personModel)
                .map(PersonModel::getAge)
                .filter(age->age>= minAge)
                .filter(age->age<=maxAge).isPresent();
    }
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

温馨提示

map()仅仅是将一个值转换为另一个值,请谨记在心,这个操作并不会改变原来的值。
让我们仔细看看这段代码,首先,当我们传入一个null时,不会发生任何问题。其次,我们在这段code所写的唯一逻辑就如同此方法名所描述。
filter()与map()一起使用可以做一些很强力的事情。

# flatmap()

back

有时我们可以使用flatmap()替换map(),二者不同之处在于,map()只有当值不被包裹时才进行转换,而flatmap()接受一个被包裹着的值并且在转换之前对其解包。