從 Java 8 引入的一個(gè)很有趣的特性是 Optional 類。Optional 類主要解決的問題是臭名昭著的空指針異常(NullPointerException) —— 每個(gè) Java 程序員都非常了解的異常元践。
本質(zhì)上沿盅,這是一個(gè)包含有可選值的包裝類漏健,這意味著 Optional 類既可以含有對(duì)象也可以為空挽封。
Optional 是 Java 實(shí)現(xiàn)函數(shù)式編程的強(qiáng)勁一步,并且?guī)椭诜妒街袑?shí)現(xiàn)韧掩。但是 Optional 的意義顯然不止于此犯祠。
我們從一個(gè)簡(jiǎn)單的用例開始旭等。在 Java 8 之前,任何訪問對(duì)象方法或?qū)傩缘恼{(diào)用都可能導(dǎo)致 NullPointerException:
String isocode = user.getAddress().getCountry().getIsocode().toUpperCase();
在這個(gè)小示例中衡载,如果我們需要確保不觸發(fā)異常搔耕,就得在訪問每一個(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è)過程,我們來看看用 Optional 類是怎么做的梨睁。從創(chuàng)建和驗(yàn)證實(shí)例鲸睛,到使用其不同的方法,并與其它返回相同類型的方法相結(jié)合坡贺,下面是見證 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();
}
毫不奇怪愿伴,嘗試訪問 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);
}
你看万搔,我們并沒有完全擺脫 NullPointerException。因此官帘,你應(yīng)該明確對(duì)象不為 null 的時(shí)候使用 of()瞬雹。
如果對(duì)象即可能是 null 也可能是非 null,你就應(yīng)該使用 ofNullable() 方法:
Optional<User> opt = Optional.ofNullable(user);
訪問 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());
}
不過刽虹,你看到了酗捌,這個(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í)行斷言初烘。
接下來涡真,我們來看看提供空值的方法分俯。
返回默認(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í)候返回值,如果沒有值壮啊,它會(huì)執(zhí)行作為參數(shù)傳入的 Supplier(供應(yīng)者) 函數(shù)式接口卒稳,并將返回其執(zhí)行結(jié)果:
User result = Optional.ofNullable(user).orElseGet( () -> user2);
orElse() 和 orElseGet() 的不同之處
乍一看,這兩種方法似乎起著同樣的作用他巨。然而事實(shí)并非如此充坑。我們創(chuàng)建一些示例來突出二者行為上的異同。
我們先來看看對(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
由此可見份企,當(dāng)對(duì)象為空而返回默認(rèn)對(duì)象時(shí)也榄,行為并無差異。
我們接下來看一個(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)的非空值骂远。不過囚霸,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)生重大影響劣挫。
返回異常
除了 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è)方法讓我們有更豐富的語義帐我,可以決定拋出什么樣的異常刘莹,而不總是拋出 NullPointerException。
現(xiàn)在我們已經(jīng)很好地理解了如何使用 Optional焚刚,我們來看看其它可以對(duì) Optional 值進(jìn)行轉(zhuǎn)換和過濾的方法。
轉(zhuǎn)換值
有很多種方法可以轉(zhuǎn)換 Optional 的值扇调。我們從 map() 和 flatMap() 方法開始矿咕。
先來看一個(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è)方法瑞侮,用來返回 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());
}
過濾值
除了轉(zhuǎn)換值之外,Optional 類也提供了按條件“過濾”值的方法季俩。
filter() 接受一個(gè) Predicate 參數(shù)钮糖,返回測(cè)試結(jié)果為 true 的值。如果測(cè)試結(jié)果為 false酌住,會(huì)返回一個(gè)空的 Optional店归。
來看一個(gè)根據(jù)基本的電子郵箱驗(yàn)證來決定接受或拒絕 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());
}
如果通過過濾器測(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)可以用下面的圖來表示:
現(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");
}
上面的代碼可以通過方法引用進(jìn)一步縮減:
String result = Optional.ofNullable(user)
.flatMap(User::getAddress)
.flatMap(Address::getCountry)
.map(Country::getIsocode)
.orElse("default");
結(jié)果現(xiàn)在的代碼看起來比之前采用條件分支的冗長(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() 方法,它通過把實(shí)例轉(zhuǎn)換為 Stream 對(duì)象狰域,讓你從廣大的 Stream API 中受益媳拴。如果沒有值,它會(huì)得到空的 Stream兆览;有值的情況下禀挫,Stream 則會(huì)包含單一值。
我們來看一個(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 的使用帶來了其 filter()拓颓、map() 和 collect() 接口语婴,以獲取 List。
Optional 應(yīng)該怎樣用驶睦?
在使用 Optional 的時(shí)候需要考慮一些事情砰左,以決定什么時(shí)候怎樣使用它。
重要的一點(diǎn)是* Optional *****不是***** Serializable*场航。因此缠导,它不應(yīng)該用作類的字段。
如果你需要序列化的對(duì)象包含 Optional 值溉痢,Jackson 庫(kù)支持把 *Optional 當(dāng)作普通對(duì)象僻造。也就是說,Jackson *會(huì)把空對(duì)象看作 null孩饼,而有值的對(duì)象則把其值看作對(duì)應(yīng)域的值髓削。這個(gè)功能在 jackson-modules-java8 項(xiàng)目中。
它在另一種情況下也并不怎么有用镀娶,就是在將其類型用作方法或構(gòu)建方法的參數(shù)時(shí)立膛。這樣做會(huì)讓代碼變得復(fù)雜,完全沒有必要:
User user = new User("john@gmail.com", "1234", Optional.empty());
使用重載方法來處理非要的參數(shù)要容易得多。
Optional 主要用作返回類型宝泵。在獲取到這個(gè)類型的實(shí)例后好啰,如果它有值,你可以取得這個(gè)值儿奶,否則可以進(jìn)行一些替代行為框往。
Optional 類有一個(gè)非常有用的用例,就是將其與流或其它返回 Optional 的方法結(jié)合闯捎,以構(gòu)建流暢的API椰弊。
我們來看一個(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");
}
總結(jié)
Optional 是 Java 語言的有益補(bǔ)充 —— 它旨在減少代碼中的 NullPointerExceptions隙券,雖然還不能完全消除這些異常。
它也是精心設(shè)計(jì)闹司,自然融入 Java 8 函數(shù)式支持的功能娱仔。
總的來說,這個(gè)簡(jiǎn)單而強(qiáng)大的類有助于創(chuàng)建簡(jiǎn)單游桩、可讀性更強(qiáng)牲迫、比對(duì)應(yīng)程序錯(cuò)誤更少的程序。
原文鏈接
https://www.oschina.net/translate/understanding-accepting-and-leveraging-optional-in?lang=chs&p=2