JDK8 新特性-Optional类用法详解

朴灿烈づ我的快乐病毒、 2023-10-16 14:52 114阅读 0赞

#### 一.概述 ####

NullPointerException相信每个JAVA程序员都不陌生，是JAVA应用程序中最常见的异常。之前，Google Guava项目曾提出用Optional类来包装对象从而解决NullPointerException。受此影响，JDK8的类中也引入了Optional类，在新版的SpringData Jpa和Spring Redis Data中都已实现了对该方法的支持。

#### 二.Optional类 ####

/**
 * A container object which may or may not contain a non-null value.
 * If a value is present, {@code isPresent()} will return {@code true} and
 * {@code get()} will return the value.
 *
 * @since 1.8
 */
 public final class Optional<T> {
 /**
 * Common instance for {@code empty()}.
 */
 private static final Optional<?> EMPTY = new Optional<>();
 
 /**
 * If non-null, the value; if null, indicates no value is present
 */
 private final T value;
 
 // 其他省略
 }

该方法的注释大致意思是：Optional是一个容器对象，它可能包含空值，也可能包含非空值。当属性value被设置时，isPesent()方法将返回true，并且get()方法将返回这个值。 该类支持泛型，即其属性value可以是任何对象的实例。

#### 三.Optional类的方法 ####

<table> 
 <thead> 
 <tr> 
 <th>序号</th> 
 <th>方法</th> 
 <th>方法说明</th> 
 </tr> 
 </thead> 
 <tbody> 
 <tr> 
 <td>1</td> 
 <td><code>private Optional()</code></td> 
 <td>无参构造，构造一个空Optional</td> 
 </tr> 
 <tr> 
 <td>2</td> 
 <td><code>private Optional(T value)</code></td> 
 <td>根据传入的非空value构建Optional</td> 
 </tr> 
 <tr> 
 <td>3</td> 
 <td><code>public static&lt;T&gt; Optional&lt;T&gt; empty()</code></td> 
 <td>返回一个空的Optional，该实例的value为空</td> 
 </tr> 
 <tr> 
 <td>4</td> 
 <td><code>public static &lt;T&gt; Optional&lt;T&gt; of(T value)</code></td> 
 <td>根据传入的非空value构建Optional，与Optional(T value)方法作用相同</td> 
 </tr> 
 <tr> 
 <td>5</td> 
 <td><code>public static &lt;T&gt; Optional&lt;T&gt; ofNullable(T value)</code></td> 
 <td>与of(T value)方法不同的是，ofNullable(T value)允许你传入一个空的value，当传入的是空值时其创建一个空Optional，当传入的value非空时，与of()作用相同</td> 
 </tr> 
 <tr> 
 <td>6</td> 
 <td><code>public T get()</code></td> 
 <td>返回Optional的值，如果容器为空，则抛出NoSuchElementException异常</td> 
 </tr> 
 <tr> 
 <td>7</td> 
 <td><code>public boolean isPresent()</code></td> 
 <td>判断当家Optional是否已设置了值</td> 
 </tr> 
 <tr> 
 <td>8</td> 
 <td><code>public void ifPresent(Consumer&lt;? super T&gt; consumer)</code></td> 
 <td>判断当家Optional是否已设置了值，如果有值，则调用Consumer函数式接口进行处理</td> 
 </tr> 
 <tr> 
 <td>9</td> 
 <td><code>public Optional&lt;T&gt; filter(Predicate&lt;? super T&gt; predicate)</code></td> 
 <td>如果设置了值，且满足Predicate的判断条件，则返回该Optional，否则返回一个空的Optional</td> 
 </tr> 
 <tr> 
 <td>10</td> 
 <td><code>public&lt;U&gt; Optional&lt;U&gt; map(Function&lt;? super T, ? extends U&gt; mapper)</code></td> 
 <td>如果Optional设置了value，则调用Function对值进行处理，并返回包含处理后值的Optional，否则返回空Optional</td> 
 </tr> 
 <tr> 
 <td>11</td> 
 <td><code>public&lt;U&gt; Optional&lt;U&gt; flatMap(Function&lt;? super T, Optional&lt;U&gt;&gt; mapper)</code></td> 
 <td>与map()方法类型，不同的是它的mapper结果已经是一个Optional，不需要再对结果进行包装</td> 
 </tr> 
 <tr> 
 <td>12</td> 
 <td><code>public T orElse(T other)</code></td> 
 <td>如果Optional值不为空，则返回该值，否则返回other</td> 
 </tr> 
 <tr> 
 <td>13</td> 
 <td><code>public T orElseGet(Supplier&lt;? extends T&gt; other)</code></td> 
 <td>如果Optional值不为空，则返回该值，否则根据other另外生成一个</td> 
 </tr> 
 <tr> 
 <td>14</td> 
 <td><code>public &lt;X extends Throwable&gt; T orElseThrow(Supplier&lt;? extends X&gt; exceptionSupplier)throws X</code></td> 
 <td>如果Optional值不为空，则返回该值，否则通过supplier抛出一个异常</td> 
 </tr> 
 </tbody> 
