java~Optional語法糖(tang)
一、簡介
Optional類是(shi)Java8為(wei)了解(jie)決null值(zhi)判(pan)(pan)斷問題,借鑒(jian)google guava類庫的(de)(de)Optional類而引入(ru)的(de)(de)一個同名Optional類,使用Optional類可以避免顯式的(de)(de)null值(zhi)判(pan)(pan)斷(null的(de)(de)防御性檢查),避免null導致的(de)(de)NPE(NullPointerException)。
- 我們來看一段代碼:
public static String getGender(Student student)
{
if(null == student)
{
return "Unkown";
}
return student.getGender();
}
這是(shi)一個(ge)獲取學生性別的方法,方法入(ru)參為(wei)一個(ge)Student對(dui)象,為(wei)了防止student對(dui)象為(wei)null, 做了防御性檢查:如果值為(wei)null,返回"Unkown"。
- 再看使用Optional優化后的方法:
public static String getGender(Student student)
{
return Optional.ofNullable(student).map(u -> u.getGender()).orElse("Unkown");
}
可以(yi)看到,Optional類結合lambda表達式的(de)使用能夠讓開發出(chu)的(de)代碼(ma)更簡潔(jie)和優雅。
二、Optional對象的創建
我們看下(xia)Optional類(lei)的部分源(yuan)碼:
private static final Optional<?> EMPTY = new Optional<>();
private final T value;
private Optional() {
this.value = null;
}
public static<T> Optional<T> empty() {
@SuppressWarnings("unchecked")
Optional<T> t = (Optional<T>) EMPTY;
return t;
}
private Optional(T value) {
this.value = Objects.requireNonNull(value);
}
public static <T> Optional<T> of(T value) {
return new Optional<>(value);
}
public static <T> Optional<T> ofNullable(T value) {
return value == null ? empty() : of(value);
}
可以看(kan)出,Optional類(lei)的兩個(ge)構造方法都是(shi)private型(xing)的,因(yin)此類(lei)外部(bu)不能(neng)顯(xian)示的使用(yong)new Optional()的方式來創建Optional對象,但是(shi)Optional類(lei)提供了三個(ge)靜態方法empty()、of(T value)、ofNullable(T value)來創建Optinal對象,示例如下:
- 創建一個包裝對象值為空的Optional對象
OptionaloptStr = Optional.empty(); - 創建包裝對象值非空的Optional對象
OptionaloptStr1 = Optional.of("optional"); - 創建包裝對象值允許為空的Optional對象
OptionaloptStr2 = Optional.ofNullable(null);
三、Optional 類典型接口的使用
下面以一些(xie)典型場景為例,列出Optional API常用(yong)接口的用(yong)法,并附上相應代碼。
- 3.1 get()方法
簡單看下get()方法的源碼:
public T get() {
if (value == null) {
throw new NoSuchElementException("No value present");
}
return value;
}
可以看到,get()方法主要用于返回包(bao)裝對象的實際值,但是(shi)如果包(bao)裝對象值為null,會拋(pao)出(chu)NoSuchElementException異常。
- 3.2 isPresent()方法
isPresent()方法的源碼:
public boolean isPresent() {
return value != null;
}
可以看到(dao),isPresent()方(fang)法用于判斷包(bao)裝對象的(de)值是否非空(kong)。下面我(wo)們來看一段糟糕的(de)代碼:
public static String getGender(Student student)
{
Optional<Student> stuOpt = Optional.ofNullable(student);
if(stuOpt.isPresent())
{
return stuOpt.get().getGender();
}
return "Unkown";
}
這(zhe)段代碼實現的(de)是(shi)第一章(簡介(jie))中的(de)邏輯,但是(shi)這(zhe)種用法不但沒(mei)有減少(shao)null的(de)防御性(xing)檢查,而且增加了(le)Optional包裝的(de)過程,違背(bei)了(le)Optional設(she)計的(de)初衷,因此開發(fa)中要避免這(zhe)種糟(zao)糕的(de)使用~
- 3.3 ifPresent()方法
ifPresent()方法的源碼:
public void ifPresent(Consumer<? super T> consumer) {
if (value != null)
consumer.accept(value);
}
ifPresent()方法(fa)接受一個Consumer對(dui)象(xiang)(消費函(han)數),如(ru)果(guo)包(bao)裝對(dui)象(xiang)的值非空,運行Consumer對(dui)象(xiang)的accept()方法(fa)。示(shi)例如(ru)下:
public static void printName(Student student)
{
Optional.ofNullable(student).ifPresent(u -> System.out.println("The student name is : " + u.getName()));
}
上述示例用于打印學生姓名,由于ifPresent()方法內部做了null值檢查,調用前無需擔心NPE問題。
3.4 filter()方法
filter()方法的源碼:
public Optional<T> filter(Predicate<? super T> predicate) {
Objects.requireNonNull(predicate);
if (!isPresent())
return this;
else
return predicate.test(value) ? this : empty();
}
filter()方(fang)法接受(shou)參數為Predicate對(dui)象,用于對(dui)Optional對(dui)象進行過濾,如果(guo)符合Predicate的(de)條件(jian),返回(hui)Optional對(dui)象本身,否(fou)則(ze)返回(hui)一個空的(de)Optional對(dui)象。舉(ju)例如下:
public static void filterAge(Student student)
{
Optional.ofNullable(student).filter( u -> u.getAge() > 18).ifPresent(u -> System.out.println("The student age is more than 18."));
}
上(shang)述(shu)示例(li)中,實現(xian)了年(nian)齡(ling)大于18的學生的篩選。
- 3.5 map()方法
map()方法的源碼:
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));
}
}
map()方法(fa)的(de)參數(shu)為Function(函數(shu)式接口)對象(xiang)(xiang)(xiang),map()方法(fa)將Optional中(zhong)的(de)包裝對象(xiang)(xiang)(xiang)用Function函數(shu)進行(xing)運(yun)算,并包裝成新的(de)Optional對象(xiang)(xiang)(xiang)(包裝對象(xiang)(xiang)(xiang)的(de)類型可能改變)。舉例如下(xia):
public static Optional<Integer> getAge(Student student)
{
return Optional.ofNullable(student).map(u -> u.getAge());
}
上述代碼中,先用ofNullable()方法構造一個Optional
- 3.6 flatMap()方法
flatMap()方法的源碼:
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函數的返回值類型為Optional類型,而不是U類型,這樣flatMap()能將一個二維的Optional對象映射成一個一維的對象。以3.5中示例功能為例,進行faltMap()改寫如下:
public static Optional<Integer> getAge(Student student)
{
return Optional.ofNullable(student).flatMap(u -> Optional.ofNullable(u.getAge()));
}
- 3.7 orElse()方法
orElse()方法的源碼:
public T orElse(T other) {
return value != null ? value : other;
}
orElse()方(fang)法功(gong)能比較簡(jian)單(dan),即如果包裝對象值(zhi)(zhi)非(fei)空,返回包裝對象值(zhi)(zhi),否則返回入(ru)參other的值(zhi)(zhi)(默認值(zhi)(zhi))。如第一章(zhang)(簡(jian)介)中提到(dao)的代(dai)碼(ma):
public static String getGender(Student student)
{
return Optional.ofNullable(student).map(u -> u.getGender()).orElse("Unkown");
}
3.7 orElseGet()方法
orElseGet()方法的源碼:
public T orElseGet(Supplier<? extends T> other) {
return value != null ? value : other.get();
}
orElseGet()方(fang)法(fa)與orElse()方(fang)法(fa)類似,區別(bie)在于orElseGet()方(fang)法(fa)的入參(can)為一個Supplier對象(供應者(zhe)),用Supplier對象的get()方(fang)法(fa)的返回值作(zuo)為默認值。如:
public static String getGender(Student student)
{
return Optional.ofNullable(student).map(u -> u.getGender()).orElseGet(() -> "Unkown");
}
- 3.8 orElseThrow()方法
orElseThrow()方法的源碼:
public <X extends Throwable> T orElseThrow(Supplier<? extends X> exceptionSupplier) throws X {
if (value != null) {
return value;
} else {
throw exceptionSupplier.get();
}
}
orElseThrow()方法其實與orElseGet()方法非常(chang)(chang)相似了,入參都是Supplier對(dui)象,只不(bu)過orElseThrow()的Supplier對(dui)象必須返回(hui)一個Throwable異(yi)常(chang)(chang),并在orElseThrow()中(zhong)將異(yi)常(chang)(chang)拋出:
public static String getGender1(Student student)
{
return Optional.ofNullable(student).map(u -> u.getGender()).orElseThrow(() -> new RuntimeException("Unkown"));
}
orElseThrow()方法適用于包裝對象值為空時需要拋出特(te)定異常的場(chang)景。