Optional使用詳解

一，簡介

Opitonal是java8引入的一個新類，目的是爲了解決空指針異常問題。本質上，這是一個包含有可選值的包裝類，這意味着 Optional 類既能夠含有對象也能夠爲空。

Optional 是 Java 實現函數式編程的強勁一步，而且幫助在範式中實現。可是 Optional 的意義顯然不止於此。

二，Java8 以前，空指針異常判斷

java在使用對象過程當中，訪問任何方法或屬性均可能致使 NullPointerException：

好比String isocode = user.getAddress().getCountry().getIsocode().toUpperCase();
在這個小示例中，若是咱們須要確保不觸發異常，就得在訪問每個值以前對其進行明確地檢查：

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();
}
}
}
}

爲了簡化這個過程，咱們來看看用Optional類是怎麼作的。

三，Optional的使用

1，建立 Optional 實例
重申一下，這個類型的對象可能包含值，也可能爲空。你可使用同名方法建立一個空的 Optional。

Optional<User> emptyOpt = Optional.empty();
emptyOpt.get();

絕不奇怪，嘗試訪問 emptyOpt 變量的值會致使 NoSuchElementException。

你可使用 of() 和 ofNullable() 方法建立包含值的 Optional。兩個方法的不一樣之處在於若是你把 null 值做爲參數傳遞進去，of() 方法會拋出 NullPointerException：

Optional<User> opt = Optional.of(user);

所以，你應該明確對象不爲 null 的時候使用 of()。

若是對象便可能是 null 也多是非 null，你就應該使用 ofNullable() 方法：

Optional<User> opt = Optional.ofNullable(user);

2，訪問 Optional 對象的值

從 Optional 實例中取回實際值對象的方法之一是使用 get() 方法：

String name = "John";
Optional<String> opt = Optional.ofNullable(name);

assertEquals("John", opt.get());

不過，你看到了，這個方法會在值爲 null的時候拋出異常。要避免異常，你能夠選擇首先驗證是否有值：

User user = new User("john@gmail.com", "1234");
Optional<User> opt = Optional.ofNullable(user);
assertTrue(opt.isPresent());

assertEquals(user.getEmail(), opt.get().getEmail());

檢查是否有值的另外一個選擇是 ifPresent() 方法。該方法除了執行檢查，還接受一個Consumer(消費者) 參數，若是對象不是空的，就對執行傳入的 Lambda 表達式：

opt.ifPresent( u -> assertEquals(user.getEmail(), u.getEmail()));
這個例子中，只有 user 用戶不爲 null 的時候纔會執行斷言。

接下來，咱們來看看提供空值的方法。

3，返回默認值
Optional類提供了API用以返回對象值，或者在對象爲空的時候返回默認值：orElse()，
若是有值則返回該值，不然返回傳遞給它的參數值：

User user2 = new User("anna@gmail.com", "1234");
User result = Optional.ofNullable(user).orElse(user2);

assertEquals(user2.getEmail(), result.getEmail());

這裏 user 對象是空的，因此返回了做爲默認值的 user2。

若是對象的初始值不是 null，那麼默認值會被忽略：

User user = new User("john@gmail.com","1234");
User user2 = new User("anna@gmail.com", "1234");
User result = Optional.ofNullable(user).orElse(user2);

assertEquals("john@gmail.com", result.getEmail());

第二個同類型的 API 是 orElseGet() —— 其行爲略有不一樣。這個方法會在有值的時候返回值，若是沒有值，它會執行做爲參數傳入的 Supplier(供應者) 函數式接口，並將返回其執行結果：

User result = Optional.ofNullable(user).orElseGet( () -> user2);

4，orElse() 和 orElseGet() 的不一樣之處

乍一看，這兩種方法彷佛起着一樣的做用。然而事實並不是如此。咱們建立一些示例來突出兩者行爲上的異同。

