Optional類深度解析

身為一名Java程式設計師，大家可能都有這樣的經歷：呼叫一個方法得到了返回值卻不能直接將返回值作為引數去呼叫別的方法。我們首先要判斷這個返回值是否為null，只有在非空的前提下才能將其作為其他方法的引數。這正是一些類似Guava的外部API試圖解決的問題。一些JVM程式語言比如Scala、Ceylon等已經將對在核心API中解決了這個問題。在我的前一篇文章中，介紹了Scala是如何解決了這個問題。
新版本的Java，比如Java 8引入了一個新的Optional類。Optional類的Javadoc描述如下：

這是一個可以為null的容器物件。如果值存在則isPresent()方法會返回true，呼叫get()方法會返回該物件。

本文會逐個探討Optional類包含的方法，並通過一兩個示例展示如何使用。
of

為非null的值建立一個Optional。

of方法通過工廠方法建立Optional類。需要注意的是，建立物件時傳入的引數不能為null。如果傳入引數為null，則丟擲NullPointerException 。

//呼叫工廠方法建立Optional例項
Optional<String> name = Optional.of("Sanaulla");
//傳入引數為null，丟擲NullPointerException.
Optional<String> someNull = Optional.of(null
 
);

ofNullable

為指定的值建立一個Optional，如果指定的值為null，則返回一個空的Optional。

ofNullable與of方法相似，唯一的區別是可以接受引數為null的情況。示例如下：

//下面建立了一個不包含任何值的Optional例項
//例如，值為'null'
Optional empty = Optional.ofNullable(null);

isPresent
非常容易理解

如果值存在返回true，否則返回false。

類似下面的程式碼：

//isPresent方法用來檢查Optional例項中是否包含值
if (name.isPresent()) {
  //在Optional例項內呼叫get()返回已存在的值
 

  System.out.println(name.get());//輸出Sanaulla
}

get

如果Optional有值則將其返回，否則丟擲NoSuchElementException。

上面的示例中，get方法用來得到Optional例項中的值。下面我們看一個丟擲NoSuchElementException的例子：

//執行下面的程式碼會輸出：No value present
try {
  //在空的Optional例項上呼叫get()，丟擲NoSuchElementException
  System.out.println(empty.get());
} catch (NoSuchElementException ex) {
  System.out.println(ex.getMessage());
}

*ifPresent

如果Optional例項有值則為其呼叫consumer，否則不做處理

要理解ifPresent方法，首先需要了解Consumer類。簡答地說，Consumer類包含一個抽象方法。該抽象方法對傳入的值進行處理，但沒有返回值。Java8支援不用介面直接通過lambda表示式傳入引數。
如果Optional例項有值，呼叫ifPresent()可以接受介面段或lambda表示式。類似下面的程式碼：

//ifPresent方法接受lambda表示式作為引數。
//lambda表示式對Optional的值呼叫consumer進行處理。
name.ifPresent((value) -> {
  System.out.println("The length of the value is: " + value.length());
});

orElse
如果有值則將其返回，否則返回指定的其它值。

如果Optional例項有值則將其返回，否則返回orElse方法傳入的引數。示例如下：

//如果值不為null，orElse方法返回Optional例項的值。
//如果為null，返回傳入的訊息。
//輸出：There is no value present!
System.out.println(empty.orElse("There is no value present!"));
//輸出：Sanaulla
System.out.println(name.orElse("There is some value!"));

orElseGet
orElseGet與orElse方法類似，區別在於得到的預設值。orElse方法將傳入的字串作為預設值，orElseGet方法可以接受Supplier介面的實現用來生成預設值。示例如下：

//orElseGet與orElse方法類似，區別在於orElse傳入的是預設值，
//orElseGet可以接受一個lambda表示式生成預設值。
//輸出：Default Value
System.out.println(empty.orElseGet(() -> "Default Value"));
//輸出：Sanaulla
System.out.println(name.orElseGet(() -> "Default Value"));

orElseThrow

如果有值則將其返回，否則丟擲supplier介面建立的異常。

在orElseGet方法中，我們傳入一個Supplier介面。然而，在orElseThrow中我們可以傳入一個lambda表示式或方法，如果值不存在來丟擲異常。示例如下：

try {
  //orElseThrow與orElse方法類似。與返回預設值不同，
  //orElseThrow會丟擲lambda表示式或方法生成的異常

  empty.orElseThrow(ValueAbsentException::new);
} catch (Throwable ex) {
  //輸出: No value present in the Optional instance
  System.out.println(ex.getMessage());
}
ValueAbsentException定義如下：

class ValueAbsentException extends Throwable {

  public ValueAbsentException() {
    super();
  }

  public ValueAbsentException(String msg) {
    super(msg);
  }

  @Override
  public String getMessage() {
    return "No value present in the Optional instance";
  }
}

map
map方法文件說明如下：

如果有值，則對其執行呼叫mapping函式得到返回值。如果返回值不為null，則建立包含mapping返回值的Optional作為map方法返回值，否則返回空Optional。

map方法用來對Optional例項的值執行一系列操作。通過一組實現了Function介面的lambda表示式傳入操作。如果你不熟悉Function介面，可以參考我的這篇部落格。map方法示例如下：

//map方法執行傳入的lambda表示式引數對Optional例項的值進行修改。
//為lambda表示式的返回值建立新的Optional例項作為map方法的返回值。
Optional<String> upperName = name.map((value) -> value.toUpperCase());
System.out.println(upperName.orElse("No value found"));

