1. 程式人生 > 其它 >java~Optional語法糖

java~Optional語法糖

一、簡介
Optional類是Java8為了解決null值判斷問題,借鑑google guava類庫的Optional類而引入的一個同名Optional類,使用Optional類可以避免顯式的null值判斷(null的防禦性檢查),避免null導致的NPE(NullPointerException)。

  • 我們來看一段程式碼:
    public static String getGender(Student student)
    {
        if(null == student)
        {
            return "Unkown";
        }
        return student.getGender();
        
    }

這是一個獲取學生性別的方法,方法入參為一個Student物件,為了防止student物件為null, 做了防禦性檢查:如果值為null,返回"Unkown"。

  • 再看使用Optional優化後的方法:
    public static String getGender(Student student)
    {
       return Optional.ofNullable(student).map(u -> u.getGender()).orElse("Unkown");       
    }

可以看到,Optional類結合lambda表示式的使用能夠讓開發出的程式碼更簡潔和優雅。

二、Optional物件的建立

我們看下Optional類的部分原始碼:

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

可以看出,Optional類的兩個構造方法都是private型的,因此類外部不能顯示的使用new Optional()的方式來建立Optional物件,但是Optional類提供了三個靜態方法empty()、of(T value)、ofNullable(T value)來建立Optinal物件,示例如下:

  1. 建立一個包裝物件值為空的Optional物件
    Optional optStr = Optional.empty();
  2. 建立包裝物件值非空的Optional物件
    Optional optStr1 = Optional.of("optional");
  3. 建立包裝物件值允許為空的Optional物件
    Optional optStr2 = Optional.ofNullable(null);

三、Optional 類典型介面的使用

下面以一些典型場景為例,列出Optional API常用介面的用法,並附上相應程式碼。

  • 3.1 get()方法
    簡單看下get()方法的原始碼:
    public T get() {
        if (value == null) {
            throw new NoSuchElementException("No value present");
        }
        return value;
    }

可以看到,get()方法主要用於返回包裝物件的實際值,但是如果包裝物件值為null,會丟擲NoSuchElementException異常。

  • 3.2 isPresent()方法
    isPresent()方法的原始碼:
    public boolean isPresent() {
        return value != null;
    }

可以看到,isPresent()方法用於判斷包裝物件的值是否非空。下面我們來看一段糟糕的程式碼:

    public static String getGender(Student student)
    {
        Optional<Student> stuOpt =  Optional.ofNullable(student);
        if(stuOpt.isPresent())
        {
            return stuOpt.get().getGender();
        }
        
        return "Unkown";
    }

這段程式碼實現的是第一章(簡介)中的邏輯,但是這種用法不但沒有減少null的防禦性檢查,而且增加了Optional包裝的過程,違背了Optional設計的初衷,因此開發中要避免這種糟糕的使用~

  • 3.3 ifPresent()方法
    ifPresent()方法的原始碼:
    public void ifPresent(Consumer<? super T> consumer) {
        if (value != null)
            consumer.accept(value);
    }

ifPresent()方法接受一個Consumer物件(消費函式),如果包裝物件的值非空,執行Consumer物件的accept()方法。示例如下:

    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()方法接受引數為Predicate物件,用於對Optional物件進行過濾,如果符合Predicate的條件,返回Optional物件本身,否則返回一個空的Optional物件。舉例如下:

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

上述示例中,實現了年齡大於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()方法的引數為Function(函式式介面)物件,map()方法將Optional中的包裝物件用Function函式進行運算,幷包裝成新的Optional物件(包裝物件的型別可能改變)。舉例如下:

    public static Optional<Integer> getAge(Student student)
    {
        return Optional.ofNullable(student).map(u -> u.getAge()); 
    }

上述程式碼中,先用ofNullable()方法構造一個Optional物件,然後用map()計算學生的年齡,返回Optional物件(如果student為null, 返回map()方法返回一個空的Optinal物件)。

  • 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()方法功能比較簡單,即如果包裝物件值非空,返回包裝物件值,否則返回入參other的值(預設值)。如第一章(簡介)中提到的程式碼:

    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()方法與orElse()方法類似,區別在於orElseGet()方法的入參為一個Supplier物件(供應者),用Supplier物件的get()方法的返回值作為預設值。如:

   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()方法非常相似了,入參都是Supplier物件,只不過orElseThrow()的Supplier物件必須返回一個Throwable異常,並在orElseThrow()中將異常丟擲:

    public static String getGender1(Student student)
    {
        return Optional.ofNullable(student).map(u -> u.getGender()).orElseThrow(() -> new RuntimeException("Unkown"));      
    }

orElseThrow()方法適用於包裝物件值為空時需要丟擲特定異常的場景。