Java8 中的真的 Optional 很強大，你用對了嗎？
點擊上方“碼農(nóng)突圍”，馬上關(guān)注
這里是碼農(nóng)充電第一站，回復(fù)“666”，獲取一份專屬大禮包 真愛，請設(shè)置“星標(biāo)”或點個“在看
來源：oschina.net/dzone.com/articles/understanding-accepting-and-leveraging-optional-in
從 Java 8 引入的一個很有趣的特性是 Optional 類。Optional 類主要解決的問題是臭名昭著的空指針異常（NullPointerException） —— 每個 Java 程序員都非常了解的異常。本質(zhì)上，這是一個包含有可選值的包裝類，這意味著 Optional 類既可以含有對象也可以為空。
Optional 是 Java 實現(xiàn)函數(shù)式編程的強勁一步，并且?guī)椭诜妒街袑崿F(xiàn)。但是 Optional 的意義顯然不止于此。
我們從一個簡單的用例開始。在 Java 8 之前，任何訪問對象方法或?qū)傩缘恼{(diào)用都可能導(dǎo)致 NullPointerException：
String isocode = user.getAddress().getCountry().getIsocode().toUpperCase();
在這個小示例中，如果我們需要確保不觸發(fā)異常，就得在訪問每一個值之前對其進(jìn)行明確地檢查：
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();
}
}
}
}
你看到了，這很容易就變得冗長，難以維護(hù)。
為了簡化這個過程，我們來看看用 Optional 類是怎么做的。從創(chuàng)建和驗證實例，到使用其不同的方法，并與其它返回相同類型的方法相結(jié)合，下面是見證 Optional 奇跡的時刻。
創(chuàng)建 Optional 實例
重申一下，這個類型的對象可能包含值，也可能為空。你可以使用同名方法創(chuàng)建一個空的 Optional。
@Test(expected = NoSuchElementException.class)
public void whenCreateEmptyOptional_thenNull() {
Optional<User> emptyOpt = Optional.empty();
emptyOpt.get();
}
毫不奇怪，嘗試訪問 emptyOpt 變量的值會導(dǎo)致 NoSuchElementException。
你可以使用 of() 和 ofNullable() 方法創(chuàng)建包含值的 Optional。兩個方法的不同之處在于如果你把 null 值作為參數(shù)傳遞進(jìn)去，of() 方法會拋出 NullPointerException：
@Test(expected = NullPointerException.class)
public void whenCreateOfEmptyOptional_thenNullPointerException() {
Optional<User> opt = Optional.of(user);
}
你看，我們并沒有完全擺脫 NullPointerException。因此，你應(yīng)該明確對象不為 null 的時候使用 of()。
如果對象即可能是 null 也可能是非 null，你就應(yīng)該使用 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("[email protected]", "1234");
Optional<User> opt = Optional.ofNullable(user);
assertTrue(opt.isPresent());
assertEquals(user.getEmail(), opt.get().getEmail());
}
檢查是否有值的另一個選擇是 ifPresent() 方法。該方法除了執(zhí)行檢查，還接受一個Consumer(消費者) 參數(shù)，如果對象不是空的，就對執(zhí)行傳入的 Lambda 表達(dá)式：
opt.ifPresent( u -> assertEquals(user.getEmail(), u.getEmail()));
這個例子中，只有 user 用戶不為 null 的時候才會執(zhí)行斷言。
接下來，我們來看看提供空值的方法。
返回默認(rèn)值
Optional 類提供了 API 用以返回對象值，或者在對象為空的時候返回默認(rèn)值。
這里你可以使用的第一個方法是 orElse()，它的工作方式非常直接，如果有值則返回該值，否則返回傳遞給它的參數(shù)值：
@Test
public void whenEmptyValue_thenReturnDefault() {
User user = null;
User user2 = new User("[email protected]", "1234");
User result = Optional.ofNullable(user).orElse(user2);
assertEquals(user2.getEmail(), result.getEmail());
}
這里 user 對象是空的，所以返回了作為默認(rèn)值的 user2。
如果對象的初始值不是 null，那么默認(rèn)值會被忽略：
@Test
public void whenValueNotNull_thenIgnoreDefault() {
User user = new User("[email protected]","1234");
User user2 = new User("[email protected]", "1234");
User result = Optional.ofNullable(user).orElse(user2);
assertEquals("[email protected]", result.getEmail());
}
第二個同類型的 API 是 orElseGet() —— 其行為略有不同。這個方法會在有值的時候返回值，如果沒有值，它會執(zhí)行作為參數(shù)傳入的 Supplier(供應(yīng)者) 函數(shù)式接口，并將返回其執(zhí)行結(jié)果：
User result = Optional.ofNullable(user).orElseGet( () -> user2);
orElse() 和 orElseGet() 的不同之處
乍一看，這兩種方法似乎起著同樣的作用。然而事實并非如此。我們創(chuàng)建一些示例來突出二者行為上的異同。
我們先來看看對象為空時他們的行為：
@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("[email protected]", "1234");
}
上面的代碼中，兩種方法都調(diào)用了 createNewUser() 方法，這個方法會記錄一個消息并返回 User 對象。
代碼輸出如下：
Using orElse
Creating New User
Using orElseGet
Creating New User
由此可見，當(dāng)對象為空而返回默認(rèn)對象時，行為并無差異。
我們接下來看一個類似的示例，但這里 Optional 不為空：
@Testpublic void givenPresentValue_whenCompare_thenOk() { User user = new User("[email protected]", "1234"); logger.info("Using orElse"); User result = Optional.ofNullable(user).orElse(createNewUser()); logger.info("Using orElseGet"); User result2 = Optional.ofNullable(user).orElseGet(() -> createNewUser());}
這次的輸出：
Using orElseCreating New UserUsing orElseGet
這個示例中，兩個 Optional 對象都包含非空值，兩個方法都會返回對應(yīng)的非空值。不過，orElse() 方法仍然創(chuàng)建了 User 對象。與之相反，orElseGet() 方法不創(chuàng)建 User 對象。
在執(zhí)行較密集的調(diào)用時，比如調(diào)用 Web 服務(wù)或數(shù)據(jù)查詢，這個差異會對性能產(chǎn)生重大影響。
返回異常
除了 orElse() 和 orElseGet() 方法，Optional 還定義了 orElseThrow() API —— 它會在對象為空的時候拋出異常，而不是返回備選的值：
@Test
public void givenPresentValue_whenCompare_thenOk() {
User user = new User("[email protected]", "1234");
logger.info("Using orElse");
User result = Optional.ofNullable(user).orElse(createNewUser());
logger.info("Using orElseGet");
User result2 = Optional.ofNullable(user).orElseGet(() -> createNewUser());
}
這里，如果 user 值為 null，會拋出 IllegalArgumentException。
這個方法讓我們有更豐富的語義，可以決定拋出什么樣的異常，而不總是拋出 NullPointerException。
現(xiàn)在我們已經(jīng)很好地理解了如何使用 Optional，我們來看看其它可以對 Optional 值進(jìn)行轉(zhuǎn)換和過濾的方法。
轉(zhuǎn)換值
有很多種方法可以轉(zhuǎn)換 Optional 的值。我們從 map() 和 flatMap() 方法開始。
先來看一個使用 map() API 的例子：
@Test
public void whenMap_thenOk() {
User user = new User("[email protected]", "1234");
String email = Optional.ofNullable(user)
.map(u -> u.getEmail()).orElse("[email protected]");
assertEquals(email, user.getEmail());
}
map() 對值應(yīng)用(調(diào)用)作為參數(shù)的函數(shù)，然后將返回的值包裝在 Optional 中。這就使對返回值進(jìn)行鏈試調(diào)用的操作成為可能 —— 這里的下一環(huán)就是 orElse()。
相比這下，flatMap() 也需要函數(shù)作為參數(shù)，并對值調(diào)用這個函數(shù)，然后直接返回結(jié)果。
下面的操作中，我們給 User 類添加了一個方法，用來返回 Optional：
public class User {
private String position;
public Optional<String> getPosition() {
return Optional.ofNullable(position);
}
//...
}
既然 getter 方法返回 String 值的 Optional，你可以在對 User 的 Optional 對象調(diào)用 flatMap() 時，用它作為參數(shù)。其返回的值是解除包裝的 String 值：
@Test
public void whenFlatMap_thenOk() {
User user = new User("[email protected]", "1234");
user.setPosition("Developer");
String position = Optional.ofNullable(user)
.flatMap(u -> u.getPosition()).orElse("default");
assertEquals(position, user.getPosition().get());
}
過濾值
除了轉(zhuǎn)換值之外，Optional 類也提供了按條件“過濾”值的方法。
filter() 接受一個 Predicate 參數(shù)，返回測試結(jié)果為 true 的值。如果測試結(jié)果為 false，會返回一個空的 Optional。
來看一個根據(jù)基本的電子郵箱驗證來決定接受或拒絕 User(用戶) 的示例：
@Test
public void whenFilter_thenOk() {
User user = new User("[email protected]", "1234");
Optional<User> result = Optional.ofNullable(user)
.filter(u -> u.getEmail() != null && u.getEmail().contains("@"));
assertTrue(result.isPresent());
}
如果通過過濾器測試，result 對象會包含非空值。
Optional 類的鏈?zhǔn)椒椒?/h2>
為了更充分的使用 Optional，你可以鏈接組合其大部分方法，因為它們都返回相同類似的對象。
我們使用 Optional 重寫最早介紹的示例。
首先，重構(gòu)類，使其 getter 方法返回 Optional 引用：
public class User {
private Address address;
public Optional<Address> getAddress() {
return Optional.ofNullable(address);
}
// ...
}
public class Address {
private Country country;
public Optional<Country> getCountry() {
return Optional.ofNullable(country);
}
// ...
}
上面的嵌套結(jié)構(gòu)可以用下面的圖來表示：
圖片
現(xiàn)在可以刪除 null 檢查，替換為 Optional 的方法：
@Test
public void whenChaining_thenOk() {
User user = new User("[email protected]", "1234");
String result = Optional.ofNullable(user)
.flatMap(u -> u.getAddress())
.flatMap(a -> a.getCountry())
.map(c -> c.getIsocode())
.orElse("default");
assertEquals(result, "default");
}
上面的代碼可以通過方法引用進(jìn)一步縮減：
String result = Optional.ofNullable(user)
.flatMap(User::getAddress)
.flatMap(Address::getCountry)
.map(Country::getIsocode)
.orElse("default");
結(jié)果現(xiàn)在的代碼看起來比之前采用條件分支的冗長代碼簡潔多了。
Java 9 增強
我們介紹了 Java 8 的特性，Java 9 為 Optional 類添加了三個方法：or()、ifPresentOrElse() 和 stream()。
or() 方法與 orElse() 和 orElseGet() 類似，它們都在對象為空的時候提供了替代情況。or() 的返回值是由 Supplier 參數(shù)產(chǎn)生的另一個 Optional 對象。
如果對象包含值，則 Lambda 表達(dá)式不會執(zhí)行：
@Test
public void whenEmptyOptional_thenGetValueFromOr() {
User result = Optional.ofNullable(user)
.or( () -> Optional.of(new User("default","1234"))).get();
assertEquals(result.getEmail(), "default");
}
上面的示例中，如果 user 變量是 null，它會返回一個 Optional，它所包含的 User 對象，其電子郵件為 “default”。
ifPresentOrElse() 方法需要兩個參數(shù)：一個 Consumer 和一個 Runnable。如果對象包含值，會執(zhí)行 Consumer 的動作，否則運行 Runnable。
如果你想在有值的時候執(zhí)行某個動作，或者只是跟蹤是否定義了某個值，那么這個方法非常有用：
Optional.ofNullable(user).ifPresentOrElse( u -> logger.info("User is:" + u.getEmail()),
() -> logger.info("User not found"));
最后介紹的是新的 stream() 方法，它通過把實例轉(zhuǎn)換為 Stream 對象，讓你從廣大的 Stream API 中受益。如果沒有值，它會得到空的 Stream；有值的情況下，Stream 則會包含單一值。
我們來看一個把 Optional 處理成 Stream 的例子：
@Test
public void whenGetStream_thenOk() {
User user = new User("[email protected]", "1234");
List<String> emails = Optional.ofNullable(user)
.stream()
.filter(u -> u.getEmail() != null && u.getEmail().contains("@"))
.map( u -> u.getEmail())
.collect(Collectors.toList());
assertTrue(emails.size() == 1);
assertEquals(emails.get(0), user.getEmail());
}
這里對 Stream 的使用帶來了其 filter()、map() 和 collect() 接口，以獲取 List。
Optional 應(yīng)該怎樣用？
在使用 Optional 的時候需要考慮一些事情，以決定什么時候怎樣使用它。
重要的一點是 Optional 不是 Serializable。因此，它不應(yīng)該用作類的字段。
如果你需要序列化的對象包含 Optional 值，Jackson 庫支持把 Optional 當(dāng)作普通對象。也就是說，Jackson 會把空對象看作 null，而有值的對象則把其值看作對應(yīng)域的值。這個功能在 jackson-modules-java8 項目中。
它在另一種情況下也并不怎么有用，就是在將其類型用作方法或構(gòu)建方法的參數(shù)時。這樣做會讓代碼變得復(fù)雜，完全沒有必要：
User user = new User("[email protected]", "1234", Optional.empty());
使用重載方法來處理非要的參數(shù)要容易得多。
Optional 主要用作返回類型。在獲取到這個類型的實例后，如果它有值，你可以取得這個值，否則可以進(jìn)行一些替代行為。
Optional 類有一個非常有用的用例，就是將其與流或其它返回 Optional 的方法結(jié)合，以構(gòu)建流暢的API。
我們來看一個示例，使用 Stream 返回 Optional 對象的 findFirst() 方法：
@Test
public void whenEmptyStream_thenReturnDefaultOptional() {
List<User> users = new ArrayList<>();
User user = users.stream().findFirst().orElse(new User("default", "1234"));
assertEquals(user.getEmail(), "default");
}
總結(jié)
Optional 是 Java 語言的有益補充 —— 它旨在減少代碼中的 NullPointerExceptions，雖然還不能完全消除這些異常。
它也是精心設(shè)計，自然融入 Java 8 函數(shù)式支持的功能。
總的來說，這個簡單而強大的類有助于創(chuàng)建簡單、可讀性更強、比對應(yīng)程序錯誤更少的程序。
- END - 最近熱文
? 身家破億！86版「紅孩兒」拒絕出道成學(xué)霸，已是中科院博士，名下52家公司 ? 96年出生，他已經(jīng)發(fā)了 8 篇 Nature論文！ ? 靈隱寺招聘：沒有KPI，佛系上班…… ? 工程師在工作電腦存 64G 不雅文件，被公司開除后索賠 41 萬，結(jié)果…