オプションのソースコード分析と練習

1 はじめに

NullPointerException は開発過程でよく遭遇するもので、注意しないと小さなバグが発生します.この問題を回避すると、Optional はこの問題を解決するために特別に設計されたクラスです. 一緒に探検しましょう！

2 ソースコード解析

2.1 オプションの定義

Optional クラスは、Java8 で null 値判定の問題を解決するために作成されたコンテナ クラスであり、java.util では Optional クラスを使用することで、明示的な null 値判定を回避し、null による NullPointerException を回避できます。まず、Optional は、型 T の値または null コンテナー オブジェクトを保持できるコンテナーです。Optional コンテナーは、1 つの値のみを保持できます。

2.2 オプションのプロパティ

1) ソースコード:

/**
 * Common instance for {@code empty()}.
 */
private static final Optional<?> EMPTY = new Optional<>();


/**
 * If non-null, the value; if null, indicates no value is present
 */
private final T value;

ソース コードによると、Optional には 2 つのプロパティがあることがわかります。

2.3 オプションの方法

Optional には、toString()、hashCode()、equals() などの Object のメソッドに加えて、次のメソッドも含まれます。

2.3.1 プライベート コンストラクター

/**
 * Constructs an empty instance.
 *
 * @implNote Generally only one empty instance, {@link Optional#EMPTY},
 * should exist per VM.
 */
private Optional() {
    this.value = null;
}


/**
* Constructs an instance with the value present.
*
* @param value the non-null value to be present
* @throws NullPointerException if value is null
*/
private Optional(T value) {
    this.value = Objects.requireNonNull(value);
}

空のインスタンスを作成し、現在の値でインスタンスを構築します。

2.3.2 メソッドの作成

1) ソースコード

public static<T> Optional<T> empty() {
    @SuppressWarnings("unchecked")
    Optional<T> t = (Optional<T>) EMPTY;
    return t;
}
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);
}

2) メソッドの説明

• empty(): 空の Optional インスタンスを作成します
• of(T t) : Optional インスタンスを作成し、t が null の場合に例外をスローします
• ofNullable(T t): Optional インスタンスを作成しますが、t が null の場合は例外をスローしませんが、空のインスタンスを返します

3) テストコード

public static void main(String[] args) {
    Integer value1 = null;
    Integer value2 = 1;
    try {
        Optional<Integer> optional1 = Optional.empty();
        System.out.println("optional1创建了");
    }catch (Exception e){
        System.out.println("optional1失败了");
    }
    try {
        Optional<Integer> optional2 = Optional.of(value1);
        System.out.println("optional2创建了");
    }catch (Exception e){
        System.out.println("optional2失败了");
    }
    try {
        Optional<Integer> optional3 = Optional.ofNullable(value1);
        System.out.println("optional3创建了");
    }catch (Exception e){
        System.out.println("optional3失败了");
    }
    try {
        Optional<Integer> optional4 = Optional.of(value2);
        System.out.println("optional4创建了");
    }catch (Exception e){
        System.out.println("optional4失败了");
    }
    try {
        Optional<Integer> optional5 = Optional.ofNullable(value2);
        System.out.println("optional5创建了");
    }catch (Exception e){
        System.out.println("optional5失败了");
    }
}

4) 走行結果

 

2.3.3 値の取得方法

1) ソースコード

public T get() {
    if (value == null) {
        throw new NoSuchElementException("No value present");
    }
    return value;
}

2) メソッドの説明

get(): Optional が空でない場合は Optional コンテナーの値を返し、それ以外の場合は NoSuchElementExceptio をスローします。

3) テストコード

public static void main(String[] args) {
    Integer value1 = null;
    Integer value2 = 1;
    Optional<Integer> optional1 = Optional.ofNullable(value1);
    Optional<Integer> optional2 = Optional.of(value2);
    try {
        Integer result=optional1.get();
        System.out.println("optional1的值是："+result);
    }catch (Exception e){
        System.out.println("optional1的值获取失败,原因:"+e.getMessage());
    }
    try {
        Integer result=optional2.get();
        System.out.println("optional2的值是："+result);
    }catch (Exception e){
        System.out.println("optional2的值获取失败,原因:"+e.getMessage());
    }
}

