JAVA8如何用Optional解決NPE問題詳解
引用處:
JAVA8如何妙用Optional解決NPE問題詳解
引言
NPE(NullPointerException)是除錯程式最常見的異常。google一下有很多關於方法到底應該返回null還是new一個空物件的討論。
在文章的開頭,先說下NPE問題,NPE問題就是,我們在開發中經常碰到的NullPointerException.假設我們有兩個類,他們的UML類圖如下圖所示
在這種情況下,有如下程式碼:
user.getAddress().getProvince();
這種寫法,在user為null時,是有可能報NullPointerException異常的。為了解決這個問題,於是採用下面的寫法:
if(user!=null){
Address address = user.getAddress();
if(address!=null){
String province = address.getProvince();
}
}
這種寫法是比較醜陋的,為了避免上述醜陋的寫法,讓醜陋的設計變得優雅。JAVA8提供了Optional類來優化這種寫法,接下來的正文部分進行詳細說明
API介紹
先介紹一下API,與其他文章不同的是,本文采取類比的方式來講,同時結合原始碼。而不像其他文章一樣,一個個API羅列出來,讓人找不到重點。
(1)Optional(T value),empty(),of(T value),ofNullable(T value)
這四個函式之間具有相關性,因此放在一組進行記憶。
先說明一下,Optional(T value),即建構函式,它是private許可權的,不能由外部呼叫的。其餘三個函式是public許可權,供我們所呼叫。那麼,Optional的本質,就是內部儲存了一個真實的值,在構造的時候,就直接判斷其值是否為空。好吧,這麼說還是比較抽象。直接上Optional(T value)建構函式的原始碼,如下圖所示
那麼,of(T value)的原始碼如下:
public static <T> Optional<T> of(T value) { return new Optional<>(value); }
也就是說of(T value)函式內部呼叫了建構函式。根據建構函式的原始碼我們可以得出兩個結論:
(1)通過of(T value)函式所構造出的Optional物件,當Value值為空時,依然會報NullPointerException。
(2)通過of(T value)函式所構造出的Optional物件,當Value值不為空時,能正常構造Optional物件。
除此之外呢,Optional類內部還維護一個value為null的物件,大概就是長下面這樣的
public final class Optional<T> {
//省略....
private static final Optional<?> EMPTY = new Optional<>();
private Optional() {
this.value = null;
}
//省略...
public static<T> Optional<T> empty() {
@SuppressWarnings("unchecked")
Optional<T> t = (Optional<T>) EMPTY;
return t;
}
}
那麼,empty()的作用就是返回EMPTY物件。
好了鋪墊了這麼多,可以說ofNullable(T value)的作用了,上原始碼:
public static <T> Optional<T> ofNullable(T value) {
return value == null ? empty() : of(value);
}
相比較of(T value)的區別就是,當value值為null時,of(T value)會報NullPointerException異常;ofNullable(T value)不會throw Exception,ofNullable(T value)直接返回一個EMPTY物件。
那是不是意味著,我們在專案中只用ofNullable函式而不用of函式呢?
不是的,一個東西存在那麼自然有存在的價值。當我們在執行過程中,不想隱藏NullPointerException。而是要立即報告,這種情況下就用Of函式。但是不得不承認,這樣的場景真的很少。博主也僅在寫junit測試用例中用到過此函式。
(2)orElse(T other),orElseGet(Supplier<? extends T> other)和orElseThrow(Supplier<? extends X> exceptionSupplier)
這三個函式放一組進行記憶,都是在建構函式傳入的value值為null時,進行呼叫的。orElse和orElseGet的用法如下所示,相當於value值為null時,給予一個預設值:
@Test
public void test() {
User user = null;
user = Optional.ofNullable(user).orElse(createUser());
user = Optional.ofNullable(user).orElseGet(() -> createUser());
}
public User createUser(){
User user = new User();
user.setName("zhangsan");
return user;
}
這兩個函式的區別:當user值不為null時,orElse函式依然會執行createUser()方法,而orElseGet函式並不會執行createUser()方法,大家可自行測試。
至於orElseThrow,就是value值為null時,直接拋一個異常出去,用法如下所示:
User user = null;
Optional.ofNullable(user).orElseThrow(()->new Exception("使用者不存在"));
(3) map(Function<? super T, ? extends U> mapper)和flatMap(Function<? super T, Optional> mapper)
這兩個函式放在一組記憶,這兩個函式做的是轉換值的操作。
直接上原始碼,如下:
public final class Optional<T> {
//省略....
public<U> Optional<U> map(Function<? super T, ? extends U> mapper) {
Objects.requireNonNull(mapper);
if (!isPresent())
return empty();
else {
return Optional.ofNullable(mapper.apply(value));
}
}
//省略...
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));
}
}
}
這兩個函式,在函式體上沒什麼區別。唯一區別的就是入參,map函式所接受的入參型別為Function<? super T, ? extends U>,而flapMap的入參型別為Function<? super T, Optional>。
在具體用法上,對於map而言:
如果User結構是下面這樣的
public class User {
private String name;
public String getName() {
return name;
}
}
這時候取name的寫法如下所示
String city = Optional.ofNullable(user).map(u-> u.getName()).get();
對於flatMap而言:
如果User結構是下面這樣的
public class User {
private String name;
public Optional<String> getName() {
return Optional.ofNullable(name);
}
}
這時候取name的寫法如下所示:
String city = Optional.ofNullable(user).flatMap(u-> u.getName()).get();
(4) isPresent()和ifPresent(Consumer<? super T> consumer)
這兩個函式放在一起記憶,isPresent即判斷value值是否為空,而ifPresent就是在value值不為空時,做一些操作。這兩個函式的原始碼如下
public final class Optional<T> {
//省略....
public boolean isPresent() {
return value != null;
}
//省略...
public void ifPresent(Consumer<? super T> consumer) {
if (value != null)
consumer.accept(value);
}
}
需要額外說明的是,大家千萬不要把
if (user != null){
// TODO: do something
}
給寫成
User user = Optional.ofNullable(user);
if (Optional.isPresent()){
// TODO: do something
}
因為這樣寫,程式碼結構依然醜陋。博主會在後面給出正確寫法
至於ifPresent(Consumer<? super T> consumer),用法也很簡單,如下所示:
Optional.ofNullable(user).ifPresent(u->{
// TODO: do something
});
(5) filter(Predicate<? super T> predicate)
不多說,直接上原始碼:
public final class Optional<T> {
//省略....
Objects.requireNonNull(predicate);
if (!isPresent())
return this;
else
return predicate.test(value) ? this : empty();
}
filter 方法接受一個 Predicate 來對 Optional 中包含的值進行過濾,如果包含的值滿足條件,那麼還是返回這個 Optional;否則返回 Optional.empty。
用法如下:
Optional<User> user1 = Optional.ofNullable(user).filter(u -> u.getName().length()<6);
如上所示,如果user的name的長度是小於6的,則返回。如果是大於6的,則返回一個EMPTY物件。
實戰使用
例一
在函式方法中
以前寫法
public String getCity(User user) throws Exception{
if(user!=null){
if(user.getAddress()!=null){
Address address = user.getAddress();
if(address.getCity()!=null){
return address.getCity();
}
}
}
throw new Excpetion("取值錯誤");
}
JAVA8寫法
public String getCity(User user) throws Exception{
return Optional.ofNullable(user)
.map(u-> u.getAddress())
.map(a->a.getCity())
.orElseThrow(()->new Exception("取指錯誤"));
}
例二
比如,在主程式中
以前寫法
if(user!=null){
dosomething(user);
}
JAVA8寫法
Optional.ofNullable(user)
.ifPresent(u->{
dosomething(u);
});
例三
以前寫法
public User getUser(User user) throws Exception{
if(user!=null){
String name = user.getName();
if("zhangsan".equals(name)){
return user;
}
}else{
user = new User();
user.setName("zhangsan");
return user;
}
}
java8寫法
ublic User getUser(User user) {
return Optional.ofNullable(user)
.filter(u->"zhangsan".equals(u.getName()))
.orElseGet(()-> {
User user1 = new User();
user1.setName("zhangsan");
return user1;
});
}
說明:鏈式程式設計,雖然程式碼優雅了。但是,邏輯性沒那麼明顯,可讀性有所降低,大家專案中看情況酌情使用。