JAVA中OPTIONAL的使用方法

這篇文章主要為大家展示了“JAVA中OPTIONAL的使用方法”，內(nèi)容簡(jiǎn)而易懂，條理清晰，希望能夠幫助大家解決疑惑，下面讓小編帶領(lǐng)大家一起研究并學(xué)習(xí)一下“JAVA中OPTIONAL的使用方法”這篇文章吧。

一、概述

本質(zhì)上，這是一個(gè)包含有可選值的包裝類，這意味著 Optional 類既可以含有對(duì)象也可以為空。

Optional 是 Java 實(shí)現(xiàn)函數(shù)式編程的強(qiáng)勁一步，并且?guī)椭诜妒街袑?shí)現(xiàn)。但是 Optional 的意義顯然不止于此。

我們從一個(gè)簡(jiǎn)單的用例開始。在 Java 8 之前，任何訪問(wèn)對(duì)象方法或?qū)傩缘恼{(diào)用都可能導(dǎo)致NullPointerException：

String isocode = user.getAddress().getCountry().getIsocode().toUpperCase();

在這個(gè)小示例中，如果我們需要確保不觸發(fā)異常，就得在訪問(wèn)每一個(gè)值之前對(duì)其進(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();
            }
        }
    }
}

你看到了，這很容易就變得冗長(zhǎng)，難以維護(hù)。

為了簡(jiǎn)化這個(gè)過(guò)程，我們來(lái)看看用Optional 類是怎么做的。從創(chuàng)建和驗(yàn)證實(shí)例，到使用其不同的方法，并與其它返回相同類型的方法相結(jié)合，下面是見(jiàn)證Optional 奇跡的時(shí)刻。

二、創(chuàng)建Optional 實(shí)例

重申一下，這個(gè)類型的對(duì)象可能包含值，也可能為空。你可以使用同名方法創(chuàng)建一個(gè)空的 Optional。

@Test(expected = NoSuchElementException.class)
public void whenCreateEmptyOptional_thenNull() {
    Optional<User> emptyOpt = Optional.empty();
    emptyOpt.get();
}

毫不奇怪，嘗試訪問(wèn)emptyOpt變量的值會(huì)導(dǎo)致NoSuchElementException。

你可以使用of()和 ofNullable() 方法創(chuàng)建包含值的Optional。兩個(gè)方法的不同之處在于如果你把null值作為參數(shù)傳遞進(jìn)去，of()方法會(huì)拋出NullPointerException：

@Test(expected = NullPointerException.class)
public void whenCreateOfEmptyOptional_thenNullPointerException() {
    Optional<User> opt = Optional.of(user);
}

你看，我們并沒(méi)有完全擺脫NullPointerException。因此，你應(yīng)該明確對(duì)象不為null 的時(shí)候使用of()。

如果對(duì)象即可能是null也可能是非 null，你就應(yīng)該使用ofNullable()方法：

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

2.1、訪問(wèn)Optional對(duì)象的值

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

