1. 程式人生 > 實用技巧 >理解、學習與使用 JAVA 中的 OPTIONAL

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

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

本質上,這是一個包含有可選值的包裝類,這意味著 Optional 類既可以含有物件也可以為空。

Optional 是 Java 實現函數語言程式設計的強勁一步,並且幫助在正規化中實現。但是 Optional 的意義顯然不止於此。


我們從一個簡單的用例開始。在 Java 8 之前,任何訪問物件方法或屬性的呼叫都可能導致NullPointerException

Stringisocode=user.getAddress().getCountry().getIsocode().toUpperCase();

在這個小示例中,如果我們需要確保不觸發異常,就得在訪問每一個值之前對其進行明確地檢查:

if(user!=null){
Addressaddress=user.getAddress();
if(address!=null){
Countrycountry=address.getCountry();
if(country!=null){
Stringisocode=country.getIsocode();
if(isocode!=null){
isocode=isocode.toUpperCase();
}
}
}
}

你看到了,這很容易就變得冗長,難以維護。

為了簡化這個過程,我們來看看用Optional 類是怎麼做的。從建立和驗證例項,到使用其不同的方法,並與其它返回相同型別的方法相結合,下面是見證Optional 奇蹟的時刻。


建立Optional 例項

重申一下,這個型別的物件可能包含值,也可能為空。你可以使用同名方法建立一個空的 Optional。

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

毫不奇怪,嘗試訪問emptyOpt變數的值會導致NoSuchElementException

你可以使用of()和 ofNullable() 方法建立包含值的Optional。兩個方法的不同之處在於如果你把null值作為引數傳遞進去,of()方法會丟擲NullPointerException

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

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

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

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


訪問Optional物件的值

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