4) 走行結果

 

2.3.4 判定方法

1) ソースコード

public boolean isPresent() {
    return value != null;
}
public void ifPresent(Consumer<? super T> consumer) {
    if (value != null)
        consumer.accept(value);
}
public T orElse(T other) {
    return value != null ? value : other;
 }   
public T orElseGet(Supplier<? extends T> other) {
     return value != null ? value : other.get();
}
public <X extends Throwable> T orElseThrow(Supplier<? extends X> exceptionSupplier) throws X {
   if (value != null) {
      return value;
   } else {
      throw exceptionSupplier.get();
   }
}

2) メソッドの説明

• isPresent(): オプションが空かどうかを判断し、空の場合は false を返し、それ以外の場合は true を返します
• ifPresent(Consumer c): optional が空でない場合、optional のオブジェクトを Consumer 関数に渡します
• orElse(T other): optional が空でない場合は optional のオブジェクトを返し、null の場合は other オブジェクトを返します。
• orElseGet(Supplier other): オプションが空でない場合は、オプションのオブジェクトを返します; null の場合は、他の関数を呼び出し、呼び出しの結果を返します
• orElseThrow(Supplier exception): optional が空でない場合は optional のオブジェクトを返し、null の場合は Supplier 関数によって生成された例外をスローします

3) テストコード

public static void main(String[] args) {
    Integer value1 = null;
    Integer value2 = 1;
    Optional<Integer> optional1 = Optional.ofNullable(value1);
    Optional<Integer> optional2 = Optional.of(value2);
    try {
        if(optional1.isPresent()){
            System.out.println("optional1的isPresent结果不为空");
        }else{
            System.out.println("optional1的isPresent结果为空");
        }
    }catch (Exception e){
        System.out.println("optional1的isPresent判空失败,原因:"+e.getMessage());
    }
    try {
        if(optional2.isPresent()){
            System.out.println("optional2的isPresent结果不为空");
        }else{
            System.out.println("optional2的isPresent结果为空");
        }
    }catch (Exception e){
        System.out.println("optional2的isPresent判空失败,原因:"+e.getMessage());
    }


    optional1.ifPresent(t->{
        int i =t+1;
        System.out.println("optional1处理后的值是"+i);
    });
    optional2.ifPresent(t->{
        int i =t+1;
        System.out.println("optional2处理后的值是"+i);});


    Integer value3 = 2;
    Integer result = optional1.orElse(value3);
    System.out.println("optional1执行orElse处理后的值是"+result);


    result = optional2.orElse(value3);
    System.out.println("optional2执行orElse处理后的值是"+result);


    result = optional1.orElseGet(()-> new Integer(-1));
    System.out.println("optional1执行orElseGet处理后的值是"+result);


    result = optional2.orElseGet(()-> new Integer(-1));
    System.out.println("optional2执行orElseGet处理后的值是"+result);
    try {
    result = optional1.orElseThrow (()-> new RuntimeException("值是空的"));
    System.out.println("optional1执行orElseThrow处理后的值是"+result);
    }catch (Exception e){
        System.out.println("optional1的orElseThrow抛出异常:"+e.getMessage());
    }
    try {
    result = optional2.orElseThrow (()-> new RuntimeException("值是空的"));
    System.out.println("optional2执行orElseThrow处理后的值是"+result);
    }catch (Exception e){
        System.out.println("optional2的orElseThrow抛出异常:"+e.getMessage());

4) 走行結果

 

2.3.5 フィルタリング方法

1) ソースコード

public Optional<T> filter(Predicate<? super T> predicate) {
    Objects.requireNonNull(predicate);
    if (!isPresent())
        return this;
    else
        return predicate.test(value) ? this : empty();
}

2) メソッドの説明

