使用 Java 8 Optional 的正確姿勢

我們知道 Java 8 增加了一些很有用的 API, 其中一個就是 Optional. 如果對它不稍假探索, 只是輕描淡寫的認為它可以優雅的解決 NullPointException 的問題, 於是程式碼就開始這麼寫了

Optional<User> user = ...... 
if (user.isPresent()) {
    return user.getOrders();
} else {
    return Collections.emptyList();
}

那麼不得不說我們的思維仍然是在原地踏步, 只是本能的認為它不過是 User 例項的包裝, 這與我們之前寫成

User user = .....
if (user != null) {
    return user.getOrders();
} else {
    return Collections.emptyList();
}

實質上是沒有任何分別. 這就是我們將要講到的使用好 Java 8 Optional 型別的正確姿勢.

在里約奧運之時, 新聞一再提起五星紅旗有問題, 可是我怎麼看都看不出來有什麼問題, 後來才道是小星星膜拜中央的姿勢不對. 因此我們千萬也別對自己習以為常的事情覺得理所當然, 絲毫不會覺得有何不妥, 換句話說也就是當我們切換到 Java 8 的 Optional 時, 不能繼承性的對待過往 null 時的那種思維, 應該掌握好新的, 正確的使用 Java 8 Optional 的正確姿勢.

直白的講, 當我們還在以如下幾種方式使用 Optional 時, 就得開始檢視自己了

1. 呼叫 isPresent() 方法時
2. 呼叫 get() 方法時
3. Optional 型別作為類/例項屬性時
4. Optional 型別作為方法引數時

isPresent() 與 obj != null 無任何分別, 我們的生活依然在步步驚心. 而沒有 isPresent() 作鋪墊的 get() 呼叫在 IntelliJ IDEA 中會收到告警

Reports calls to java.util.Optional.get() without first checking with a isPresent() call if a value is available. If the Optional does not contain a value, get() will throw an exception. (呼叫 Optional.get() 前不事先用 isPresent() 檢查值是否可用. 假如 Optional 不包含一個值, get() 將會丟擲一個異常)

把 Optional 型別用作屬性或是方法引數在 IntelliJ IDEA 中更是強力不推薦的

Reports any uses of java.util.Optional<T>, java.util.OptionalDouble, java.util.OptionalInt, java.util.OptionalLong or com.google.common.base.Optional as the type for a field or a parameter. Optional was designed to provide a limited mechanism for library method return types where there needed to be a clear way to represent “no result”. Using a field with type java.util.Optional is also problematic if the class needs to be Serializable, which java.util.Optional is not. (使用任何像 Optional 的型別作為欄位或方法引數都是不可取的. Optional 只設計為類庫方法的, 可明確表示可能無值情況下的返回型別. Optional 型別不可被序列化, 用作欄位型別會出問題的)

所以 Optional 中我們真正可依賴的應該是除了 isPresent() 和 get() 的其他方法:

1. public<U> Optional<U> map(Function<? super T, ? extends U> mapper)
2. public T orElse(T other)
3. public T orElseGet(Supplier<? extends T> other)
4. public void ifPresent(Consumer<? super T> consumer)
5. public Optional<T> filter(Predicate<? super T> predicate)
6. public<U> Optional<U> flatMap(Function<? super T, Optional<U>> mapper)
7. public <X extends Throwable> T orElseThrow(Supplier<? extends X> exceptionSupplier) throws X

我略有自信的按照它們大概使用頻度對上面的方法排了一下序.

先又不得不提一下 Optional 的三種構造方式: Optional.of(obj),  Optional.ofNullable(obj) 和明確的 Optional.empty()

Optional.of(obj): 它要求傳入的 obj 不能是 null 值的, 否則還沒開始進入角色就倒在了 NullPointerException 異常上了.

Optional.ofNullable(obj): 它以一種智慧的, 寬容的方式來構造一個 Optional 例項. 來者不拒, 傳 null 進到就得到 Optional.empty(), 非 null 就呼叫 Optional.of(obj).

那是不是我們只要用 Optional.ofNullable(obj) 一勞永逸, 以不變應二變的方式來構造 Optional 例項就行了呢? 那也未必, 否則 Optional.of(obj) 何必如此暴露呢, 私有則可?

我本人的觀點是:  1. 當我們非常非常的明確將要傳給 Optional.of(obj) 的 obj 引數不可能為 null 時, 比如它是一個剛 new 出來的物件(Optional.of(new User(...))), 或者是一個非 null 常量時;  2. 當想為 obj 斷言不為 null 時, 即我們想在萬一 obj 為 null 立即報告 NullPointException 異常, 立即修改, 而不是隱藏空指標異常時, 我們就應該果斷的用 Optional.of(obj) 來構造 Optional 例項, 而不讓任何不可預計的 null 值有可乘之機隱身於 Optional 中.

現在才開始怎麼去使用一個已有的 Optional 例項, 假定我們有一個例項 Optional<User> user, 下面是幾個普遍的, 應避免 if(user.isPresent()) { ... } else { ... } 幾中應用方式.

存在即返回, 無則提供預設值

return user.orElse(null);  //而不是 return user.isPresent() ? user.get() : null;
return user.orElse(UNKNOWN_USER);

存在即返回, 無則由函式來產生

return user.orElseGet(() -> fetchAUserFromDatabase()); //而不要 return user.isPresent() ? user: fetchAUserFromDatabase();

存在才對它做點什麼

user.ifPresent(System.out::println);

//而不要下邊那樣
if (user.isPresent()) {
  System.out.println(user.get());
}

map 函式隆重登場

當 user.isPresent() 為真, 獲得它關聯的 orders, 為假則返回一個空集合時, 我們用上面的 orElse, orElseGet 方法都乏力時, 那原本就是 map 函式的責任, 我們可以這樣一行

return user.map(u -> u.getOrders()).orElse(Collections.emptyList())

//上面避免了我們類似 Java 8 之前的做法
if(user.isPresent()) {
  return user.get().getOrders();
} else {
  return Collections.emptyList();
}

map  是可能無限級聯的, 比如再深一層, 獲得使用者名稱的大寫形式

return user.map(u -> u.getUsername())
           .map(name -> name.toUpperCase())
           .orElse(null);

這要擱在以前, 每一級呼叫的展開都需要放一個 null 值的判斷

User user = .....
if(user != null) {
  String name = user.getUsername();
  if(name != null) {
    return name.toUpperCase();
  } else {
    return null;
  }
} else {
  return null;
}

針對這方面 Groovy 提供了一種安全的屬性/方法訪問操作符 ?.

user?.getUsername()?.toUpperCase();

Swift 也有類似的語法, 只作用在  Optional 的型別上.

用了 isPresent() 處理 NullPointerException 不叫優雅, 有了  orElse, orElseGet 等, 特別是 map 方法才叫優雅.

其他幾個, filter() 把不符合條件的值變為 empty(),  flatMap() 總是與 map() 方法成對的,  orElseThrow() 在有值時直接返回, 無值時丟擲想要的異常.

一句話小結: 使用 Optional 時儘量不直接呼叫 Optional.get() 方法, Optional.isPresent() 更應該被視為一個私有方法, 應依賴於其他像 Optional.orElse(), Optional.orElseGet(), Optional.map() 等這樣的方法.

最後, 最好的理解 Java 8 Optional 的方法莫過於看它的原始碼 java.util.Optional, 閱讀了原始碼才能真真正正的讓你解釋起來最有底氣, Optional 的方法中基本都是內部呼叫  isPresent() 判斷, 真時處理值, 假時什麼也不做.