咱們先來看看對象爲空時他們的行爲：

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("extra@gmail.com", "1234");
}

上面的代碼中，兩種方法都調用了 createNewUser() 方法，這個方法會記錄一個消息並返回 User 對象。

代碼輸出以下：

Using orElse
Creating New User
Using orElseGet
Creating New User
因而可知，當對象爲空而返回默認對象時，行爲並沒有差別。

 

咱們接下來看一個相似的示例，但這裏 Optional 不爲空：

@Test
public void givenPresentValue_whenCompare_thenOk() {
User user = new User("john@gmail.com", "1234");
logger.info("Using orElse");
User result = Optional.ofNullable(user).orElse(createNewUser());
logger.info("Using orElseGet");
User result2 = Optional.ofNullable(user).orElseGet(() -> createNewUser());
}
此次的輸出：

Using orElse
Creating New User
Using orElseGet
這個示例中，兩個 Optional 對象都包含非空值，兩個方法都會返回對應的非空值。不過，orElse() 方法仍然建立了 User 對象。與之相反，orElseGet() 方法不建立 User 對象。

在執行較密集的調用時，好比調用 Web 服務或數據查詢，這個差別會對性能產生重大影響。

 

5，返回異常
除了 orElse() 和 orElseGet() 方法，Optional 還定義了 orElseThrow() API —— 它會在對象爲空的時候拋出異常，而不是返回備選的值：

User result = Optional.ofNullable(user)
.orElseThrow( () -> new IllegalArgumentException());

這裏，若是 user 值爲 null，會拋出 IllegalArgumentException。

這個方法讓咱們有更豐富的語義，能夠決定拋出什麼樣的異常，而不老是拋出 NullPointerException。

如今咱們已經很好地理解了如何使用 Optional，咱們來看看其它能夠對 Optional 值進行轉換和過濾的方法。

6，轉換值
有不少種方法能夠轉換 Optional 的值。咱們從 map() 和 flatMap() 方法開始。

先來看一個使用 map() API 的例子：

User user = new User("anna@gmail.com", "1234");
String email = Optional.ofNullable(user)
.map(u -> u.getEmail()).orElse("default@gmail.com");

assertEquals(email, user.getEmail());

map() 對值應用(調用)做爲參數的函數，而後將返回的值包裝在 Optional 中。這就使對返回值進行鏈試調用的操做成爲可能 —— 這裏的下一環就是 orElse()。

相比這下，flatMap() 也須要函數做爲參數，並對值調用這個函數，而後直接返回結果。

下面的操做中，咱們給 User 類添加了一個方法，用來返回 Optional：

public class User {
private String position;

public Optional<String> getPosition() {
return Optional.ofNullable(position);
}

//...
}
既然 getter 方法返回 String 值的 Optional，你能夠在對 User 的 Optional 對象調用 flatMap() 時，用它做爲參數。其返回的值是解除包裝的 String 值：

User user = new User("anna@gmail.com", "1234");
user.setPosition("Developer");
String position = Optional.ofNullable(user)
.flatMap(u -> u.getPosition()).orElse("default");

assertEquals(position, user.getPosition().get());

 

7，過濾值

除了轉換值以外，Optional 類也提供了按條件「過濾」值的方法。

filter() 接受一個 Predicate 參數，返回測試結果爲 true 的值。若是測試結果爲 false，會返回一個空的 Optional。

來看一個根據基本的電子郵箱驗證來決定接受或拒絕 User(用戶) 的示例：

User user = new User("anna@gmail.com", "1234");
Optional<User> result = Optional.ofNullable(user)
.filter(u -> u.getEmail() != null && u.getEmail().contains("@"));

assertTrue(result.isPresent());

若是經過過濾器測試，result 對象會包含非空值。

8，Optional 類的鏈式方法
爲了更充分的使用 Optional，你能夠連接組合其大部分方法，由於它們都返回相同相似的對象。

咱們使用 Optional 重寫最先介紹的示例。