flatMap

如果有值，為其執行mapping函式返回Optional型別返回值，否則返回空Optional。flatMap與map（Funtion）方法類似，區別在於flatMap中的mapper返回值必須是Optional。呼叫結束時，flatMap不會對結果用Optional封裝。

flatMap方法與map方法類似，區別在於mapping函式的返回值不同。map方法的mapping函式返回值可以是任何型別T，而flatMap方法的mapping函式必須是Optional。
參照map函式，使用flatMap重寫的示例如下：

//flatMap與map（Function）非常類似，區別在於傳入方法的lambda表示式的返回型別。
//map方法中的lambda表示式返回值可以是任意型別，在map函式返回之前會包裝為Optional。
//但flatMap方法中的lambda表示式返回值必須是Optionl例項。
upperName = name.flatMap((value) -> Optional.of(value.toUpperCase()));
System.out.println(upperName.orElse("No value found"));//輸出SANAULLA

filter
filter個方法通過傳入限定條件對Optional例項的值進行過濾。文件描述如下：

如果有值並且滿足斷言條件返回包含該值的Optional，否則返回空Optional。

讀到這裡，可能你已經知道如何為filter方法傳入一段程式碼。是的，這裡可以傳入一個lambda表示式。對於filter函式我們應該傳入實現了Predicate介面的lambda表示式。如果你不熟悉Predicate介面，可以參考這篇文章。
現在我來看看filter的各種用法，下面的示例介紹了滿足限定條件和不滿足兩種情況：

//filter方法檢查給定的Option值是否滿足某些條件。
//如果滿足則返回同一個Option例項，否則返回空Optional。
Optional<String> longName = name.filter((value) -> value.length() > 6);
System.out.println(longName.orElse("The name is less than 6 characters"));//輸出Sanaulla

//另一個例子是Optional值不滿足filter指定的條件。
Optional<String> anotherName = Optional.of("Sana");
Optional<String> shortName = anotherName.filter((value) -> value.length() > 6);
//輸出：name長度不足6字元
System.out.println(shortName.orElse("The name is less than 6 characters"));

以上，我們介紹了Optional類的各個方法。下面通過一個完整的示例對用法集中展示：

public class OptionalDemo {

  public static void main(String[] args) {
    //建立Optional例項，也可以通過方法返回值得到。
    Optional<String> name = Optional.of("Sanaulla");

    //建立沒有值的Optional例項，例如值為'null'
    Optional empty = Optional.ofNullable(null);

    //isPresent方法用來檢查Optional例項是否有值。
    if (name.isPresent()) {
      //呼叫get()返回Optional值。
      System.out.println(name.get());
    }

    try {
      //在Optional例項上呼叫get()丟擲NoSuchElementException。
      System.out.println(empty.get());
    } catch (NoSuchElementException ex) {
      System.out.println(ex.getMessage());
    }

    //ifPresent方法接受lambda表示式引數。
    //如果Optional值不為空，lambda表示式會處理並在其上執行操作。
    name.ifPresent((value) -> {
      System.out.println("The length of the value is: " + value.length());
    });

    //如果有值orElse方法會返回Optional例項，否則返回傳入的錯誤資訊。
    System.out.println(empty.orElse("There is no value present!"));
    System.out.println(name.orElse("There is some value!"));

    //orElseGet與orElse類似，區別在於傳入的預設值。
    //orElseGet接受lambda表示式生成預設值。
    System.out.println(empty.orElseGet(() -> "Default Value"));
    System.out.println(name.orElseGet(() -> "Default Value"));

    try {
      //orElseThrow與orElse方法類似，區別在於返回值。
      //orElseThrow丟擲由傳入的lambda表示式/方法生成異常。
      empty.orElseThrow(ValueAbsentException::new);
    } catch (Throwable ex) {
      System.out.println(ex.getMessage());
    }

    //map方法通過傳入的lambda表示式修改Optonal例項預設值。
    //lambda表示式返回值會包裝為Optional例項。
    Optional<String> upperName = name.map((value) -> value.toUpperCase());
    System.out.println(upperName.orElse("No value found"));

    //flatMap與map（Funtion）非常相似，區別在於lambda表示式的返回值。
    //map方法的lambda表示式返回值可以是任何型別，但是返回值會包裝成Optional例項。
    //但是flatMap方法的lambda返回值總是Optional型別。
    upperName = name.flatMap((value) -> Optional.of(value.toUpperCase()));
    System.out.println(upperName.orElse("No value found"));

    //filter方法檢查Optiona值是否滿足給定條件。
    //如果滿足返回Optional例項值，否則返回空Optional。
    Optional<String> longName = name.filter((value) -> value.length() > 6);
    System.out.println(longName.orElse("The name is less than 6 characters"));

    //另一個示例，Optional值不滿足給定條件。
    Optional<String> anotherName = Optional.of("Sana");
    Optional<String> shortName = anotherName.filter((value) -> value.length() > 6);
    System.out.println(shortName.orElse("The name is less than 6 characters"));

  }

}

上述程式碼輸出如下：

Sanaulla
No value present
The length of the value is: 8
There is no value present!
Sanaulla
Default Value
Sanaulla
No value present in the Optional instance
SANAULLA
SANAULLA
Sanaulla
The name is less than 6 characters

引用：
引用原連結