@Test
public void whenCreateOfNullableOptional_thenOk() {
    String name = "John";
    Optional<String> opt = Optional.ofNullable(name);

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

不過(guò)，你看到了，這個(gè)方法會(huì)在值為null的時(shí)候拋出異常。要避免異常，你可以選擇首先驗(yàn)證是否有值：

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

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

檢查是否有值的另一個(gè)選擇是ifPresent()方法。該方法除了執(zhí)行檢查，還接受一個(gè)Consumer(消費(fèi)者) 參數(shù)，如果對(duì)象不是空的，就對(duì)執(zhí)行傳入的 Lambda 表達(dá)式：

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

這個(gè)例子中，只有 user 用戶不為 null 的時(shí)候才會(huì)執(zhí)行斷言。

接下來(lái)，我們來(lái)看看提供空值的方法。

2.2、返回默認(rèn)值

Optional類提供了 API 用以返回對(duì)象值，或者在對(duì)象為空的時(shí)候返回默認(rèn)值。

這里你可以使用的第一個(gè)方法是orElse()，它的工作方式非常直接，如果有值則返回該值，否則返回傳遞給它的參數(shù)值：

@Test
public void whenEmptyValue_thenReturnDefault() {
    User user = null;
    User user2 = new User("anna@gmail.com", "1234");
    User result = Optional.ofNullable(user).orElse(user2);

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

這里user對(duì)象是空的，所以返回了作為默認(rèn)值的user2。

如果對(duì)象的初始值不是 null，那么默認(rèn)值會(huì)被忽略：

@Test
public void whenValueNotNull_thenIgnoreDefault() {
    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());
}

第二個(gè)同類型的API 是orElseGet()—— 其行為略有不同。這個(gè)方法會(huì)在有值的時(shí)候返回值，如果沒(méi)有值，它會(huì)執(zhí)行作為參數(shù)傳入的Supplier(供應(yīng)者)函數(shù)式接口，并將返回其執(zhí)行結(jié)果：

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

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

乍一看，這兩種方法似乎起著同樣的作用。然而事實(shí)并非如此。我們創(chuàng)建一些示例來(lái)突出二者行為上的異同。

我們先來(lái)看看對(duì)象為空時(shí)他們的行為：

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

上面的代碼中，兩種方法都調(diào)用了createNewUser()方法，這個(gè)方法會(huì)記錄一個(gè)消息并返回User對(duì)象。

代碼輸出如下：

Using orElse

Creating New User

Using orElseGet

Creating New User

由此可見(jiàn)，當(dāng)對(duì)象為空而返回默認(rèn)對(duì)象時(shí)，行為并無(wú)差異。

我們接下來(lái)看一個(gè)類似的示例，但這里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

這個(gè)示例中，兩個(gè)Optional 對(duì)象都包含非空值，兩個(gè)方法都會(huì)返回對(duì)應(yīng)的非空值。不過(guò)，orElse()方法仍然創(chuàng)建了User對(duì)象。與之相反，orElseGet()方法不創(chuàng)建User對(duì)象。

在執(zhí)行較密集的調(diào)用時(shí)，比如調(diào)用Web 服務(wù)或數(shù)據(jù)查詢，這個(gè)差異會(huì)對(duì)性能產(chǎn)生重大影響。

2.4、返回異常

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

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

這里，如果user值為 null，會(huì)拋出IllegalArgumentException。

這個(gè)方法讓我們有更豐富的語(yǔ)義，可以決定拋出什么樣的異常，而不總是拋出NullPointerException。

現(xiàn)在我們已經(jīng)很好地理解了如何使用 Optional，我們來(lái)看看其它可以對(duì)Optional值進(jìn)行轉(zhuǎn)換和過(guò)濾的方法。

三、轉(zhuǎn)換值

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

先來(lái)看一個(gè)使用map()API 的例子：

@Test
public void whenMap_thenOk() {
    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()對(duì)值應(yīng)用(調(diào)用)作為參數(shù)的函數(shù)，然后將返回的值包裝在Optional中。這就使對(duì)返回值進(jìn)行鏈試調(diào)用的操作成為可能 —— 這里的下一環(huán)就是orElse()。

相比這下，flatMap()也需要函數(shù)作為參數(shù)，并對(duì)值調(diào)用這個(gè)函數(shù)，然后直接返回結(jié)果。

下面的操作中，我們給User類添加了一個(gè)方法，用來(lái)返回Optional：

public class User {    
    private String position;

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

    //...
}

既然 getter 方法返回 String 值的Optional，你可以在對(duì)User的 Optional對(duì)象調(diào)用flatMap()時(shí)，用它作為參數(shù)。其返回的值是解除包裝的 String 值：

@Test
public void whenFlatMap_thenOk() {
    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());
}

3.1、過(guò)濾值

除了轉(zhuǎn)換值之外，Optional 類也提供了按條件“過(guò)濾”值的方法。

filter()接受一個(gè)Predicate參數(shù)，返回測(cè)試結(jié)果為 true 的值。如果測(cè)試結(jié)果為 false，會(huì)返回一個(gè)空的Optional。

來(lái)看一個(gè)根據(jù)基本的電子郵箱驗(yàn)證來(lái)決定接受或拒絕User(用戶)的示例：

@Test
public void whenFilter_thenOk() {
    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());
}

