Java 8 Optional類深度解析 - langtianya－IT工程師數位筆記本

文章出處

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

新版本的Java，比如Java 8引入了一個新的Optional類。Optional類的Javadoc描述如下：

這是一個可以為null的容器對象。如果值存在則isPresent()方法會返回true，調用get()方法會返回該對象。

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

為非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