本ページはプロモーションが含まれています

Java入門

【Java 14以降】yieldの基本を解説!returnとの違いとは?

トム

・SaaS勤務/javaのバックエンドエンジニア
/java歴10年以上 ・首都圏在住30代
・資格:基本情報技術者/応用情報技術者/Java Silver/Python3エンジニア認定基礎

「Javaのyieldって最近聞くけど、何に使うの?」

「returnやbreakとどう違うのか、いまいち分からない…」

「switch式が便利になったらしいけど、具体的な書き方が知りたい」

もし、あなたがこのようにお考えなら、この記事がきっと役に立ちます。

私もJava 14でyieldが導入された当初は、従来のswitch文との違いに少し戸惑った経験があります。しかし、その仕組みと利点を理解してからは、コードの可読性が劇的に向上し、バグの少ない安全なプログラムを書けるようになりました。

この記事では、Javaのyieldについて知りたい方に向けて、以下の内容を分かりやすく解説します。

  • yieldの基本的な意味と役割
  • yieldが導入された背景とreturnとの明確な違い
  • switch式での具体的な使い方とコードサンプル

この記事を最後まで読めば、あなたはyieldを正しく理解し、明日からのコーディングで自信を持って活用できるようになるでしょう。

Javaのyieldとは?

Javaのyieldは、switch式の中から値を返すために使われるキーワードです。Java 14でswitch文が「式」として拡張された際に、プレビュー機能として導入され、Java 14で正式な機能となりました。

これまでのswitchは「文(Statement)」であり、処理を実行するだけでした。しかし、新しいswitch「式(Expression)」は、処理の結果として値を生成できます。yieldは、その値を「産出する」または「提供する」という役割を担います。

このyieldの登場により、コードがより簡潔で安全になりました。

yieldが登場した背景(Java 14で導入された理由)

yieldと新しいswitch式がなぜ導入されたのかを理解するために、従来のswitch文が抱えていた課題を見てみましょう。

従来のswitch文には、主に2つの課題がありました。

  1. breakの書き忘れによるバグcaseごとにbreakを書き忘れると、処理が次のcaseに突き抜けてしまう「フォールスルー」という現象が起こります。これは意図しないバグの温床として、多くの開発者を悩ませてきました。
  2. コードの冗長性switch文の結果を外部の変数に代入する場合、まず変数を宣言し、各caseで代入処理を書く必要がありました。これにより、コードが長くなり、可読性が低下する傾向があったのです。

これらの課題を解決し、より安全で表現力豊かなコードを書けるようにするために、switch式とyieldが導入されました。switch式では、すべてのcaseを網羅することが強制されるため、バグが入り込む余地が減ります。

yieldと従来のreturnとの違い

yieldreturnは、どちらも値を返すキーワードですが、その役割の範囲がまったく異なります。この違いを理解することが、yieldを使いこなす上で非常に重要です。

  • return: メソッド全体の処理を終了し、値を呼び出し元に返します。returnが実行された時点で、そのメソッドは完全に終了です。
  • yield: switch式の中から値を返すだけで、メソッドの処理は終了しません。switch式の評価が完了した後も、メソッド内の後続の処理は続行されます。

つまり、スコープ(影響範囲)が違うと覚えておくと良いでしょう。returnはメソッド全体、yieldは自身が含まれるswitch式だけが対象です。

yieldの具体的な使い方

それでは、yieldをどのように使うのかを具体的に見ていきましょう。yieldswitch式の中で、特定のcaseが返す値を指定するために使用します。

switch式とyieldの組み合わせ例

yieldは、caseの処理が複数行にわたる場合に使われるのが一般的です。caseの後にコロン:を書き、波括弧{}で囲んだブロック内で処理を記述し、最後にyieldで返す値を指定します。

// 曜日(enum)に基づいてメッセージを返す例
DayOfWeek day = DayOfWeek.MONDAY;
String message = switch (day) {
    case MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY -> "平日です。頑張りましょう!";
    case SATURDAY, SUNDAY -> {
        System.out.println("休日が検出されました。");
        // 何か別の処理...
        yield "休日です。ゆっくり休みましょう!";
    }
    // defaultは不要 (enumの全パターンを網羅しているため)
};
System.out.println(message);

この例では、土曜日または日曜日の場合に、コンソールへの出力処理を行った後、yieldを使って文字列を返しています。一方、平日のcaseのように処理が1行で済む場合は、アロー->を使ってより簡潔に書くことが可能です。

従来のswitch文との違いを比較

同じ処理を従来のswitch文で書いた場合と比較すると、yieldを使ったswitch式のメリットがより明確になります。

従来のswitch文を使ったコード:

DayOfWeek day = DayOfWeek.MONDAY;
String message; // 外部で変数を宣言
switch (day) {
    case MONDAY:
    case TUESDAY:
    case WEDNESDAY:
    case THURSDAY:
    case FRIDAY:
        message = "平日です。頑張りましょう!";
        break; // breakが必須
    case SATURDAY:
    case SUNDAY:
        System.out.println("休日が検出されました。");
        // 何か別の処理...
        message = "休日です。ゆっくり休みましょう!";
        break; // breakが必須
    default:
        // 本来は到達しないが、念のため例外処理
        throw new IllegalStateException("不正な曜日: " + day);
}
System.out.println(message);