</table>

####  ####

#### 四.Optional类的方法举例 ####

**示例一：**

public static void main(String[] args) {
 　　Optional< String > fullName = Optional.ofNullable( null );
 　　System.out.println( "Full Name is set? " + fullName.isPresent() );
 　　System.out.println( "Full Name: " + fullName.orElseGet( () -> "[none]" ) );
 　　System.out.println( fullName.map( s -> "Hey " + s + "!" ).orElse( "Hey Stranger!" ) );
 }

运行结果：

Full Name is set? false
    Full Name: [none]
    Hey Stranger!

说明：

ifPresent()方法当Optional实例的值非空时返回true，否则返回false;
    orElseGet()方法当Optional包含非空值时返回该值，否则通过接收的function生成一个默认的；
    map()方法转换当前Optional的值，并返回一个新的Optional实例；
    orElse()方法与orElseGet方法相似，不同的是orElse()直接返回传入的默认值。

**示例二：**

修改示例一，使其生成一个非空值的Optional实例。

Optional< String > firstName = Optional.of( "Tom" );
 System.out.println( "First Name is set? " + firstName.isPresent() );
 System.out.println( "First Name: " + firstName.orElseGet( () -> "[none]" ) );
 System.out.println( firstName.map( s -> "Hey " + s + "!" ).orElse( "Hey Stranger!" ) );

运行结果：

First Name is set? true
    First Name: Tom
    Hey Tom!

可以清晰地看出与示例一的区别。这不但简洁了我们的代码，而且使我们的代码更便于阅读。

#### 五.Optional源码 ####

下面看一下例子中使用到的几个方法的源码：

public static <T> Optional<T> of(T value) {
 return new Optional<>(value);
 }

isPresent

public boolean isPresent() {
       return value != null;
    }

orElseGet

public T orElseGet(Supplier<? extends T> other) {
 return value != null ? value : other.get();
 }

orElse

public T orElse(T other) {
        return value != null ? value : other;
    }

#### 六.使用Optional避免空指针 ####

在我们日常开发过程中不可避免地会遇到空指针问题，在以前，出现空指针问题，我们通常需要进行调试等方式才能最终定位到具体位置，尤其是在分布式系统服务之间的调用，问题更难定位。在使用Optional后，我们可以将接受到的参数对象进行包装，比如，订单服务要调用商品服务的一个接口，并将商品信息通过参数传入，这时候，传入的商品参数可能直接传入的就是null，这时，商品方法可以使用Optional.of(T)对传入的对象进行包装，如果T为空，则会直接抛出空指针异常，我们看到异常信息就能立即知道发生空指针的原因是参数T为空；或者，当传入的参数为空时，我们可以使用Optional.orElse()或Optional.orElseGet()方法生成一个默认的实例，再进行后续的操作。

下面再看个具体例子：在User类中有个Address类，在Address类中有个Street类,Street类中有streetName属性，现在的需求是：根据传入的User实例，获取对应的streetName，如果User为null或Address为null或Street为null，返回“nothing found”，否则返回对应的streetName。

##### 1.普通方式 #####

@Data
    public class User {
        private String name;
        private Integer age;
        private Address address;
    }
    
    @Data
    public class Address {
        private Street street;
    }
    
    @Data
    public class Street {
        private String streetName;
        private Integer streetNo;}

public String getUserSteetName(User user) {
    
        if(null != user) {
    
            Address address = user.getAddress();
    
            if(null != address) {
    
                Street street = address.getStreet();
    
                if(null != street) {
                    return street.getStreetName();
                }
            }
        }
    
        return "nothing found";
    }

##### 2.使用Optional #####

在实现一中明显的问题是if判断层级太深，下面复用Optional改写：

@Data
 public class User {
 private String name;
 private Integer age;
 private Optional<Address> address = Optional.empty();
 }
 
 @Data
 public class Address {
 private Optional<Street> street = Optional.empty();
 }
 
 @Data
 public class Street {
 private String streetName;
 private Integer streetNo;
 }
 
 
 public String getUserSteetName(User user) {
 
 Optional<User> userOptional = Optional.ofNullable(user);
 final String streetName = userOptional.orElse(new User()).getAddress().orElse(new Address()).getStreet().orElse(new Street()).getStreetName();
 return StringUtils.isEmpty(streetName) ? "nothing found" : streetName;
 }

利用orElse()方法给定默认值的方式确保不会报空指针问题问题，同时也能实现需求。