Java Optional

为什么推出Optional

空指针异常(NullPointerException)空指针异常特别容易在调用对象的某个方法上,我们平常判空时,可能是以下

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 是 Java 实现函数式编程的强劲一步,并且帮助在范式中实现。但是 Optional 的意义显然不止于此。

optional的api

判断是否为空

1.of(T value ) 判断对象是否为空 空的话抛出异常,不为空则返回optional包装的对象

 /**
     * Returns an {@code Optional} describing the given non-{@code null}
     * value.
     *
     * @param value the value to describe, which must be non-{@code null}
     * @param <T> the type of the value
     * @return an {@code Optional} with the value present 返回optional包装的对象
     * @throws NullPointerException if value is {@code null} 空的话抛出异常
     */
    public static <T> Optional<T> of(T value) {
        return new Optional<>(Objects.requireNonNull(value));
    }

2.ofNullable(T value) 判断传入的值是否为空 不为空返回由Optional封装的对象,为空返回 调用empty()

/**
     * Returns an {@code Optional} describing the given value, if
     * non-{@code null}, otherwise returns an empty {@code Optional}.
     *
     * @param value the possibly-{@code null} value to describe
     * @param <T> the type of the value
     * @return an {@code Optional} with a present value if the specified value
     *         is non-{@code null}, otherwise an empty {@code Optional}
     */
    @SuppressWarnings("unchecked")
    public static <T> Optional<T> ofNullable(T value) {
        return value == null ? (Optional<T>) EMPTY
                             : new Optional<>(value);
    }

empty() 会返回一个null的Optional包装类,实质上是null

**

返回默认值

1.orElse(T other) Optional对象不为空,则直接返回对象,为空,则返回orElse()中的值

/*源码*/
 public T orElse(T other) {
        return value != null ? value : other;
    }
/**实战*/
@Test
public void whenEmptyValue_thenReturnDefault() {
    User user = null;
    User user2 = new User("[email protected]", "1234");
    User result = Optional.ofNullable(user).orElse(user2);

    assertEquals(user2.getEmail(), result.getEmail());
}
这里 user 对象是空的,所以返回了作为默认值的 user2。
如果对象的初始值不是 null,那么默认值会被忽略:

2. orElseGet() —— 其行为略有不同。这个方法会在有值的时候返回值,如果没有值,它会执行作为参数传入的 _Supplier(供应者) _函数式接口,并将返回其执行结果

/**源码*/
public T orElseGet(Supplier<? extends T> supplier) {
        return value != null ? value : supplier.get();
    }
/**实战*/
User result = Optional.ofNullable(user).orElseGet( () -> user2);

两者的异同

我们接下来看一个的示例,但这里 Optional 不为空:

@Test 
public void givenPresentValue_whenCompare_thenOk() {
User user = new User("[email protected]", "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 对象。 结论: 当Optional对象为空时,orElse(),orElseGet()都会执行括号中的方法, 当Optional对象不为空时,orElse()会执行括号中的方法,orElseGet()则不会执行

在执行较密集的调用时,比如调用 Web 服务或数据查询,这个差异会对性能产生重大影响。

返回异常

除了 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。

转换值

1.map(Function<? super T, ? extends U> mapper)

有很多种方法可以转换 Optional 的值。我们从** map()** 和 flatMap() 方法开始。先来看一个使用 map() API 的例子:

@Test
public void whenMap_thenOk() {
    User user = new User("[email protected]", "1234");
    String email = Optional.ofNullable(user)
      .map(u -> u.getEmail()).orElse("[email protected]");
    assertEquals(email, user.getEmail());
}

map() 对值应用(调用)作为参数的函数,然后将返回的值包装在 Optional 中。这就使对返回值进行链式调用的操作成为可能 —— 这里的下一环就是 orElse()。

2.flatMap(Function<? super T, ? extends Optional<? extends U>> mapper)

相比这下,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("[email protected]", "1234");
    user.setPosition("Developer");
    String position = Optional.ofNullable(user)
      .flatMap(u -> u.getPosition()).orElse("default");
    assertEquals(position, user.getPosition().get());
}

过滤值

除了转换值之外,Optional 类也提供了按条件“过滤”值的方法。 filter() 接受一个 Predicate 参数, 返回测试结果为 true ,则返回对应的值。如果测试结果为 false,会返回一个空的 Optional。

来看一个根据基本的电子邮箱验证来决定接受或拒绝 User(用户) 的示例:

@Test
public void whenFilter_thenOk() {
    User user = new User("[email protected]", "1234");
    Optional<User> result = Optional.ofNullable(user)
      .filter(u -> u.getEmail() != null && u.getEmail().contains("@"));
    assertTrue(result.isPresent());
}

如果通过过滤器测试,result 对象会包含非空值。

总结

Optional 是 Java 语言的有益补充 —— 它旨在减少代码中的 NullPointerExceptions,虽然还不能完全消除这些异常。它也是精心设计,自然融入 Java 8 函数式支持的功能。总的来说,这个简单而强大的类有助于创建简单、可读性更强、比对应程序错误更少的程序。