Java 8 Optional類深度解析

        思考: 調用一個方法獲得了返回值卻不能直接將返回值做爲參數去調用別的方法。html

原來解決方案: 咱們首先要判斷這個返回值是否爲null,只有在非空的前提下才能將其做爲其餘方法的參數。這正是一些相似Guava的外部API試圖解決的問題。java

        一些JVM編程語言好比Scala、Ceylon等已經將對在覈心API中解決了這個問題。git

 

新版本的Java,好比Java 8引入了一個新的Optional類。Optional類的Javadoc描述以下:express

這是一個能夠爲null的容器對象。若是值存在則isPresent()方法會返回true,調用get()方法會返回該對象。編程

本文會逐個探討Optional類包含的方法,並經過一兩個示例展現如何使用。api

ofbash

爲非null的值建立一個Optional。app

  of方法經過工廠方法建立Optional類。須要注意的是,建立對象時傳入的參數不能爲null。若是傳入參數爲null,則拋出NullPointerException 。less

1
2
3
4
//調用工廠方法建立Optional實例
Optional<String> name = Optional.of( "Sanaulla" );
//傳入參數爲null,拋出NullPointerException.
Optional<String> someNull = Optional.of( null );

ofNullable編程語言

爲指定的值建立一個Optional,若是指定的值爲null,則返回一個空的Optional。

ofNullable與of方法類似,惟一的區別是能夠接受參數爲null的狀況。示例以下:

1
2
3
//下面建立了一個不包含任何值的Optional實例
//例如,值爲'null'
Optional empty = Optional.ofNullable( null );

isPresent

很是容易理解

若是值存在返回true,不然返回false。

相似下面的代碼:

1
2
3
4
5
//isPresent方法用來檢查Optional實例中是否包含值
if (name.isPresent()) {
   //在Optional實例內調用get()返回已存在的值
   System.out.println(name.get()); //輸出Sanaulla
}

get

若是Optional有值則將其返回,不然拋出NoSuchElementException。

上面的示例中,get方法用來獲得Optional實例中的值。下面咱們看一個拋出NoSuchElementException的例子:

1
2
3
4
5
6
7
//執行下面的代碼會輸出:No value present
try {
   //在空的Optional實例上調用get(),拋出NoSuchElementException
   System.out.println(empty.get());
} catch (NoSuchElementException ex) {
   System.out.println(ex.getMessage());
}

ifPresent  

若是Optional實例有值則爲其調用consumer,不然不作處理

要理解ifPresent方法,首先須要瞭解Consumer類。簡答地說,Consumer類包含一個抽象方法。該抽象方法對傳入的值進行處理,但沒有返回值。

Java8支持不用接口直接經過lambda表達式傳入參數。

若是Optional實例有值,調用ifPresent()能夠接受接口段或lambda表達式。相似下面的代碼:

1
2
3
4
5
//ifPresent方法接受lambda表達式做爲參數。
//lambda表達式對Optional的值調用consumer進行處理。
name.ifPresent((value) -> {
   System.out.println( "The length of the value is: " + value.length());
return 「adf」;//此處不能夠有返回值
});
 

orElse

若是有值則將其返回,不然返回指定的其它值。

若是Optional實例有值則將其返回,不然返回orElse方法傳入的參數。示例以下:

1
2
3
4
5
6
//若是值不爲null,orElse方法返回Optional實例的值。
//若是爲null,返回傳入的消息。
//輸出:There is no value present!
System.out.println(empty.orElse( "There is no value present!" ));
//輸出:Sanaulla
System.out.println(name.orElse( "There is some value!" ));

orElseGet

orElseGet與orElse方法相似,區別在於獲得的默認值。orElse方法將傳入的字符串做爲默認值,orElseGet方法能夠接受Supplier接口的實現用來生成默認值。示例以下:

1
2
3
4
5
6
//orElseGet與orElse方法相似,區別在於orElse傳入的是默認值,
//orElseGet能夠接受一個lambda表達式生成默認值。
//輸出:Default Value
System.out.println(empty.orElseGet(() -> "Default Value" ));
//輸出:Sanaulla
System.out.println(name.orElseGet(() -> "Default Value" ));

orElseThrow

若是有值則將其返回,不然拋出supplier接口建立的異常。

在orElseGet方法中,咱們傳入一個Supplier接口。然而,在orElseThrow中咱們能夠傳入一個lambda表達式或方法,若是值不存在來拋出異常。示例以下:

