是什么
? 從 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實體
重申一下,這個型別的物件可能包含值,也可能為空,你可以使用同名方法創建一個空的 Optional,
@Test(expected = NoSuchElementException.class)
public void whenCreateEmptyOptional_thenNull() {
Optional<User> emptyOpt = Optional.empty();
emptyOpt.get();
}
毫不奇怪,嘗試訪問 emptyOpt 變數的值會導致 NoSuchElementException
你可以使用 of() 和 ofNullable() 方法創建包含值的 Optional,兩個方法的不同之處在于如果你把 null 值作為引數傳遞進去,of()方法會拋出 NullPointerException:
@Test(expected = NullPointerException.class)
public void whenCreateOfEmptyOptional_thenNullPointerException() {
Optional<User> opt = Optional.of(user);
}
你看,我們并沒有完全擺脫 NullPointerException,因此,你應該明確物件不為 null 的時候使用 of(),
如果物件可能是 null 也可能是非 null,你就應該使用 ofNullable() 方法:
Optional<User> opt = Optional.ofNullable(user);
訪問 Optional物件的值
從 Optional 實體中取回實際值物件的方法之一是使用 get()方法:
@Test
public void whenCreateOfNullableOptional_thenOk() {
String name = "John";
Optional<String> opt = Optional.ofNullable(name);
assertEquals("John", opt.get());
}
不過,這個方法會在值為 null 的時候拋出例外,要避免例外,你可以選擇首先驗證是否有值:
@Test
public void whenCheckIfPresent_thenOk() {
User user = new User();
Optional<User> opt = Optional.ofNullable(user);
assertTrue(opt.isPresent());
assertEquals(user.getEmail(), opt.get().getEmail());
}
//isPresent()兩個多載方法
public boolean isPresent() {
return value != null;
}
public void ifPresent(Consumer<? super T> consumer) {
if (value != null)
consumer.accept(value);
}
檢查是否有值的另一個選擇是 ifPresent()方法,該方法除了執行檢查,還接受一個Consumer(消費者) 引數,如果物件不是空的,就對執行傳入的 Lambda 運算式:
@Test
public void whenCheckIfPresent_thenOk() {
Admin admin = new Admin("[email protected]", "1234");
Optional<Admin> opt = Optional.ofNullable(admin);
opt.ifPresent( u -> System.out.println(u.getEmail()));
}
這個例子中,只有 admin用戶不為 null 的時候才會執行lambda運算式中的代碼
接下來,我們來看看提供空值的方法,
回傳默認值
Optional 類提供了 API 用以回傳物件值,或者在物件為空的時候回傳默認值,
這里你可以使用的第一個方法是 orElse(),它的作業方式非常直接,如果有值則回傳該值,否則回傳傳遞給它的引數值
@Test
public void whenEmptyValue_thenReturnDefault() {
User user = null;
User user2 = new User("[email protected]", "1234");
User result = Optional.ofNullable(user).orElse(user2);
assertEquals(user2.getEmail(), result.getEmail());
}
這里 user 物件是空的,所以回傳了作為默認值的 user2
如果物件的初始值不是 null,那么默認值會被忽略:
@Test
public void whenValueNotNull_thenIgnoreDefault() {
User user = new User("[email protected]","1234");
User user2 = new User("[email protected]", "1234");
User result = Optional.ofNullable(user).orElse(user2);
assertEquals("[email protected]", result.getEmail());
}
第二個同型別的 API 是 orElseGet()—— 其行為略有不同,這個方法會在有值的時候回傳值,如果沒有值,它會執行作為引數傳入的 Supplier(供應者) 函式式介面,并將回傳其執行結果:
User result = Optional.ofNullable(user).orElseGet( () -> user2);
orElse() 和 orElseGet()的不同之處
乍一看,這兩種方法似乎起著同樣的作用,然而事實并非如此,我們創建一些示例來突出二者行為上的異同,
我們先來看看物件為空時他們的行為:
@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("[email protected]", "1234");
}
上面的代碼中,兩種方法都呼叫了 createNewUser() 方法,這個方法會記錄一個訊息并回傳 User 物件,
代碼輸出如下:
Using orElse
Creating New User
Using orElseGet
Creating New User
由此可見,當物件為空而回傳默認物件時,行為并無差異,
我們接下來看一個類似的示例,但這里 Optional 不為空:
@Test
public void givenPresentValue_whenCompare_thenOk() {
User user = new User("[email protected]", "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 服務或資料查詢,這個差異會對性能產生重大影響,
回傳例外
除了 orElse() 和 orElseGet() 方法,Optional 還定義了 orElseThrow() API —— 它會在物件為空的時候拋出例外,而不是回傳備選的值:
@Test(expected = IllegalArgumentException.class)
public void whenThrowException_thenOk() {
User result = Optional.ofNullable(user)
.orElseThrow( () -> new IllegalArgumentException());
}
這里,如果 user 值為 null,會拋出 IllegalArgumentException,
這個方法讓我們有更豐富的語意,可以決定拋出什么樣的例外,而不總是拋出 NullPointerException,
現在我們已經很好地理解了如何使用 Optional,我們來看看其它可以對 Optional 值進行轉換和過濾的方法,
轉換值
有很多種方法可以轉換 Optional 的值,我們從 map() 和 flatMap() 方法開始,
先來看一個使用 map() API 的例子:
@Test
public void whenMap_thenOk() {
User user = new User(new Address("北京"));
String country = Optional.ofNullable(user)
.map(User::getAddress) //這一步回傳Optional[Address{country='北京'}]
.map(Address::getCountry) //這一不回傳Option[北京]
.orElse("China");
}
map()將要轉換的值作為引數,然后將其包裝在 Optional中回傳,這就使鏈試呼叫的操作成為可能
相比較下,flatMap()和map()作用類似,當引數為null時,兩者都回傳一個空的Optional,只不過在入參不是null時有些區別,
map()和flatMap()的區別
map會將傳入的Function函式的結果進行封裝,先看原始碼:
public<U> Optional<U> map(Function<? super T, ? extends U> mapper) {
Objects.requireNonNull(mapper);
if (!isPresent())
return empty();
else {
//會使用Optional的ofNullable方法包裝Function函式回傳的值
return Optional.ofNullable(mapper.apply(value));
}
}
flatMap會直接回傳Function函式執行的結果,看原始碼:
public<U> Optional<U> flatMap(Function<? super T, Optional<U>> mapper) {
Objects.requireNonNull(mapper);
if (!isPresent())
return empty();
else {
return Objects.requireNonNull(mapper.apply(value));//直接回傳Function執行的結果
}
}
public static <T> T requireNonNull(T obj) {
if (obj == null)
throw new NullPointerException();
return obj;
}
這樣看,好像也看不出來兩者太大的區別,不知道什么時候用map,什么時候用flatMap,首先對于下列物件的操作
public class School {
private String name;
private Optional<Tearch> tearch; //屬性為Option封裝的Tearch物件
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public Optional<Tearch> getTearch() {
return tearch;
}
public void setTearch(Optional<Tearch> tearch) {
this.tearch = tearch;
}
}
class Tearch{
private String name;
private Optional<Student> student;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public Optional<Student> getStudent() {
return student;
}
public void setStudent(Optional<Student> student) {
this.student = student;
}
}
class Student{
private String name;
private int age;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public int getAge() {
return age;
}
public void setAge(int age) {
this.age = age;
}
}
這時,如果給你一個School物件,讓你得到Student的name屬性的值,可以使用下面的方式:
public static String getStudentName(School school){
return Optional.ofNullable(school)
.map(School::getTearch)
.map(Tearch::getStudent)
.map(Student::getName)
.orElse("false");
}
你可能感覺這樣寫很對啊,沒毛病,可惜這段代碼連編譯都不會通過的,我們思考一下,School::getTearch會回傳School實體的tearch屬性,而tearch屬性是使用Optional包裝的Tearch物件,所以使用了map(School::getTearch),會回傳Optional<Optional<Tearch>>物件,而不是我們所想的Optional<Tearch>,
這時就可以使用flatMap來解決這個問題,剛才已經說了,flatMap不會使用Optional包裝Function執行的回傳結果,所以我們可以使用flatMap來解決這個問題
public static String getStudentName(School school){
return Optional.ofNullable(school)
.flatMap(School::getTearch)
.flatMap(Tearch::getStudent)
.map(Student::getName).orElse("false");
}
這時map和flatMap的用法就清楚了
- 如果某物件實體的屬性本身就為Optional包裝過的型別,那么就要使用flatMap方法,就像School::getTearch回傳的就是Optional
型別的,所以不能再使用Optional進行包裝,這時就要選用flatMap方法 - 對于回傳值是其他型別,需要Optional進行包裝,如Student::getName得到是String型別的,就需要使用map方法在其外面包裝一層Optional物件,
過濾值
除了轉換值之外,Optional 類也提供了按條件“過濾”值的方法,
filter() 接受一個Predicate引數,回傳測驗結果為 true 的值,如果測驗結果為 false,會回傳一個空的 Optional,
來看一個根據基本的電子郵箱驗證來決定接受或拒絕 User用戶) 的示例:
@Test
public void whenFilter_thenOk() {
User user = new User("[email protected]", "1234");
Optional<User> result = Optional.ofNullable(user)
.filter(u -> u.getEmail() != null && u.getEmail().contains("@"));
assertTrue(result.isPresent());
}
如果通過過濾器測驗,result 物件會非空且包含@字符,
Optional 類的鏈式呼叫(重要)
我們使用 Optional 重寫文章開始處介紹的示例,
User user = null;
String country = Optional.ofNullable(user)
.map(User::getAddress)
.map(Address::getCountry)
.map(Country::getIsocode)
.orElse("default");
System.out.println(country.toUpperCase()); //DEFAULT
上面的嵌套結構可以用下面的圖來表示:

Java 9 增強
我們介紹了 Java 8 的特性,**Java 9 為 Optional 類添加了三個方法:or()、*ifPresentOrElse()、stream(),
or() 方法與 orElse() 和 orElseGet() 類似,它們都在物件為空的時候提供了替代情況,or() 的回傳值是由 Supplier 引數產生的另一個 Optional 物件,
如果物件包含值,則 Lambda 運算式不會執行:
@Test
public void whenEmptyOptional_thenGetValueFromOr() {
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 的例子:
@Test
public void whenGetStream_thenOk() {
User user = new User("[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不是Serializable,因此,它不應該用作類的欄位,
如果你需要序列化的物件包含 Optional 值,Jackson 庫支持把 Optional 當作普通物件,也就是說,Jackson 會把空物件看作 null,而有值的物件則把其值看作對應域的值,這個功能在 jackson-modules-java8 專案中,
它在另一種情況下也并不怎么有用,就是在將其型別用作方法或構建方法的引數時,這樣做會讓代碼變得復雜,完全沒有必要:
User user = new User("[email protected]", "1234", Optional.empty());
使用多載方法來處理非要的引數要容易得多,
Optional 主要用作回傳型別,在獲取到這個型別的實體后,如果它有值,你可以取得這個值,否則可以進行一些替代行為,
Optional 類有一個非常有用的用例,就是將其與流或其它回傳 Optional 的方法結合,以構建流暢的API,
我們來看一個示例,使用 Stream 回傳 Optional 物件的 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");
}
總結
Optional 是 Java 語言的有益補充 —— 它旨在減少代碼中的 NullPointerExceptions,雖然還不能完全消除這些例外,
它也是精心設計,自然融入 Java 8 函式式支持的功能,
總的來說,這個簡單而強大的類有助于創建簡單、可讀性更強、比對應程式錯誤更少的程式,
轉載請註明出處,本文鏈接:https://www.uj5u.com/houduan/335058.html
標籤:Java
上一篇:如果你還不知道Apache Zookeeper?你憑什么拿大廠Offer!!
下一篇:基于Java的顯式配置