如果通過(guò)過(guò)濾器測(cè)試，result對(duì)象會(huì)包含非空值。

四、Optional類的鏈?zhǔn)椒椒?/h3>

為了更充分的使用Optional，你可以鏈接組合其大部分方法，因?yàn)樗鼈兌挤祷叵嗤愃频膶?duì)象。

我們使用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)可以用下面的圖來(lái)表示：

現(xiàn)在可以刪除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");
}

上面的代碼可以通過(guò)方法引用進(jìn)一步縮減：

String result = Optional.ofNullable(user)
  .flatMap(User::getAddress)
  .flatMap(Address::getCountry)
  .map(Country::getIsocode)
  .orElse("default");

結(jié)果現(xiàn)在的代碼看起來(lái)比之前采用條件分支的冗長(zhǎng)代碼簡(jiǎn)潔多了。

五、Java 9 增強(qiáng)

我們介紹了Java 8 的特性，Java 9 為 Optional 類添加了三個(gè)方法：or()、ifPresentOrElse()和stream()。

or()方法與orElse()和orElseGet()類似，它們都在對(duì)象為空的時(shí)候提供了替代情況。or()的返回值是由Supplier參數(shù)產(chǎn)生的另一個(gè)Optional對(duì)象。

如果對(duì)象包含值，則 Lambda 表達(dá)式不會(huì)執(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，它會(huì)返回一個(gè)Optional，它所包含的User對(duì)象，其電子郵件為 “default”。

ifPresentOrElse()方法需要兩個(gè)參數(shù)：一個(gè)Consumer和一個(gè)Runnable。如果對(duì)象包含值，會(huì)執(zhí)行Consumer的動(dòng)作，否則運(yùn)行Runnable。

如果你想在有值的時(shí)候執(zhí)行某個(gè)動(dòng)作，或者只是跟蹤是否定義了某個(gè)值，那么這個(gè)方法非常有用：

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

最后介紹的是新的stream()方法，它通過(guò)把實(shí)例轉(zhuǎn)換為Stream對(duì)象，讓你從廣大的StreamAPI 中受益。如果沒(méi)有值，它會(huì)得到空的Stream；有值的情況下，Stream則會(huì)包含單一值。

我們來(lái)看一個(gè)把Optional處理成Stream的例子：

@Test
public void whenGetStream_thenOk() {
    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());
}

這里對(duì)Stream的使用帶來(lái)了其filter()、map()和collect()接口，以獲取List。

六、Optional 應(yīng)該怎樣用？

在使用Optional的時(shí)候需要考慮一些事情，以決定什么時(shí)候怎樣使用它。

重要的一點(diǎn)是Optional不是Serializable。因此，它不應(yīng)該用作類的字段。

如果你需要序列化的對(duì)象包含Optional值，Jackson庫(kù)支持把Optional當(dāng)作普通對(duì)象。也就是說(shuō)，Jackson會(huì)把空對(duì)象看作null，而有值的對(duì)象則把其值看作對(duì)應(yīng)域的值。這個(gè)功能在jackson-modules-java8項(xiàng)目中。

它在另一種情況下也并不怎么有用，就是在將其類型用作方法或構(gòu)建方法的參數(shù)時(shí)。這樣做會(huì)讓代碼變得復(fù)雜，完全沒(méi)有必要：

User user = new User("john@gmail.com", "1234", Optional.empty());

使用重載方法來(lái)處理非要的參數(shù)要容易得多。

Optional主要用作返回類型。在獲取到這個(gè)類型的實(shí)例后，如果它有值，你可以取得這個(gè)值，否則可以進(jìn)行一些替代行為。

Optional類有一個(gè)非常有用的用例，就是將其與流或其它返回Optional的方法結(jié)合，以構(gòu)建流暢的API。

我們來(lái)看一個(gè)示例，使用Stream返回Optional對(duì)象的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");
}

以上是“JAVA中OPTIONAL的使用方法”這篇文章的所有內(nèi)容，感謝各位的閱讀！相信大家都有了一定的了解，希望分享的內(nèi)容對(duì)大家有所幫助，如果還想學(xué)習(xí)更多知識(shí)，歡迎關(guān)注億速云行業(yè)資訊頻道！