switch式とyieldを使ったコード(再掲):

DayOfWeek day = DayOfWeek.MONDAY;
String message = switch (day) { // 式なので直接変数に代入できる
    case MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY -> "平日です。頑張りましょう!";
    case SATURDAY, SUNDAY -> {
        System.out.println("休日が検出されました。");
        yield "休日です。ゆっくり休みましょう!"; // breakは不要
    }
};
System.out.println(message);

比較すると、switch式とyieldを使ったコードの方が、以下の点で優れていることが分かります。

  • breakが不要: breakの書き忘れによるバグの心配がありません。
  • コードが簡潔: 変数をswitchの外で宣言する必要がなく、直接代入できるため、全体的にすっきりしています。
  • 網羅性の保証: enumの全パターンをcaseで網羅している場合、defaultが不要になります。もし網羅していないとコンパイルエラーになるため、記述漏れを防げます。

このように、yieldを使うことで、より安全で読みやすいコードを実現できるのです。

実際のコードサンプルで理解する

もう少し実践的な例を見てみましょう。HTTPステータスコードに応じて、クライアントに返すメッセージのカテゴリを判定する処理を考えます。

int statusCode = 200;
String category = switch (statusCode) {
    case 200, 201, 204 -> "成功";
    case 400, 401, 403, 404 -> {
        // 400番台のエラーはログに記録するなどの追加処理
        logError("クライアントエラーが発生しました: " + statusCode);
        yield "クライアントエラー";
    }
    case 500, 503 -> {
        // 500番台のエラーはより詳細なログを残す
        logServerError("サーバーエラーが発生しました: " + statusCode, new Exception());
        yield "サーバーエラー";
    }
    default -> {
        // 想定外のコードは不明として扱う
        logWarning("不明なステータスコード: " + statusCode);
        yield "不明";
    }
};

System.out.println("ステータスカテゴリ: " + category);

このコードでは、yieldを使うことで、各case内でログ出力のような副作用を伴う処理を実行しつつ、最終的な値をswitch式の結果として返す、という柔軟な記述ができています。

yieldを使うときの注意点

yieldは非常に便利な機能ですが、使う際にはいくつか知っておくべき注意点が存在します。これらを理解せずに使うと、予期せぬコンパイルエラーにつながる可能性があります。

switch「文」では使えないことに注意

最も重要な注意点は、yieldswitch「式」専用のキーワードである、という点です。値を返さない従来のswitch「文」の構文の中でyieldを使おうとすると、コンパイルエラーになります。

コンパイルエラーになる例:

int num = 1;

// これは値を返さない「文」なので、yieldは使えない
switch (num) {
    case 1:
        System.out.println("1です");
        yield 1; // ここでコンパイルエラー!
        break;
    default:
        System.out.println("その他");
        break;
}

switchが式として扱われるのは、switchブロック全体が変数の代入やreturnの対象になっている場合です。yieldは、そのswitch式が返す値を指定するためだけに存在します。

可読性の観点からの使い分け

switch式には、yieldを使う構文と、アロー->を使う構文の2種類があります。どちらを使うべきか、可読性の観点から使い分けるのが良いでしょう。

  • アロー (->) を使うべきケース:caseの処理が値を返すだけのシンプルな1行で終わる場合。こちらの方が圧倒的に簡潔です。case MONDAY -> "平日";
  • yield を使うべきケース:値を返す前に、ログ出力など複数の処理を実行する必要がある場合。波括弧{}で処理ブロックを作り、その中でyieldを使います。case SATURDAY -> { System.out.println("ログ出力"); yield "休日"; }

処理内容に応じて適切な構文を選択することで、コードの意図が伝わりやすくなります。

将来のJavaバージョンとの互換性

yieldはJava 14で正式に導入された機能です。したがって、プロジェクトで使用しているJavaのバージョンが13以前の場合、yieldおよびswitch式は利用できません。

チームで開発している場合は、プロジェクト全体のJavaバージョンを確認することが不可欠です。古いバージョンで運用されているシステムに、安易にyieldを使ったコードを追加すると、ビルドエラーの原因となります。

また、yieldという単語は、Java 13までは変数名として利用できましたが、Java 14以降では予約語(キーワード)となったため、変数名として使えなくなりました。古いコードを新しいバージョンに移行する際は、この点にも注意が必要です。

まとめ — yieldを正しく理解して効率的に使おう

今回は、Java 14から導入されたキーワードyieldについて、その基本的な役割から具体的な使い方、注意点までを詳しく解説しました。

最後に、この記事の要点をまとめます。

  • yieldは、switch式の中から値を返すためのキーワードです。
  • 従来のswitch文が抱えていたbreakの書き忘れやコードの冗長性といった問題を解決します。
  • returnがメソッド全体を終了させるのに対し、yieldswitch式の結果を返すだけで、メソッドの処理は続行されます。
  • yieldは値を返さないswitch「文」では使えず、switch「式」の中でのみ利用可能です。

yieldを適切に使いこなすことで、あなたのJavaコードはより安全で、簡潔かつ可読性の高いものへと進化します。

  • この記事を書いた人
  • 最新記事

トム

・SaaS勤務/javaのバックエンドエンジニア
/java歴10年以上 ・首都圏在住30代
・資格:基本情報技術者/応用情報技術者/Java Silver/Python3エンジニア認定基礎

-Java入門