java Optional

理解、學習與使用 JAVA 中的 OPTIONAL

從 Java 8 引入的一個很有趣的特性是 Optional  類。Optional 類主要解決的問題是臭名昭著的空指針異常(NullPointerException) —— 每個 Java 程序員都非常瞭解的異常。

本質上,這是一個包含有可選值的包裝類,這意味着 Optional 類既可以含有對象也可以爲空。

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

我們從一個簡單的用例開始。在 Java 8 之前,任何訪問對象方法或屬性的調用都可能導致 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  奇蹟的時刻。

創建 Optional  實例

三種創建方法以及區別

1.創建一個空的 Optional嘗試訪問 opt 變量的值會導致 NoSuchElementException

@Test
public void test1() {
    Optional<User> opt = Optional.empty();
    opt.get();
}
2.使用ofNullable()方法創建包含值的 Optional。如果你把null值作爲參數傳遞進去,ofNullable() 方法會導致 NoSuchElementException。 
@Test
public void test2(){
    User user = null;
    Optional<User> opt = Optional.ofNullable(user);
    opt.get();
}
3.使用of()方法創建包含值的 Optional。如果你把null值作爲參數傳遞進去,of() 方法會拋出 NullPointerException: 
@Test()
public void test3(){
    User user = null;
    Optional<User> opt = Optional.of(user);
    opt.get();
}

你看,我們並沒有完全擺脫 NullPointerException。因此,你應該明確對象不爲 null  的時候使用 of()

如果對象即可能是 null 也可能是非 null,你就應該使用 ofNullable() 方法:

訪問 Optional 對象的值

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

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

@Test
public void test4(){
    User user = new User("1",11,"111");
    Optional<User> opt = Optional.of(user);
    assertTrue(opt.isPresent());
    assertEquals("1",opt.get().getName());
}

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

opt.ifPresent(u -> assertEquals(user.getName(),u.getName()));

返回默認值

Optional 類提供了 API 用以返回對象值,或者在對象爲空的時候返回默認值。

這裏你可以使用的第一個方法是 orElse(),它的工作方式非常直接,如果有值則返回該值,否則返回傳遞給它的參數值:

@Test
public void test6(){
    User user1 = null;
    User user2 = new User("1",11,"111");
    User result = Optional.ofNullable(user1).orElse(user2);
    assertEquals(user2.getName(),result.getName());
}

這裏 user1 對象是空的,所以返回了作爲默認值的 user2

如果對象的初始值不是 null,那麼默認值會被忽略:

@Test
public void test7(){
    User user1 = new User("1",11,"111");
    User user2 = new User("2",22,"222");
    User result = Optional.ofNullable(user1).orElse(user2);
    assertEquals("1",result.getName());
}

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

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

orElse() 和 orElseGet() 的不同之處

乍一看,這兩種方法似乎起着同樣的作用。然而事實並非如此。我們創建一些示例來突出二者行爲上的異同。

我們先來看看對象爲空時他們的行爲:

private User createNewUser() {
    System.out.println("Creating New User");
    return  new User("1",11,"111");
}
@Test
public void test8(){
    User user = null;
    System.out.println("Using orElse");
    User result = Optional.ofNullable(user).orElse(createNewUser());
    System.out.println("Using orElseGet");
    User result2 = Optional.ofNullable(user).orElseGet(() -> createNewUser());
    System.out.println(result);
    System.out.println(result2);
}

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

代碼輸出如下:

Using orElse
Creating New User
Using orElseGet
Creating New User

由此可見,當對象爲空而返回默認對象時,行爲並無差異。

我們接下來看一個類似的示例,但這裏 Optional  不爲空:

User user =  new User("1",11,"111");
System.out.println("Using orElse");
User result = Optional.ofNullable(user).orElse(createNewUser());
System.out.println("Using orElseGet");
User result2 = Optional.ofNullable(user).orElseGet(() -> createNewUser());

這次的輸出:

Using orElse
Creating New User
Using orElseGet

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

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

返回異常

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

@Test()
public void test10() {
    User user = null;
    User result = Optional.ofNullable(user)
            .orElseThrow( () -> new IllegalArgumentException());
}

這裏,如果 user 值爲 null,會拋出 IllegalArgumentException

這個方法讓我們有更豐富的語義,可以決定拋出什麼樣的異常,而不總是拋出 NullPointerException

現在我們已經很好地理解了如何使用 Optional,我們來看看其它可以對 Optional 值進行轉換和過濾的方法。

轉換值

有很多種方法可以轉換 Optional  的值。我們從 map() 和 flatMap() 方法開始。

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

@Test()
public void test11() {
    User user = new User("1",11,"111");
    String name = Optional.ofNullable(user).map( u -> u.getName()).orElse("2");
    assertEquals(user.getName(),name);
}

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 值:

@Test()
public void test12() {
    User user = new User("1",11,"111");
    user.setPosition("1111");
    String position = Optional.ofNullable(user).flatMap( u -> u.getPosition()).orElse("2222");
    assertEquals(position,user.getPosition().get());
}

過濾值

除了轉換值之外,Optional  類也提供了按條件“過濾”值的方法。

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

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

@Test
public void test13() {
    User user = new User("1",11,"111");
    Optional<User> result = Optional.ofNullable(user)
            .filter(u -> u.getCreateTime() != null && u.getCreateTime().contains("11"));
    assertTrue(result.isPresent());
}

如果通過過濾器測試,result 對象會包含非空值。

Optional 類的鏈式方法

爲了更充分的使用 Optional,你可以鏈接組合其大部分方法,因爲它們都返回相同類似的對象。

我們使用 Optional  重寫最早介紹的示例。

首先,重構類,使其 getter 方法返回 Optional 引用:

@Data
public class User {
    private String position;
    private Integer id;
    private String name;
    private Integer departmentId;
    private String createTime;
    private Address address;
    public User(String name, Integer departmentId, String createTime) {
        this.name = name;
        this.departmentId = departmentId;
        this.createTime = createTime;
    }
    public User() {
    }
    public Optional<String> getPosition() {
        return Optional.ofNullable(position);
    }
    public Optional<Address> getAddress(){
        return Optional.ofNullable(address);
    }
}
public class Address {
    private Country country;
    public Optional<Country> getCountry() {
        return Optional.ofNullable(country);
    }
}
@Data
public class Country {
    private String isoCode;
}

上面的嵌套結構可以用下面的圖來表示:

optional nested

現在可以刪除 null 檢查,替換爲 Optional 的方法:

@Test
public void test14(){
    User user = new User("1",11,"111");
    String result = Optional.ofNullable(user)
            .flatMap(u -> u.getAddress())
            .flatMap(a -> a.getCountry())
            .map(c -> c.getIsoCode())
            .orElse("default");
    assertEquals("default",result);
}

   結果現在的代碼看起來比之前採用條件分支的冗長代碼簡潔多了。

發佈了45 篇原創文章 · 獲贊 36 · 訪問量 18萬+
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章