1
2
3
4
5
6
7
8
9
try {
   //orElseThrow與orElse方法相似。與返回默認值不一樣,
   //orElseThrow會拋出lambda表達式或方法生成的異常
 
   empty.orElseThrow(ValueAbsentException:: new );
} catch (Throwable ex) {
   //輸出: No value present in the Optional instance
   System.out.println(ex.getMessage());
}

ValueAbsentException定義以下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
class ValueAbsentException extends Throwable {
 
   public ValueAbsentException() {
     super ();
   }
 
   public ValueAbsentException(String msg) {
     super (msg);
   }
 
   @Override
   public String getMessage() {
     return "No value present in the Optional instance" ;
   }
}

map

map方法文檔說明以下:

若是有值,則對其執行調用mapping函數獲得返回值。若是返回值不爲null,則建立包含mapping返回值的Optional做爲map方法返回值,不然返回空Optional。

map方法用來對Optional實例的值執行一系列操做。經過一組實現了Function接口的lambda表達式傳入操做。map方法示例以下:

1
2
3
4
//map方法執行傳入的lambda表達式參數對Optional實例的值進行修改。
//爲lambda表達式的返回值建立新的Optional實例做爲map方法的返回值。
Optional<String> upperName = name.map((value) -> value.toUpperCase());
System.out.println(upperName.orElse( "No value found" ));

flatMap

若是有值,爲其執行mapping函數返回Optional類型返回值,不然返回空Optional。flatMap與map(Funtion)方法相似,區別在於flatMap中的mapper返回值必須是Optional。調用結束時,flatMap不會對結果用Optional封裝。

flatMap方法與map方法相似,區別在於mapping函數的返回值不一樣。map方法的mapping函數返回值能夠是任何類型T,而flatMap方法的mapping函數必須是Optional。

參照map函數,使用flatMap重寫的示例以下:

1
2
3
4
5
//flatMap與map(Function)很是相似,區別在於傳入方法的lambda表達式的返回類型。
//map方法中的lambda表達式返回值能夠是任意類型,在map函數返回以前會包裝爲Optional。
//但flatMap方法中的lambda表達式返回值必須是Optionl實例。
upperName = name.flatMap((value) -> Optional.of(value.toUpperCase()));
System.out.println(upperName.orElse( "No value found" )); //輸出SANAULLA

filter

filter個方法經過傳入限定條件對Optional實例的值進行過濾。文檔描述以下:

若是有值而且知足斷言條件返回包含該值的Optional,不然返回空Optional。

讀到這裏,可能你已經知道如何爲filter方法傳入一段代碼。是的,這裏能夠傳入一個lambda表達式。對於filter函數咱們應該傳入實現了Predicate接口的lambda表達式。若是你不熟悉Predicate接口,能夠參考這篇文章

如今我來看看filter的各類用法,下面的示例介紹了知足限定條件和不知足兩種狀況:

1
2
3
4
5
6
7
8
9
10
//filter方法檢查給定的Option值是否知足某些條件。
//若是知足則返回同一個Option實例,不然返回空Optional。
Optional<String> longName = name.filter((value) -> value.length() > 6 );
System.out.println(longName.orElse( "The name is less than 6 characters" )); //輸出Sanaulla
 
//另外一個例子是Optional值不知足filter指定的條件。
Optional<String> anotherName = Optional.of( "Sana" );
Optional<String> shortName = anotherName.filter((value) -> value.length() > 6 );
//輸出:name長度不足6字符
System.out.println(shortName.orElse( "The name is less than 6 characters" ));

以上,咱們介紹了Optional類的各個方法。下面經過一個完整的示例對用法集中展現:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
public class OptionalDemo {
 
