【java笔记】Optional类的orElse() 和 orElseGet()

清疚 2024-03-23 23:20 76阅读 0赞

> **`Optional` 类是从 `Java 8` 引入的新特性，主要解决的问题是臭名昭著的空指针异常`NullPointerException` 。本质上，这是一个包含有可选值的包装类，这意味着 Optional 类既可以含有对象也可以为空。**

## 1. 问题 ##

在 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();
                }
            }
        }
    }

这很容易就变得冗长，难以维护。

## 2. Optiona类 ##

为了简化这个过程，java8 提供了 Optional 类。

#### **创建 Optional 实例** ####

@Test(expected = NoSuchElementException.class)
    public void whenCreateEmptyOptional_thenNull() {
        
        Optional<User> emptyOpt = Optional.empty();
        emptyOpt.get();
    }

Optional 类型的对象可能包含值，也可能为空。尝试访问 emptyOpt 变量的值会导致 `NoSuchElementException`。

可以使用 `of()`和`ofNullable()`方法创建包含值的 Optional。两个方法的不同之处在于如果你把 null 值作为参数传递进去，`of()` 方法会抛出 `NullPointerException`：

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

因此，应该明确对象不为 null 的时候使用`of()`。  
如果对象即可能是 null 也可能是非 null，你就应该使用`ofNullable()`方法：

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

#### 访问 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 的时候才会执行断言。

#### 返回默认值 ####

`Optional` 类提供了 API 用以返回对象值，或者**在对象为空的时候返回默认值**的方法。

1.  第一个方法是 `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());
    }

1.  第二个方法是 `orElseGet()` ，在有值的时候返回值，如果没有值，它会执行作为参数传入的 `Supplier`(供应者) 函数式接口，并将返回其执行结果：

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

**注意**：`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 服务或数据查询，这个差异会对性能产生重大影响。

*  返回异常时  
    除了 `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`。

> 文章大量参考 [https://zhuanlan.zhihu.com/p/443039222?utm\_id=0][https_zhuanlan.zhihu.com_p_443039222_utm_id_0]

[https_zhuanlan.zhihu.com_p_443039222_utm_id_0]: https://zhuanlan.zhihu.com/p/443039222?utm_id=0