首先，重構類，使其 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);
}

// ...
}

如今能夠刪除 null 檢查，替換爲 Optional 的方法：

@Test
public void whenChaining_thenOk() {
User user = new User("anna@gmail.com", "1234");

String result = Optional.ofNullable(user)
.flatMap(u -> u.getAddress())
.flatMap(a -> a.getCountry())
.map(c -> c.getIsocode())
.orElse("default");

assertEquals(result, "default");
}
上面的代碼能夠經過方法引用進一步縮減：

String result = Optional.ofNullable(user)
.flatMap(User::getAddress)
.flatMap(Address::getCountry)
.map(Country::getIsocode)
.orElse("default");
結果如今的代碼看起來比以前採用條件分支的冗長代碼簡潔多了。

四，Java 9 加強
咱們介紹了 Java 8 的特性，Java 9 爲 Optional 類添加了三個方法：or()、ifPresentOrElse() 和 stream()。

or() 方法與 orElse() 和 orElseGet() 相似，它們都在對象爲空的時候提供了替代狀況。or() 的返回值是由 Supplier 參數產生的另外一個 Optional 對象。

若是對象包含值，則 Lambda 表達式不會執行：

User result = Optional.ofNullable(user)
.or( () -> Optional.of(new User("default","1234"))).get();

assertEquals(result.getEmail(), "default");

上面的示例中，若是 user 變量是 null，它會返回一個 Optional，它所包含的 User 對象，其電子郵件爲 「default」。

ifPresentOrElse() 方法須要兩個參數：一個 Consumer 和一個 Runnable。若是對象包含值，會執行 Consumer 的動做，不然運行 Runnable。

若是你想在有值的時候執行某個動做，或者只是跟蹤是否認義了某個值，那麼這個方法很是有用：

Optional.ofNullable(user).ifPresentOrElse( u -> logger.info("User is:" + u.getEmail()),
() -> logger.info("User not found"));


最後介紹的是新的 stream() 方法，它經過把實例轉換爲 Stream 對象，讓你從廣大的 Stream API 中受益。若是沒有值，它會獲得空的 Stream；有值的狀況下，Stream 則會包含單一值。

咱們來看一個把 Optional 處理成 Stream 的例子：

User user = new User("john@gmail.com", "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 應該怎樣用？
在使用 Optional 的時候須要考慮一些事情，以決定何時怎樣使用它。

重要的一點是 Optional 不是 Serializable。所以，它不該該用做類的字段。

若是你須要序列化的對象包含 Optional 值，Jackson 庫支持把 Optional 看成普通對象。也就是說，Jackson 會把空對象看做 null，而有值的對象則把其值看做對應域的值。這個功能在 jackson-modules-java8 項目中。

它在另外一種狀況下也並不怎麼有用，就是在將其類型用做方法或構建方法的參數時。這樣作會讓代碼變得複雜，徹底沒有必要：

User user = new User("john@gmail.com", "1234", Optional.empty());
使用重載方法來處理非要的參數要容易得多。

Optional 主要用做返回類型。在獲取到這個類型的實例後，若是它有值，你能夠取得這個值，不然能夠進行一些替代行爲。

Optional 類有一個很是有用的用例，就是將其與流或其它返回 Optional 的方法結合，以構建流暢的API。

咱們來看一個示例，使用 Stream 返回 Optional 對象的 findFirst() 方法：

List<User> users = new ArrayList<>();
User user = users.stream().findFirst().orElse(new User("default", "1234"));

assertEquals(user.getEmail(), "default");

總結

Optional 是 Java 語言的有益補充 —— 它旨在減小代碼中的 NullPointerExceptions，雖然還不能徹底消除這些異常。

它也是精心設計，天然融入 Java 8 函數式支持的功能。

總的來講，這個簡單而強大的類有助於建立簡單、可讀性更強、比對應程序錯誤更少的程序。