   public static void main(String[] args) {
     //建立Optional實例,也能夠經過方法返回值獲得。
     Optional<String> name = Optional.of( "Sanaulla" );
 
     //建立沒有值的Optional實例,例如值爲'null'
     Optional empty = Optional.ofNullable( null );
 
     //isPresent方法用來檢查Optional實例是否有值。
     if (name.isPresent()) {
       //調用get()返回Optional值。
       System.out.println(name.get());
     }
 
     try {
       //在Optional實例上調用get()拋出NoSuchElementException。
       System.out.println(empty.get());
     } catch (NoSuchElementException ex) {
       System.out.println(ex.getMessage());
     }
 
     //ifPresent方法接受lambda表達式參數。
     //若是Optional值不爲空,lambda表達式會處理並在其上執行操做。
     name.ifPresent((value) -> {
       System.out.println( "The length of the value is: " + value.length());
     });
 
     //若是有值orElse方法會返回Optional實例,不然返回傳入的錯誤信息。
     System.out.println(empty.orElse( "There is no value present!" ));
     System.out.println(name.orElse( "There is some value!" ));
 
     //orElseGet與orElse相似,區別在於傳入的默認值。
     //orElseGet接受lambda表達式生成默認值。
     System.out.println(empty.orElseGet(() -> "Default Value" ));
     System.out.println(name.orElseGet(() -> "Default Value" ));
 
     try {
       //orElseThrow與orElse方法相似,區別在於返回值。
       //orElseThrow拋出由傳入的lambda表達式/方法生成異常。
       empty.orElseThrow(ValueAbsentException:: new );
     } catch (Throwable ex) {
       System.out.println(ex.getMessage());
     }
 
     //map方法經過傳入的lambda表達式修改Optonal實例默認值。
     //lambda表達式返回值會包裝爲Optional實例。
     Optional<String> upperName = name.map((value) -> value.toUpperCase());
     System.out.println(upperName.orElse( "No value found" ));
 
     //flatMap與map(Funtion)很是類似,區別在於lambda表達式的返回值。
     //map方法的lambda表達式返回值能夠是任何類型,可是返回值會包裝成Optional實例。
     //可是flatMap方法的lambda返回值老是Optional類型。
     upperName = name.flatMap((value) -> Optional.of(value.toUpperCase()));
     System.out.println(upperName.orElse( "No value found" ));
 
     //filter方法檢查Optiona值是否知足給定條件。
     //若是知足返回Optional實例值,不然返回空Optional。
     Optional<String> longName = name.filter((value) -> value.length() > 6 );
     System.out.println(longName.orElse( "The name is less than 6 characters" ));
 
     //另外一個示例,Optional值不知足給定條件。
     Optional<String> anotherName = Optional.of( "Sana" );
     Optional<String> shortName = anotherName.filter((value) -> value.length() > 6 );
     System.out.println(shortName.orElse( "The name is less than 6 characters" ));
 
   }
 
}

上述代碼輸出以下:

1
2
3
4
5
6
7
8
9
10
11
12
Sanaulla
No value present
The length of the value is: 8
There is no value present!
Sanaulla
Default Value
Sanaulla
No value present in the Optional instance
SANAULLA
SANAULLA
Sanaulla
The name is less than 6 characters

 

 

實例展現

假若有一個Person 對象,它有一個Address 屬性,而Address屬性還嵌套一個validFrom的日期。全部的值均可能是null。
好了,如今咱們來判斷一下Person 的這些屬性是不是Valid的。

1
2
3
4
5
6
7
8
9
10
private boolean validAddress(NullPerson person{
    if (person != null{
        if (person.getAddress(!= null{
            final Instant validFrom = person.getAddress().getValidFrom();
            return validFrom != null && validFrom.isBefore(now());
        else
            return false;
    else
        return false;
}

或者也能夠這麼寫:

1
2
3
4
return person != null &&
       person.getAddress(!= null &&
       person.getAddress().getValidFrom(!= null &&
       person.getAddress().getValidFrom().isBefore(now());

總之 都不是很好看。

但若是這些屬性都是Optional,那麼看起來會稍微舒服一點。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
class Person {
 
    private final Optional<Address> address;
 
    public Optional<Address> getAddress({
        return address;
    }
 
    //...
}
 
class Address {
    private final Optional<Instant> validFrom;
 
    public Optional<Instant> getValidFrom({
        return validFrom;
    }

    //...
}

如下代碼就實現了同樣的判斷:

1
2
3
4
5
return person.
        flatMap(Person::getAddress).
        flatMap(Address::getValidFrom).
        filter(x -> x.before(now())).
        isPresent();

使用Optional之後,NullPointerException 就今後消失了。

將一個Optional轉爲List或者Set

Optional是一個集合,雖然裏面只有0或者1個元素,但它同樣是一個集合。若是要轉爲List或者Set,通常的寫法能夠是:

1
2
3
4
5
public static <T> List<T> toList(Optional<T> option{
    return option.
            map(Collections::singletonList).
            orElse(Collections.emptyList());
}

或者更傳統的寫法:

1
2
3
4
5
6
public static <T> List<T> toList(Optional<T> option{
    if (option.isPresent())
        return Collections.singletonList(option.get());
    else
        return Collections.emptyList();
}

可是在java8裏,其實只須要這麼寫:

1
2
3
4
5
import static java.util.stream.Collectors.*;
//轉爲List
List<String> list = collect(opt, toList());
//轉爲Set
Set<String>  set  = collect(opt, toSet());

本文代碼內容來自於:http://www.nurkiewicz.com/2013/08/optional-in-java-8-cheat-sheet.html

相關文章
相關標籤/搜索