Android ビルドの Java バージョン

ソースコードが Java、Kotlin、またはその両方で記述されているかどうかにかかわらず、ビルド用に JDK または Java 言語のバージョンを選択する必要がある場所がいくつかあります。

Gradle ビルドにおける JDK の関係の概要
図 1. ビルド内の JDK の関係

用語集

Java 開発キット(JDK)
Java Development Kit(JDK)には、次のものが含まれています。
  • コンパイラ、プロファイラ、アーカイブ作成ツールなどのツール。これらは、ビルド時にアプリケーションを作成するために内部で使用されます。
  • Kotlin または Java のソースコードから呼び出すことができる API を含むライブラリ。Android では一部の機能が利用できません。
  • Java アプリケーションを実行するインタープリタである Java 仮想マシン(JVM)。JVM は、Android Studio IDE と Gradle ビルドツールの実行に使用されます。JVM は Android デバイスやエミュレータでは使用されません。
JetBrains Runtime(JBR)
JetBrains Runtime(JBR) は、Android Studio とともに配布される拡張 JDK です。Studio や関連する JetBrains プロダクトで使用するための最適化がいくつか含まれていますが、他の Java アプリケーションの実行にも使用できます。

Android Studio を実行する JDK を選択するにはどうすればよいですか?

Android Studio の実行には JBR を使用することをおすすめします。Android Studio とともにデプロイされ、Android Studio のテストに使用されます。また、Android Studio を最適に使用するための機能強化も含まれています。これを確実にするため、STUDIO_JDK 環境変数を設定しないでください。

Android Studio の起動スクリプトは、次の順序で JVM を検索します。

  1. STUDIO_JDK 環境変数
  2. studio.jdk ディレクトリ(Android Studio ディストリビューション内)
  3. Android Studio の配布版の jbr ディレクトリ(JetBrains Runtime)。おすすめ
  4. JDK_HOME 環境変数
  5. JAVA_HOME 環境変数
  6. PATH 環境変数の java 実行可能ファイル

Gradle ビルドを実行する JDK を選択するにはどうすればよいですか?

Android Studio のボタンを使用して Gradle を実行すると、Android Studio の設定で設定された JDK が Gradle の実行に使用されます。Android Studio の内部または外部のターミナルで Gradle を実行する場合、JAVA_HOME 環境変数(設定されている場合)によって、どの JDK が Gradle スクリプトを実行するかが決まります。JAVA_HOME が設定されていない場合は、PATH 環境変数の java コマンドが使用されます。

最も一貫した結果を得るには、JAVA_HOME 環境変数と Android Studio の Gradle JDK 構成を同じ JDK に設定してください。

ビルドを実行すると、Gradle は実際のビルドを実行するデーモンと呼ばれるプロセスを作成します。このプロセスは、ビルドで同じ JDK と Gradle のバージョンが使用されている限り、再利用できます。デーモンを再利用すると、新しい JVM の起動とビルドシステムの初期化にかかる時間が短縮されます。

異なる JDK または Gradle バージョンでビルドを開始すると、追加のデーモンが作成され、より多くの CPU とメモリが消費されます。

Android Studio の Gradle JDK 構成

