Optional类源码理解

---

前言

本文章帮助大家对Optional类的理解。

---

一、概述

Optional意为可选择的。顾名思义，此类可以表示“可空”对象，其提供方便的“可空”对象操作方法，如判空、非空则执行、过滤、映射等方法，以更好地处理NPE（空指针，Null Pointer Exception）问题。但它不能修改值。

它属于值类型。

二、源码理解

包

package java.util;

import java.util.Optional;

使用Optional类时，需引入此包。

Optional类

public final class Optional<T> { /*...*/ }

final类，无法继承。使用类时传入泛型T，为“可空”对象表示的值的类型。

Optional变量

EMPTY

private static final Optional<?> EMPTY = new Optional<>(null);

私有静态常量。表示null（空）的“可空”对象，类型为Object。

value

private final T value;

私有常量。代表此“可空”对象的值。

Optional方法

Optional

private Optional(T value) { this.value = value; }

构造函数，将值设为value。

empty

public static<T> Optional<T> empty() { /*...*/ }

静态方法，传入泛型T，为返回“可空”对象表示的值的类型。返回表示null的“可空”对象。

of

public static <T> Optional<T> of(T value) { /*...*/ }

静态方法，传入泛型T，为传入值及返回“可空”对象表示的值的类型。返回表示value的对象，但要求value非空。若value为空，则抛出NullPointerException异常。

ofNullable

public static <T> Optional<T> ofNullable(T value) { /*...*/ }

静态方法，传入泛型T，为传入值及返回“可空”对象表示的值的类型。返回表示value的对象。

equals

public boolean equals(Object obj) { /*...*/ }

重写Object类的boolean equals(Object obj)方法，参考Object.equals方法。

判断此对象与obj的表示值是否相等。相等的条件为：它们是相同对象，或obj也是一种“可空”对象且它们表示值相等（equals。可都为空）。

hashCode

public int hashCode() { /*...*/ }

重写Object类的int hashCode()方法，参考Object.hashCode方法。

返回此对象表示值的哈希码，若表示值为空，返回0。

toString

public String toString() { /*...*/ }

重写Object类的String toString()方法，参考Object.toString方法。

将此对象表示值“转换”为字符串，非空时返回 "Optional[" + value + "]"，为空时返回"Optional.empty"。

get

public T get() { /*...*/ }

若此对象表示值非空，返回此对象表示值；否则抛出NoSuchElementException异常。

注意：这里值为空的话是抛出异常，而不是返回null，且此方法与orElseThrow()方法逻辑一致，或许这样的实现不符期望。

isPresent

public boolean isPresent() { return value != null; }

判断此对象表示值是否非空。

isEmpty

public boolean isEmpty() { return value == null; }

判断此对象表示值是否为空。

ifPresent

public void ifPresent(Consumer<? super T> action) { /*...*/ }

若此对象表示值非空，对其调用action。参考Consumer接口。若表示值非空且action为空，则抛出NullPointerException异常。

ifPresentOrElse

public void ifPresentOrElse(Consumer<? super T> action, Runnable emptyAction) { /*...*/ }

若此对象表示值非空，对其调用action，否则运行emptyAction。参考Runnable接口。若表示值非空且action为空，或表示值为空且emptyAction为空，则抛出NullPointerException异常。

filter

public Optional<T> filter(Predicate<? super T> predicate) { /*...*/ }

若此对象表示值为空，或者表示值非空且符合predicate断言，返回此对象；否则返回表示null的对象。参考Predicate接口。若predicate为空，则抛出NullPointerException异常。

map

public <U> Optional<U> map(Function<? super T, ? extends U> mapper) { /*...*/ }

传入泛型U，为返回“可空”对象表示的值的类型。若表示值为空，返回表示null的对象；否则返回此对象表示值应用于mapper函数式的返回值代表的“可空”对象。参考Function接口。若mapper为空，则抛出NullPointerException异常。

flatMap

public <U> Optional<U> flatMap(Function<? super T, ? extends Optional<? extends U>> mapper) { /*...*/ }

传入泛型U，为返回“可空”对象表示的值的类型。若表示值为空，返回表示null的对象；否则返回此对象表示值应用于mapper函数式返回的“可空”对象。若mapper为空，或mapper返回“可空”对象为空，则抛出NullPointerException异常。

注意：此文章描述中“可空”对象指的是Optional类型的对象，而不指常指的“或空”对象。

or

public Optional<T> or(Supplier<? extends Optional<? extends T>> supplier) { /*...*/ }

若此对象表示值非空，返回此对象；否则返回供应器supplier提供的“可空”对象。参考Supplier接口。若supplier为空，或supplier返回“可空”对象为空，则抛出NullPointerException异常。

orElse

public T orElse(T other) { /*...*/ }

若此对象表示值非空，返回此对象表示值；否则返回other。

orElseGet

public T orElseGet(Supplier<? extends T> supplier) { /*...*/ }

若此对象表示值非空，返回此对象表示值；否则返回供应器supplier提供的值。若此对象表示值为空且supplier为空，则抛出NullPointerException异常。

orElseThrow

public T orElseThrow() { /*...*/ }

若此对象表示值非空，返回此对象表示值；否则抛出NoSuchElementException异常。且此方法与get()方法逻辑一致。

public <X extends Throwable> T orElseThrow(Supplier<? extends X> exceptionSupplier) throws X { /*...*/ }

传入泛型X，为异常供应器exceptionSupplier提供值的类型。若此对象表示值非空，返回此对象表示值；否则抛出异常供应器exceptionSupplier提供的异常。若此对象表示值为空且exceptionSupplier为空，则抛出NullPointerException异常。

注意：由于Supplier是一种函数式接口，可以使用异常的构造器new方法来作为参数，如：IllegalStateException::new。

stream

public Stream<T> stream() { /*...*/ }

若此对象表示值为空，返回空顺序流；否则返回包含此对象表示值的顺序流。参考Stream接口。

---

总结

新人源码理解，望大家多多指点。