引言
今天在專案中看到了大量Optional的使用，之前我也瞭解過Optional，是Java8中的新特性，並且便利地為空指標問題提供了處理方法，可以避免繁瑣的if/else。
但是並沒有真正在專案中使用過Optional，現在就來詳細地學習一下Optional的用法以及原始碼實現。
構造器方法
- Optional.of(T t) : 建立一個 Optional 例項，t 必須非空
- Optional.empty() : 建立一個空的 Optional 例項
- Optional.ofNullable(T t)：t 可以為 null
Optional.of(T t)
/**
* 有參構造
使用描述的值構造一個例項。
引數：值–要描述的非null值
丟擲：NullPointerException如果值為null
*/
private Optional(T value) {
this.value = Objects.requireNonNull(value);
}
//Objects.java
public static <T> T requireNonNull(T obj) {
if (obj == null)
throw new NullPointerException();
return obj;
}
/**
返回一個Optional描述給定的非null值。
引數：value 要描述的值，必須為非null
型別引數：<T> –值的型別
返回值：存在值的Optional，若為null則丟擲NullPointerException異常
*/
public static <T> Optional<T> of(T value) {
return new Optional<> (value);
}
Optional.empty()
private static final Optional<?> EMPTY = new Optional<>();
private Optional() {
this.value = null;
}
/**
返回一個空的Optional例項。 此Optional沒有值。
型別引數：<T> 不存在的值的型別
返回值：一個空的Optional
api注意：
儘管這樣做可能很誘人，但應透過將==與Optional.empty()返回的例項進行比較來避免測試物件是否為空。
不能保證它是一個單例。 而是使用isPresent()
*/
public static<T> Optional<T> empty() {
@SuppressWarnings("unchecked")
Optional<T> t = (Optional<T>) EMPTY;
return t;
}
Optional.ofNullable(T t)
/**
返回一個描述給定值的Optional ，如果為null ，則返回一個空的Optional,否則返回給定值的Optional 。
引數：值描述的可能為null值
型別引數：<T> –值的型別
返回值：一個Optional與如果指定值是非當前值null ，否則一個空Optional
*/
public static <T> java.util.Optional<T> ofNullable(T value) {
return value == null ? empty() : of(value);
}
獲取類方法
- T get(): 如果呼叫物件包含值不為 null，返回該值，否則拋異常
- T orElse(T other) ：如果有值則將其返回，否則返回指定的 other 物件
- T orElseGet(Supplier<? extends T> other) ：如果有值則將其返回，否則返回由 Supplier 介面實現提供的物件。
- T orElseThrow(Supplier<? extends X> exceptionSupplier) ：如果有值則將其返回，否則丟擲由 Supplier
Optional.get()
/**
如果存在值，則返回該值，否則丟擲NoSuchElementException 。
返回值：此Optional描述的非null值
丟擲：NoSuchElementException如果不存在任何值
api注意：此方法的首選替代方法是orElseThrow()
*/
public T get() {
if (value == null) {
throw new NoSuchElementException("No value present");
}
return value;
}
Optional.orElse(T other)
/**
如果存在值，則返回該值，否則返回other 。
引數：其他–要返回的值（如果不存在任何值）。 可以為null 。
返回值：值（如果存在），否則other
*/
public T orElse(T other) {
return value != null ? value : other;
}
Optional.orElseGet(Supplier<? extends T> other)
/**
如果存在值，則返回該值，否則返回由供應函式supplier產生的結果。
返回值：如果不存在值，且supplier為null,則丟擲NullPointerException
*/
public T orElseGet(Supplier<? extends T> supplier) {
return value != null ? value : supplier.get();
}
Optional.orElseThrow(Supplier<? extends X> exceptionSupplier)
/**
與get 方法相同
*/
public T orElseThrow() {
if (value == null) {
throw new NoSuchElementException("No value present");
}
return value;
}
/**
如果存在值，則返回該值，否則丟擲由異常提供函式產生的異常。
型別引數：<X> –引發的異常型別
返回值：值（如果存在）
丟擲：X –如果不存在任何值NullPointerException如果不存在任何值並且異常提供函式為null
api注意：帶有空引數列表的對異常建構函式的方法引用可用作提供者
*/
public <X extends Throwable> T orElseThrow(Supplier<? extends X> exceptionSupplier) throws X {
if (value != null) {
return value;
} else {
throw exceptionSupplier.get();
}
}
or(Supplier<? extends Optional<? extends T>> supplier)
/**如果值存在時，返回一個Optional描述的值，否則將返回一個Optional產生透過供給功能。
引數：供應商–產生要返回的Optional的供應功能
返回值：返回一個Optional描述此的值Optional ，如果一個值存在，否則Optional所生產的供應功能。
丟擲：NullPointerException如果提供的函式為null或產生null結果
* @since 9
*/
public Optional<T> or(Supplier<? extends Optional<? extends T>> supplier) {
Objects.requireNonNull(supplier);
if (isPresent()) {
return this;
} else {
@SuppressWarnings("unchecked")
Optional<T> r = (Optional<T>) supplier.get();
return Objects.requireNonNull(r);
}
}
判斷類方法
- boolean isPresent() : 判斷是否包含物件
- void ifPresent(Consumer<? super T> consumer) ：如果有值，就執行 Consumer 介面的實現程式碼，並且該值會作為引數傳給它。
- void ifPresentOrElse(Consumer<? super T> action, Runnable emptyAction) :如果有值，就執行 Consumer 介面的實現程式碼，並且該值會作為引數傳給它,否則執行 Runnable 介面的實現程式碼。
Optional.isPresent()
/**
判斷是否存在值
*/
public boolean isPresent() {
return value != null;
}
Optional.ifPresent(Consumer<? super T> consumer)
/**
如果存在值，則使用該值執行給定的操作，否則不執行任何操作。
引數：Consumer要執行的動作
*/
public void ifPresent(Consumer<? super T> action) {
if (value != null) {
action.accept(value);
}
}
Optional.ifPresentOrElse(Consumer<? super T> action, Runnable emptyAction)
/**
如果存在值，則使用該值執行給定的操作，否則執行給定的基於空的操作。
引數：動作–要執行的動作（如果存在值）emptyAction –要執行的基於空的操作（如果不存在任何值）
丟擲：如果存在一個值並且給定的操作為null ，或者不存在任何值並且給定的基於空的操作為null ，
則丟擲NullPointerException;
*/
public void ifPresentOrElse(Consumer<? super T> action, Runnable emptyAction) {
if (value != null) {
action.accept(value);
} else {
emptyAction.run();
}
}
過濾類方法
- Optional
filter(Predicate<? super predicate)：如果值存在，並且這個值匹配給定的 predicate，返回一個 Optional 用以描述這個值，否則返回一個空的 Optional。
Optional filter(Predicate<? super predicate)
/**
如果存在一個值，並且該值與給定的（predicate方法）匹配，則返回描述該值的Optional ，否則返回一個空的Optional 。
*/
public Optional<T> filter(Predicate<? super T> predicate) {
Objects.requireNonNull(predicate);
if (!isPresent()) {
return this;
} else {
return predicate.test(value) ? this : empty();
}
}
對映類方法
- < U >Optional< U > map(Function<? super T,? extends U> mapper)：如果有值，則對其執行呼叫對映函式得到返回值。如果返回值不為 null，則建立包含對映返回值的 Optional 作為 map 方法返回值，否則返回空 Optional。
- < U > Optional< U > flatMap(Function<? super T, Optional< U >> mapper)：如果值存在，就對該值執行提供的 mapping 函式呼叫，返回一個 Optional 型別的值，否則就返回一個空的 Optional 物件
< U >Optional< U > map(Function<? super T,? extends U> mapper)
/**
map方法接受一個對映函式引數，返回一個被Optional包裝的結果。若結果為空，則返回 空Optional 。
如果對映函式返回null結果，則此方法返回空的Optional
返回值型別：Optional物件
*/
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));
}
}
< U > Optional< U > flatMap(Function<? super T, ? extends Optional<? extends U>> mapper）
/**
flatMap 方法則要求入參中的函式式介面返回值本身就是 Optional 物件。
返回值：施加的結果Optional可以對映函式此的值Optional ，如果一個值存在，否則一個空Optional
丟擲：NullPointerException如果對映函式為null或返回null結果
*/
public <U> Optional<U> flatMap(Function<? super T, ? extends Optional<? extends U>> mapper) {
Objects.requireNonNull(mapper);
if (!isPresent()) {
return empty();
} else {
@SuppressWarnings("unchecked")
Optional<U> r = (Optional<U>) mapper.apply(value);
return Objects.requireNonNull(r);
}
}
專案中的使用
// 若取值為null則為""
String num = a.map(DTO::getA).map(A::getNum).orElse("");
// 若取值為null則為null
Long date = b.map(DTO::getB).map(B::getDate).orElse(null);