既存のプロジェクトの Gradle JDK 構成を変更するには、[File](macOS では [Android Studio]> [Settings] > [Build, Execution, Deployment] > [Build Tools] > [Gradle] から Gradle 設定を開きます。[Gradle JDK] プルダウンには、次のオプションがあります。

  • JAVA_HOMEGRADLE_LOCAL_JAVA_HOME などのマクロ
  • Android 構成ファイルに保存されている jbr-17 などの vendor-version 形式の JDK テーブル エントリ
  • JDK をダウンロードする
  • 特定の JDK を追加する
  • オペレーティング システムのデフォルトの JDK インストール ディレクトリからローカルで検出された JDK

選択したオプションは、プロジェクトの .idea/gradle.xml ファイルの gradleJvm オプションに保存され、Android Studio から起動されたときに Gradle を実行するために、その JDK パス解決が使用されます。

図 2. Android Studio の Gradle JDK 設定。

マクロを使用すると、プロジェクトの JDK パスを動的に選択できます。

  • JAVA_HOME: 同じ名前の環境変数を使用します
  • GRADLE_LOCAL_JAVA_HOME: .gradle/config.properties ファイルの java.home プロパティを使用します。デフォルトは JetBrains Runtime です。

選択した JDK は、Gradle ビルドの実行と、ビルド スクリプトとソースコードの編集時の JDK API 参照の解決に使用されます。指定された compileSdk は、ソースコードの編集とビルド時に使用できる Java シンボルをさらに制限します。

Gradle ビルドで使用するプラグインで使用されている JDK バージョン以上の JDK バージョンを選択してください。Android Gradle プラグイン(AGP)に必要な最小 JDK バージョンを確認するには、リリースノートの互換性表をご覧ください。

たとえば、Android Gradle プラグイン バージョン 8.x には JDK 17 が必要です。これを使用する Gradle ビルドを以前のバージョンの JDK で実行しようとすると、次のようなメッセージが報告されます。

An exception occurred applying plugin request [id: 'com.android.application']
> Failed to apply plugin 'com.android.internal.application'.
   > Android Gradle plugin requires Java 17 to run. You are currently using Java 11.
      Your current JDK is located in /usr/local/buildtools/java/jdk
      You can try some of the following options:
       - changing the IDE settings.
       - changing the JAVA_HOME environment variable.
       - changing `org.gradle.java.home` in `gradle.properties`.

Java または Kotlin のソースコードで使用できる Java API はどれですか?

Android アプリケーションは、JDK で定義された API の一部を使用できますが、すべてを使用できるわけではありません。Android SDK では、利用可能な API の一部として、多くの Java ライブラリ関数の実装が定義されています。compileSdk プロパティは、Kotlin または Java のソースコードをコンパイルする際に使用する Android SDK のバージョンを指定します。

Kotlin

android {
    ...
    compileSdk = 33
}

Groovy

android {
    ...
    compileSdk 33
}

Android の各バージョンは、特定のバージョンの JDK と、その使用可能な Java API のサブセットをサポートしています。指定された minSdk では使用できない compileSdk で使用可能な Java API を使用する場合、脱糖と呼ばれるプロセスを通じて、以前のバージョンの Android で API を使用できる可能性があります。サポートされている API については、脱糖で使用可能な Java 11+ API をご覧ください。

この表を使用して、各 Android API でサポートされている Java バージョンと、使用可能な Java API の詳細を確認してください。

Android Java サポートされている API と言語機能
14(API 34) 17 コアライブラリ
13(API 33) 11 コアライブラリ
12(API 32) 11 Java API
11 以前 Android のバージョン

どの JDK が Java ソースコードをコンパイルしますか?

Java ツールチェーン JDK には、Java ソースコードのコンパイルに使用される Java コンパイラが含まれています。この JDK は、ビルド中に javadoc と単体テストも実行します。

ツールチェーンは、デフォルトで Gradle の実行に使用される JDK に設定されます。デフォルトを使用し、異なるマシン(ローカルマシンや別の継続的インテグレーション サーバーなど)でビルドを実行すると、異なる JDK バージョンが使用されている場合、ビルドの結果が異なることがあります。

より一貫性のあるビルドを作成するには、Java ツールチェーンのバージョンを明示的に指定します。これを指定すると、

  • ビルドを実行しているシステムで互換性のある JDK を検索します。
    • 互換性のある JDK が存在しない場合(ツールチェーン リゾルバが定義されている場合)、JDK をダウンロードします。
  • ソースコードからの呼び出し用にツールチェーン Java API を公開します。
  • Java 言語バージョンを使用して Java ソースをコンパイルします。
  • sourceCompatibilitytargetCompatibility のデフォルト値を指定します。

常に Java ツールチェーンを指定し、指定した JDK がインストールされていることを確認するか、ビルドにツールチェーン リゾルバを追加することをおすすめします。

ソースコードが Java、Kotlin、またはその両方で記述されているかどうかにかかわらず、ツールチェーンを指定できます。モジュールの build.gradle(.kts) ファイルの最上位でツールチェーンを指定します。

Java ツールチェーンのバージョンを次のように指定します。

Kotlin

java {
    toolchain {
        languageVersion = JavaLanguageVersion.of(17)
    }
}

Groovy

java {
    toolchain {
        languageVersion = JavaLanguageVersion.of(17)
    }
}

これは、ソースが Kotlin、Java、またはその両方の混合である場合に機能します。

ツールチェーンの JDK バージョンは、Gradle の実行に使用される JDK と同じにできますが、目的が異なることに注意してください。

Java ソースコードで使用できる Java 言語ソースの機能

sourceCompatibility プロパティは、Java ソースのコンパイル中に使用できる Java 言語機能を決定します。Kotlin ソースには影響しません。

モジュールの build.gradle(.kts) ファイルで sourceCompatibility を次のように指定します。

Kotlin

android {
    compileOptions {
        sourceCompatibility = JavaVersion.VERSION_17
    }
}

Groovy

android {
    compileOptions {
        sourceCompatibility JavaVersion.VERSION_17
    }
}

指定しない場合、このプロパティはデフォルトで Java ツールチェーンのバージョンになります。Java ツールチェーンを使用していない場合、デフォルトでは Android Gradle プラグインによって選択されたバージョン(Java 8 以降など)が使用されます。

Kotlin または Java のソースをコンパイルするときに使用できる Java バイナリ機能はどれですか?

targetCompatibility プロパティと jvmTarget プロパティは、コンパイルされた Java ソースと Kotlin ソースのバイトコードを生成する際に使用される Java クラス形式のバージョンをそれぞれ決定します。

Kotlin の一部の機能は、同等の Java 機能が追加される前から存在していました。初期の Kotlin コンパイラは、Kotlin の機能を表現する独自の方法を作成する必要がありました。これらの機能の一部は、後に Java に追加されました。jvmTarget レベルが上がると、Kotlin コンパイラが Java の機能を直接使用するようになり、パフォーマンスが向上する可能性があります。

Android のバージョンによって、サポートされる Java のバージョンが異なります。targetCompatibilityjvmTarget を増やすことで、追加の Java 機能を利用できますが、この機能を利用できるようにするために、Android SDK の最小バージョンも増やす必要がある場合があります。

targetCompatibilitysourceCompatibility 以上である必要があります。実際には、sourceCompatibilitytargetCompatibilityjvmTarget は通常同じ値を使用します。次のように設定できます。

Kotlin

android {
    compileOptions {
        sourceCompatibility = JavaVersion.VERSION_17
        targetCompatibility = JavaVersion.VERSION_17
    }
    kotlinOptions {
        jvmTarget = "17"
    }
}

Groovy

android {
    compileOptions {
        sourceCompatibility JavaVersion.VERSION_17
        targetCompatibility JavaVersion.VERSION_17
    }
    kotlinOptions {
        jvmTarget '17'
    }
}

指定しない場合、これらのプロパティはデフォルトで Java ツールチェーンのバージョンになります。Java ツールチェーンを使用していない場合、デフォルト値が異なり、ビルドの問題が発生する可能性があります。そのため、これらの値を常に明示的に指定するか、Java ツールチェーンを使用することをおすすめします。