Java Optional Best Practices
· 約6分
JavaのOptionalは、値が存在する場合も存在しない場合もあるコンテナオブジェクトです。これにより、nullチェックの手間を減らし、メソッドの戻り値として「値があるかどうか」を明示的に伝えることができます。Optionalは以下のような利点があります:
明確な意図: メソッドが値を返さない可能性があることを示す。 安全な操作: 明示的なnullチェックを回避し、NullPointerExceptionのリスクを減少させる。 関数型スタイル: map, filter, flatMap などを活用したチェーン処理が可能。
Optionalの作成
Optionalは主に2つのファクトリーメソッドを使って生成します。
-
Optional.of(T value):
- 値が必ず非nullであることを期待します。
- nullを渡すと、NullPointerExceptionが発生します。
-
Optional.ofNullable(T value):
- 値がnullの場合は空のOptional（Optional.empty()）を返し、非nullの場合は値を保持します。
作成例:
// Method that processes an input string and returns an Optional.
public static Optional<String> processValue(String input) {
// Return empty if input is null or blank
if (input == null || input.trim().isEmpty()) {
return Optional.empty();
}
// Otherwise, return a trimmed value wrapped in an Optional
return Optional.of(input.trim());
}
Optionalの利用方法
Optionalの利用は主に以下のユースケースに分類されます。
- 値の存在チェック
- isPresent() / isEmpty():
- 値が存在するかどうかを確認する。
- 例: if (optional.isPresent())
- isPresent() / isEmpty():
- 値の取得
- get():
- 値が存在する場合に返すが、存在しない場合はNoSuchElementExceptionをスローします。
- 注意: 直接get()を使うのはリスクがあるため、他のメソッドと組み合わせることが望ましい。
- orElse(defaultValue):
- 値が存在しない場合にデフォルト値を返します。
- orElseThrow(exceptionSupplier):
- Optionalが空の場合に、指定した例外をスローします。
- get():
- 値の処理
- ifPresent(Consumer):
- 値が存在する場合に、Consumer（値を受け取って何らかの処理を行うラムダ式）を実行します。
- ifPresentOrElse(Consumer, Runnable):
- 値が存在する場合はConsumerを、存在しない場合はRunnable（引数を取らない処理）を実行します。
- ifPresent(Consumer):
- Optionalのチェーン処理
- map(Function):
- 値が存在する場合に、Functionを適用し結果を新しいOptionalとして返します。
- filter(Predicate):
- 値が条件を満たすかどうかをチェックし、満たさない場合は空のOptionalを返します。
- flatMap(Function):
- ネストされたOptionalの解除に利用します。
- or(Supplier):
- Optionalが空の場合に、新たなOptionalを返すために利用します。
- map(Function):
利用例:
String value1 = " Hello, World! ";
Optional<String> opt1 = processValue(value1);
// 存在チェック
if (opt1.isPresent()) {
System.out.println("Value exists!");
} else {
System.out.println("Value is empty.");
}
// 値の取得
try {
// 値がなければ例外がスローされる
String result = opt1.orElseThrow(() -> new IllegalStateException("Value is empty"));
System.out.println("Result: " + result);
} catch (IllegalStateException ex) {
System.err.println(ex.getMessage());
}
// デフォルト値を利用
String defaultResult = opt1.orElse("Default Value");
System.out.println("Default Result: " + defaultResult);
// 値の処理
opt1.ifPresent(val -> System.out.println("Processed value1: " + val));
// ifPresentOrElseを使用して、存在する場合は処理し、存在しない場合は別の処理を実行
opt1.ifPresentOrElse(
val -> System.out.println("Processed value1: " + val),
() -> System.out.println("Value is empty")
);
// チェーン処理：変換とフィルタ
Optional<Integer> lengthOpt = opt1
.map(String::toUpperCase) // 値を大文字に変換
.filter(val -> val.length() > 10) // 長さが10より大きいかフィルター
.map(String::length); // 文字列の長さを取得
lengthOpt.ifPresent(len -> System.out.println("Length of processed value: " + len));
// orを使用して、Optionalが空の場合に代替値を提供
Optional<String> opt2 = opt1.or(() -> Optional.of("Default Greeting"));
System.out.println("Result from opt2: " + opt2.get());
Optionalのベストプラクティス
-
戻り値としての利用:
- Optionalはメソッドの戻り値に利用し、値が存在しない可能性を明示する。
-
メソッド引数としては使用しない:
- Optionalを引数にすると、呼び出し側に無駄なラッピングを強いるため、シンプルなnullチェックやオーバーロード、あるいは別のパラメータ設計を検討する。
-
直接get()の使用を避ける:
- 値の取得はorElse, orElseThrow, ifPresentなどのメソッドを利用して、安全に扱う。
-
不必要なオブジェクト生成を避ける:
- チェーン操作を利用して、コードをシンプルに保つ。