Snykブログで お届けする、 新しい チートシートシリーズの 第1回へ ようこそ。 開発者と して 成長する ために 印刷して 掲示できる コンテンツを お届けします。 第1回では、 Java 10の リリースに 続き、 話題の ローカル変数の 型推論を 取り上げます。 上の 画像を クリックするか、 こちらの リンク から PDF版を ダウンロードできます。 ローカル型推論機能の 基本的な 考え方は とても シンプルです。 宣言時に 明示していた 型を、 新しい 予約語 「var」に 置き換えると、 型が 推論されます。 たとえば、 次のように 置き換えられます。
次のようになります。
すると、 outputStreamの 型は ByteArrayOutputStreamと 推論されます。 ちょっと 待ってください。 Javaで 動的型付けが 使えるようになったと いう ことですか? もちろん 違います。 型推論は すべて コンパイル時に 行われ、 明示的な 型は コンパイラに よって バイトコードに 組み込まれます。 実行時の Javaは、 これまで どおり静的型付けです。 使い方自体は とても シンプルなので、 この チートシートでは ローカル型推論の 最も 重要な 側面、 つまり 実践的な 使い方に 焦点を 当てます。 明示的な 型指定を 使うべき ときと、 型推論を 検討すべき ときに ついて 説明します。
この チートシートを 作ろうと 思っていた ところ、 Oracleの JDKエンジニアである Stuart Marks が、 型推論の 使用に 関する 原則と 指針を 解説した 素晴らしい 記事 を 公開しました。 そこで チートシートを 作るに あたり、 Stuartに 連絡して、 彼の 考えを 盛り込み、 開発者が 掲示して 日々 活用できる 形に まとめられないか 相談しました。 ぜひ Stuartの 記事全文 も お読みください。 読む 価値が あります。
原則 1. コードを書くことより、読むことが大切。 1行の コードを 書くのに 10 分かかろうと 10日かかろうと、 その コードは ほぼ 間違いなく、 その後 何年にも わたって 読み返されます。 コードが 将来も 保守しやすく 理解しやすい ものである ためには、 明確で 簡潔であり、 何よりも その 目的を 理解する ために 必要な 情報が すべて 含まれていなければなりません。 目指すのは、 理解しやすさを 最大限に 高める ことです。
2. コードは、その場で読んで理解できるようにする。 何が 起きているのかを 理解する ために、 コードベースの あちこちを 調べなくて 済むよう、 できる 限り 多くの 情報を コードに 含めましょう。 メソッド名や 変数名を 工夫するのも その 方法です。
3. コードの読みやすさをIDEに依存させない。 IDEは とても 便利です。 本当に 便利 です。 開発者の 生産性や 正確性を 高めてくれます。 しかし、 IDEに 頼らなくても コードを 読んで 理解できる 必要が あります。 コードは IDE以外の 場所で 読まれる ことも よく あります。 また、 IDEに よって、 読み手に 提供される 情報の 量が 異なる 場合も あります。 コードは それ自体で 内容が 伝わるべきです。 ツールの 助けが なくても、 一目で 理解できるようにしましょう。
判断するのはあなたです。 変数に 明示的な 型を 指定するか、 Javaコンパイラに 型を 推論させるかは、 トレードオフです。 一方では、 余分な 記述や 定型コード、 形式的な 記述を 減らしたいでしょう。 もう 一方では、 コードの 理解しやすさを 損ないたく ありません。 型宣言だけが 読み手に 情報を 伝える 手段ではありません。 変数名や 初期化式からも 情報を 伝えられます。 各変数に ついて、 明示的な 型指定を 省いて よいか 判断する 際は、 利用できる 情報源を すべて 考慮しましょう。
ガイドライン 1. 役立つ情報を伝える変数名を付ける。 これは 一般的に 良い 習慣ですが、 varを 使う 場合は 特に 重要です。 varを 使った 宣言では、 変数の 意味や 用途を 変数名で 伝えられます。 明示的な 型を varに 置き換える ときは、 変数名もより 分かりやすくするのが よいでしょう。 場合に よっては、 変数名に 型を 含めると 便利です。 たとえば、 次のようになります。
2. ローカル変数のスコープを最小限にする。 ローカル変数の スコープを 制限する ことは、 『Effective Java』 (第3版)の 項目57で 解説されています。 varを 使う 場合は、 なおさら 重要です。 問題に なるのは、 変数の スコープが 広い 場合です。 つまり、 変数の 宣言から 使用までの 間に 多くの コード行が ある 状態です。 コードの 保守中に 型などが 変更されると、 動作が 変わってしまうことがあります。 たとえば、 Listから Setに 変更するのは 問題なさそうに 見えても、 同じ スコープ内の 後続処理で 順序に 依存していないでしょうか。 同じ インターフェースを 実装している 型でも、 実装の 微妙な 違いが 思わぬ 問題を 招くことがあります。 このような 場合、 単に varを 避けるのではなく、 ローカル変数の スコープを 狭めてから varで 宣言しましょう。 次の コードを 見てください。
この コードには バグが あります。 Setには 反復順序が 定義されていないためです。 ただし、 items変数の 使用箇所が 宣言の すぐ 近くに あるので、 プログラマーは この バグに すぐ 気づいて 修正できるでしょう。 では、 この コードが 大きな メソッドの 一部で、 items変数の スコープも それに 応じて 広い 場合を 考えてみましょう。
この 場合、 Setの 末尾に 項目を 追加しようとする 行が 型宣言から 離れている ため、 バグの 発見は ずっと 難しくなります。
3. 初期化式から十分な情報が読み取れる場合は、varを検討する。 ローカル変数は、 コンストラクターで 初期化される ことが よく あります。 生成する クラス名は、 左辺の 明示的な 型と して 繰り返し記述される ことが 少なく ありません。 型名が 長い 場合、 varを 使えば 情報を 失わずに 記述を 簡潔に できます。
Files.newBufferedReader (… )のような メソッド呼び出しや、 List stringList = List.of ("a", "b", "c")のような 場合に varを 使うのも 妥当です。
4. varを使って、連鎖した式や入れ子になった式をローカル変数に分割する。 文字列の コレクションを 受け取り、 最も 頻繁に 出現する 文字列を 見つける コードを 考えてみましょう。 次のように 書けます。
この コードは 正しく 動作しますが、 複数の 文に 分けた ほうが 読みやすくなります。 次のように 文を 分ける ときに 問題と なるのは、
しかし、 明示的な 型指定が 非常に 煩雑で、 重要な コードから 注意が それる ため、 作者は 分割を ためらったのかもしれません。 varを 使えば、 中間変数の 型を 明示すると いう 大きな 負担を かけずに、 より 自然な 形で コードを 表現できます。
メソッド呼び出しを 1つの 長い 連鎖に した 最初の コードを、 正当な 理由から 好む 人も いるでしょう。 ただし、 長い メソッドチェーンを 分割した ほうが よい 場合も あります。
5. ローカル変数で「インターフェースに対するプログラミング」を過度に気にしない。 Javaでは、 具象型の インスタンスを 生成しながら、 インターフェース型の 変数に 代入するのが 一般的です。 たとえば、 次のようになります。
しかし、 varを 使うと、 インターフェース型ではなく 具象型が 推論されます。
list変数を 使う コードは、 具象実装に 依存するようになる 可能性が あります。 将来、 変数の 初期化式が 変更されると、 推論される 型も 変わり、 後続の コードで エラーや バグが 発生する おそれが あります。
ガイドライン2に 従って ローカル変数の スコープを 小さくしていれば、 これは それほど 問題に なりません。 具象実装が 「漏れ出して」後続コードに 影響する リスクを 抑えられる ためです。
6. ダイヤモンド演算子やジェネリックメソッドでvarを使う場合は注意する。 varと 「ダイヤモンド」 機能は どちらも、 すでに ある 情報から 型を 導き出せる 場合に、 明示的な 型情報を 省略できます。 しかし、 両方を 併用すると、 コンパイラが 推論する 型を 正しく 絞り込む ために 必要な 情報を すべて 省略してしまうことがあります。
次の 例を 見てみましょう。
ジェネリックメソッドでは 型推論が うまく 活用されており、 プログラマーが 型引数を 明示する ことは ほとんど ありません。 ジェネリックメソッドの 型推論では、 十分な 型情報を 与える 実引数が ない 場合、 ターゲット型に 依存します。 varに よる 宣言には ターゲット型が ないため、 ダイヤモンド演算子と 同様の 問題が 起こる ことがあります。 たとえば、
ダイヤモンド演算子でも ジェネリックメソッドでも、 コンストラクターや メソッドに 実引数を 渡す ことで 型情報を 追加でき、 意図した 型を 推論できます。 間接的な 要素が 1つ 増えますが、 それでも 予測可能です。 つまり、 次のようになります。
7. リテラルでvarを使う場合は注意する。 型名は 一般に 短いため、 リテラルで varを 使っても 大きな メリットは 期待できません。 ただし、 変数名を そろえる 場合など、 varが 便利な こともあります。
boolean、 文字、 long、 文字列の リテラルには 問題ありません。 これらの リテラルから 推論される 型は 明確なので、 varの 意味も 曖昧に なりません。 初期化式が 数値、 特に 整数リテラルの 場合は 十分に 注意してください。 左辺に 明示的な 型を 指定すると、 数値が int以外の 型に 暗黙的に 拡張または 縮小される ことがあります。 varを 使うと 値は intと 推論されますが、 それが 意図した 型ではない 可能性が あります。
まとめ 宣言に varを 使うと、 余分な 記述が 減り、 より 重要な 情報が 目立つようになる ため、 コードの 改善に つながります。 一方、 むやみに varを 使うと、 かえって コードが 分かりにくくなることがあります。 適切に 使えば、 理解しやすさを 損なうことなく コードを 短く 明確に し、 質の 高い コードを さらに 改善できます。 varを 使う ときは、 コードが 曖昧に なっていないか、 詳しく 調べなくても 明確に 理解できるかを 確認しましょう。
今 すぐ チートシートを ダウンロード!
Capture the Flagを 始めよう オンデマンドの バーチャル入門ワークショップを 見て、 Capture the Flagの 課題の 解き方を 学びましょう。