filter(Predicate p): オプションが空でない場合は、述語 p を実行し、p の結果が true の場合は元のオプションを返し、それ以外の場合は空のオプションを返します

3) テストコード

public static void main(String[] args) {
    Integer value1 = 5;
    Integer value2 = 6;
    Optional<Integer> optional1 = Optional.ofNullable(value1);
    Optional<Integer> optional2 = Optional.of(value2);


    Optional<Integer> result =optional1.filter(t->t > 5);
    System.out.println("optional1的filter后的值:"+result);
     result =optional2.filter(t->t > 5);
    System.out.println("optional2的filter后的值:"+result);

4) 走行結果

 

2.3.6 マッピング方法

1) ソースコード

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

2) メソッドの説明

• map(Function mapper): 値が存在する場合は、提供されたマップ関数をそれに適用し、結果が null でない場合は、結果を説明する Optional を返します。それ以外の場合は、空の Optional を返します。
• flatMap(Function<T,Optional> mapper): 値がある場合は、指定されたオプションのマッパー関数をそれに適用して結果を返します。それ以外の場合は、空のオプション関数を返します。このメソッドは map(Function) に似ていますが、提供されたマッパーの結果はすでにオプションです。呼び出された場合、flatMap は追加のオプションでそれをラップしません。
• 違い: map は自動的に u をオプションに入れますが、flatMap は u のオプションを手動で作成する必要があります

3) テストコード

    public static void main(String[] args) {
        User user1 = null;
        User user2 = new User("user2名字",19);
        Optional<User> optional1 = Optional.ofNullable(user1);
        Optional<User> optional2 = Optional.of(user2);
        System.out.println("=========map==========");
        System.out.println("optional1的map前的值:"+optional1);
        Optional<String> result =optional1.map(t->t.getName());
        System.out.println("optional1的map后的值:"+result);


        System.out.println("optional2的map前的值:"+optional2);
        result =optional2.map(t->t.getName());
        System.out.println("optional2的map后的值:"+result);


        System.out.println("===========flatMap========");


        System.out.println("optional1的flatMap前的值:"+optional1);
        Optional<Integer> result2 =optional1.flatMap(t->Optional.ofNullable(t.getAge()));
        System.out.println("optional1的flatMap后的值:"+result2);


        System.out.println("optional2的flatMap前的值:"+optional2);
        result2 =optional2.flatMap(t->Optional.ofNullable(t.getAge()));
        System.out.println("optional2的flatMap后的值:"+result2);

    }
public class User {
    String name;
    Integer age;
    public User(String name,Integer age){
        this.name = name;
        this.age=age;
    }


    public String getName() {
        return name;
    }


    public Integer getAge() {
        return age;

4) 走行結果

 

3 アプリケーション例

3.1 間違った使い方

• Optional は Serializable インターフェイスを実装していないため、クラスのプロパティとして使用できません。
• Optional をメソッド パラメーターとして使用しないでください。
• if(x!=null) を Optional.ofNullable(x).isPresent() に直接置き換えます。これはオーバーコーディングの疑いがあります。
• Optional.get() の戻り値を直接使用して操作すると、 String result =Optional.ofNullable(null).get().toString(); これでも例外がスローされます。

3.2 推奨される使用方法

クラス A には属性クラス B があり、クラス B には属性クラス C があり、クラス C にはフィールド名があります。
オプションを使用する前に：

if(atest!=null){
    Btest btest =atest.getBtest();
    if(btest!=null){
      Ctest ctest = btest.getCtest();
      if (ctest != null) {
          name =ctest.getName();
      }
    }
}

オプションを使用した後：

name = Optional.ofNullable(atest).map(t->t.getBtest()).map(t->t.getCtest()).map(t->t.getName()).orElse("默认值");

コードはきれいに見えますか?

4 まとめ

Optional のソース コードとユース ケース テスト コードの実行結果を分析すると、Optional を使用すると null 値の判定コードが最適化され、コードがより洗練されたものになることがわかります。

---

作者: チェン・チャンハオ

{{o.name}}

{{m.name}}