JAVA8 Optional 妙用解決對象/實體判空問題

引言

在文章的開頭，先說下NPE問題，NPE問題就是，我們在開發中經常碰到的NullPointerException.假設我們有兩個類，他們的UML類圖如下圖所示

在這種情況下，有如下代碼

user.getAddress().getProvince();

這種寫法，在user爲null時，是有可能報NullPointerException異常的。爲了解決這個問題，於是採用下面的寫法

Java

if(user!=null){
    Address address = user.getAddress();
    if(address!=null){
        String province = address.getProvince();
    }
}

瀏覽器Flash插件異常，複製失敗！

這種寫法是比較醜陋的，爲了避免上述醜陋的寫法，讓醜陋的設計變得優雅。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)的源碼如下

Java

public static <T> Optional<T> of(T value) {
    return new Optional<>(value);
}

瀏覽器Flash插件異常，複製失敗！

也就是說of(T value)函數內部調用了構造函數。根據構造函數的源碼我們可以得出兩個結論:

通過of(T value)函數所構造出的Optional對象，當Value值爲空時，依然會報NullPointerException。
通過of(T value)函數所構造出的Optional對象，當Value值不爲空時，能正常構造Optional對象。

除此之外呢，Optional類內部還維護一個value爲null的對象，大概就是長下面這樣的

Java

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;
    }
}

瀏覽器Flash插件異常，複製失敗！

那麼，empty（）的作用就是返回EMPTY對象。

好了鋪墊了這麼多，可以說ofNullable(T value)的作用了，上源碼

Java

 public static <T> Optional<T> ofNullable(T value) {
    return value == null ? empty() : of(value);
}

瀏覽器Flash插件異常，複製失敗！

好吧，大家應該都看得懂什麼意思了。相比較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時，給予一個默認值:

Java

@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;
}

瀏覽器Flash插件異常，複製失敗！

這兩個函數的區別：當user值不爲null時，orElse函數依然會執行createUser()方法，而orElseGet函數並不會執行createUser()方法，大家可自行測試。

至於orElseThrow，就是value值爲null時,直接拋一個異常出去，用法如下所示

Java

User user = null;
Optional.ofNullable(user).orElseThrow(()->new Exception("用戶不存在"));

瀏覽器Flash插件異常，複製失敗！

3、map(Function<? super T, ? extends U> mapper)和flatMap(Function<? super T, Optional<U>> mapper)

這兩個函數放在一組記憶，這兩個函數做的是轉換值的操作。

直接上源碼

Java

 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));
        }
    }
}

瀏覽器Flash插件異常，複製失敗！

這兩個函數，在函數體上沒什麼區別。唯一區別的就是入參，map函數所接受的入參類型爲Function<? super T, ? extends U>，而flapMap的入參類型爲Function<? super T, Optional<U>>。

在具體用法上，對於map而言：

如果User結構是下面這樣的

Java

public class User {
    private String name;
    public String getName() {
        return name;
    }
}

瀏覽器Flash插件異常，複製失敗！

這時候取name的寫法如下所示

Java

String city = Optional.ofNullable(user).map(u-> u.getName()).get();

瀏覽器Flash插件異常，複製失敗！

對於flatMap而言:

如果User結構是下面這樣的

Java

public class User {
    private String name;
    public Optional<String> getName() {
        return Optional.ofNullable(name);
    }
}

瀏覽器Flash插件異常，複製失敗！

這時候取name的寫法如下所示

Java

String city = Optional.ofNullable(user).flatMap(u-> u.getName()).get();

瀏覽器Flash插件異常，複製失敗！

4、isPresent()和ifPresent(Consumer<? super T> consumer)

這兩個函數放在一起記憶，isPresent即判斷value值是否爲空，而ifPresent就是在value值不爲空時，做一些操作。這兩個函數的源碼如下

Java