@Test
publicvoidwhenCreateOfNullableOptional_thenOk(){
Stringname="John";
Optional<String>opt=Optional.ofNullable(name);

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

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

@Test
publicvoidwhenCheckIfPresent_thenOk(){
Useruser=newUser("[email protected]","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 的時候才會執行斷言。

接下來,我們來看看提供空值的方法。


返回預設值

Optional類提供了 API 用以返回物件值,或者在物件為空的時候返回預設值。

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

@Test
publicvoidwhenEmptyValue_thenReturnDefault(){
Useruser=null;
Useruser2=newUser("[email protected]","1234");
Userresult=Optional.ofNullable(user).orElse(user2);

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

這裡user物件是空的,所以返回了作為預設值的user2

如果物件的初始值不是 null,那麼預設值會被忽略:

@Test
publicvoidwhenValueNotNull_thenIgnoreDefault(){
Useruser=newUser("[email protected]","1234");
Useruser2=newUser("[email protected]","1234");
Userresult=Optional.ofNullable(user).orElse(user2);

assertEquals("[email protected]",result.getEmail());
}

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

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


orElse()orElseGet()的不同之處

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

我們先來看看物件為空時他們的行為:

@Test
publicvoidgivenEmptyValue_whenCompare_thenOk(){
Useruser=null
logger.debug("UsingorElse");
Userresult=Optional.ofNullable(user).orElse(createNewUser());
logger.debug("UsingorElseGet");
Userresult2=Optional.ofNullable(user).orElseGet(()->createNewUser());
}

privateUsercreateNewUser(){
logger.debug("CreatingNewUser");
returnnewUser("[email protected]","1234");
}

上面的程式碼中,兩種方法都呼叫了createNewUser()方法,這個方法會記錄一個訊息並返回User物件。

程式碼輸出如下:

UsingorElse
CreatingNewUser
UsingorElseGet
CreatingNewUser

由此可見,當物件為空而返回預設物件時,行為並無差異。



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

@Test
publicvoidgivenPresentValue_whenCompare_thenOk(){
Useruser=newUser("[email protected]","1234");
logger.info("UsingorElse");
Userresult=Optional.ofNullable(user).orElse(createNewUser());
logger.info("UsingorElseGet");
Userresult2=Optional.ofNullable(user).orElseGet(()->createNewUser());
}

這次的輸出:

UsingorElse
CreatingNewUser
UsingorElseGet

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

在執行較密集的呼叫時,比如呼叫Web 服務或資料查詢,這個差異會對效能產生重大影響。



返回異常

除了orElse()orElseGet()方法,Optional 還定義了orElseThrow()API —— 它會在物件為空的時候丟擲異常,而不是返回備選的值:

@Test(expected=IllegalArgumentException.class)
publicvoidwhenThrowException_thenOk(){
Userresult=Optional.ofNullable(user)
.orElseThrow(()->newIllegalArgumentException());
}

這裡,如果user值為 null,會丟擲IllegalArgumentException

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

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



轉換值

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

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

@Test
publicvoidwhenMap_thenOk(){
Useruser=newUser("[email protected]","1234");
Stringemail=Optional.ofNullable(user)
.map(u->u.getEmail()).orElse("[email protected]");

assertEquals(email,user.getEmail());
}

map()對值應用(呼叫)作為引數的函式,然後將返回的值包裝在Optional中。這就使對返回值進行鏈試呼叫的操作成為可能 —— 這裡的下一環就是orElse()

相比這下,flatMap()也需要函式作為引數,並對值呼叫這個函式,然後直接返回結果。

下面的操作中,我們給User類添加了一個方法,用來返回Optional

publicclassUser{
privateStringposition;

publicOptional<String>getPosition(){
returnOptional.ofNullable(position);
}

//...
}

既然 getter 方法返回 String 值的Optional,你可以在對User的 Optional物件呼叫flatMap()時,用它作為引數。其返回的值是解除包裝的 String 值:

@Test
publicvoidwhenFlatMap_thenOk(){
Useruser=newUser("[email protected]","1234");
user.setPosition("Developer");
Stringposition=Optional.ofNullable(user)
.flatMap(u->u.getPosition()).orElse("default");

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


過濾值

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

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

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

@Test
publicvoidwhenFilter_thenOk(){
Useruser=newUser("[email protected]","1234");
Optional<User>result=Optional.ofNullable(user)
.filter(u->u.getEmail()!=null&&u.getEmail().contains("@"));

assertTrue(result.isPresent());
}

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

Optional類的鏈式方法

為了更充分的使用Optional,你可以連結組合其大部分方法,因為它們都返回相同類似的物件。

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

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

publicclassUser{
privateAddressaddress;

publicOptional<Address>getAddress(){
returnOptional.ofNullable(address);
}

//...
}
publicclassAddress{
privateCountrycountry;

publicOptional<Country>getCountry(){
returnOptional.ofNullable(country);
}

//...
}

上面的巢狀結構可以用下面的圖來表示:

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

@Test
publicvoidwhenChaining_thenOk(){
Useruser=newUser("[email protected]","1234");

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

assertEquals(result,"default");
}

上面的程式碼可以通過方法引用進一步縮減:

Stringresult=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 表示式不會執行:

@Test
publicvoidwhenEmptyOptional_thenGetValueFromOr(){
Userresult=Optional.ofNullable(user)
.or(()->Optional.of(newUser("default","1234"))).get();

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

上面的示例中,如果user變數是 null,它會返回一個Optional,它所包含的User物件,其電子郵件為 “default”。

ifPresentOrElse()方法需要兩個引數:一個Consumer和一個Runnable。如果物件包含值,會執行Consumer的動作,否則執行Runnable

如果你想在有值的時候執行某個動作,或者只是跟蹤是否定義了某個值,那麼這個方法非常有用:

Optional.ofNullable(user).ifPresentOrElse(u->logger.info("Useris:"+u.getEmail()),
()->logger.info("Usernotfound"));

最後介紹的是新的stream()方法,它通過把例項轉換為Stream物件,讓你從廣大的StreamAPI 中受益。如果沒有值,它會得到空的Stream;有值的情況下,Stream則會包含單一值。

我們來看一個把Optional處理成Stream的例子:

@Test
publicvoidwhenGetStream_thenOk(){
Useruser=newUser("[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 應該怎樣用?

在使用Optional的時候需要考慮一些事情,以決定什麼時候怎樣使用它。

重要的一點是Optional不是Serializable。因此,它不應該用作類的欄位。

如果你需要序列化的物件包含Optional值,Jackson支援把Optional當作普通物件。也就是說,Jackson會把空物件看作null,而有值的物件則把其值看作對應域的值。這個功能在jackson-modules-java8專案中。

它在另一種情況下也並不怎麼有用,就是在將其型別用作方法或構建方法的引數時。這樣做會讓程式碼變得複雜,完全沒有必要:

Useruser=newUser("[email protected]","1234",Optional.empty());

使用過載方法來處理非要的引數要容易得多。

Optional主要用作返回型別。在獲取到這個型別的例項後,如果它有值,你可以取得這個值,否則可以進行一些替代行為。

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

我們來看一個示例,使用Stream返回Optional物件的findFirst()方法:

@Test
publicvoidwhenEmptyStream_thenReturnDefaultOptional(){
List<User>users=newArrayList<>();
Useruser=users.stream().findFirst().orElse(newUser("default","1234"));

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

總結

Optional是 Java 語言的有益補充 —— 它旨在減少程式碼中的NullPointerExceptions,雖然還不能完全消除這些異常。

它也是精心設計,自然融入 Java 8 函式式支援的功能。

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


來源:https://www.oschina.net/translate/understanding-accepting-and-leveraging-optional-in?lang=chs&page=2#

https://www.cnblogs.com/zhangboyu/p/7580262.html