public final class Optional<T> {
    //省略....
    public boolean isPresent() {
        return value != null;
    }
    //省略...
    public void ifPresent(Consumer<? super T> consumer) {
        if (value != null)
            consumer.accept(value);
    }
}

瀏覽器Flash插件異常，複製失敗！

需要額外說明的是，大家千萬不要把

Java

if (user != null){
   // TODO: do something
}

瀏覽器Flash插件異常，複製失敗！

給寫成

Java

User user = Optional.ofNullable(user);
if (Optional.isPresent()){
   // TODO: do something
}

瀏覽器Flash插件異常，複製失敗！

因爲這樣寫，代碼結構依然醜陋。博主會在後面給出正確寫法

至於ifPresent(Consumer<? super T> consumer)，用法也很簡單，如下所示

Java

Optional.ofNullable(user).ifPresent(u->{
    // TODO: do something
});

瀏覽器Flash插件異常，複製失敗！

5、filter(Predicate<? super T> predicate)

不多說，直接上源碼

Java

public final class Optional<T> {
    //省略....
   Objects.requireNonNull(predicate);
        if (!isPresent())
            return this;
        else
            return predicate.test(value) ? this : empty();
}

瀏覽器Flash插件異常，複製失敗！

filter 方法接受一個 Predicate 來對 Optional 中包含的值進行過濾，如果包含的值滿足條件，那麼還是返回這個 Optional；否則返回 Optional.empty。

用法如下

Java

Optional<User> user1 = Optional.ofNullable(user).filter(u -> u.getName().length()<6);

瀏覽器Flash插件異常，複製失敗！

如上所示，如果user的name的長度是小於6的，則返回。如果是大於6的，則返回一個EMPTY對象。

實戰使用

例一

在函數方法中

以前寫法

Java

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("取值錯誤"); 
    }

瀏覽器Flash插件異常，複製失敗！

JAVA8寫法

Java

public String getCity(User user) throws Exception{
    return Optional.ofNullable(user)
                   .map(u-> u.getAddress())
                   .map(a->a.getCity())
                   .orElseThrow(()->new Exception("取指錯誤"));
}

瀏覽器Flash插件異常，複製失敗！

例二

比如，在主程序中

以前寫法

Java

if(user!=null){
    dosomething(user);
}

瀏覽器Flash插件異常，複製失敗！

JAVA8寫法

Java

 Optional.ofNullable(user)
    .ifPresent(u->{
        dosomething(u);
});

瀏覽器Flash插件異常，複製失敗！

例三

以前寫法

Java

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;
    }
}

瀏覽器Flash插件異常，複製失敗！

java8寫法

Java

public User getUser(User user) {
    return Optional.ofNullable(user)
                   .filter(u->"zhangsan".equals(u.getName()))
                   .orElseGet(()-> {
                        User user1 = new User();
                        user1.setName("zhangsan");
                        return user1;
                   });
}

瀏覽器Flash插件異常，複製失敗！

其他的例子，不一一列舉了。不過，博主認爲，其實採用這種鏈式編程，雖然代碼優雅了。但是，邏輯性沒那麼明顯，可讀性有所降低，大家項目中看情況酌情使用。

作者：孤獨煙出處： http://rjzheng.cnblogs.com/

JAVA8 Optional 妙用解決對象/實體判空問題

引言

API介紹

實戰使用

Win10 LTSC 2019 安裝後的一些步驟

Python 潮流週刊#52：Python 處理 Excel 的資源

Centos7 安裝部署Nacos服務

Nacos註冊中心，服務註冊時加入自定義元數據，把各個服務的接口信息放入服務元數據裏

搞定Git多賬戶配置，一臺電腦多個Git賬戶

SpringCloud-Gateway配置過濾器徹底解決跨域問題

三分鐘搭建自己的Maven私服倉庫 - Centos 7安裝Nexus3

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結

JAVA8 Optional 妙用 解決對象/實體判空問題

引言

API介紹

實戰使用

JAVA8 Optional 妙用解決對象/實體判空問題