Android ビルドの Java バージョン

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

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

用語集

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

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

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

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

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

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

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

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

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

異なる JDK または Gradle バージョンでビルドを開始すると、追加のデーモンが作成され、CPU とメモリの使用量が増加します。

gradle-wrapper.properties

Android Studio での Gradle JDK の構成

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

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

図 2.Android Studio の Gradle JDK 設定。

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

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

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

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

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

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 = 36
}

Groovy

android {
    ...
    compileSdk 36
}

Android の各バージョンは、特定のバージョンの JDK と、使用可能な Java API のサブセットをサポートしています。指定した minSdkで使用できない a compileSdkで使用できる Java API を使用する場合は、 desugarと呼ばれるプロセスを使用して、以前のバージョンの Android で API を使用できる場合があります。 サポートされている API については、desugar で利用可能な 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 バージョン

Java ソースコードをコンパイルする JDK はどれですか?

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

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

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

  • ビルドを実行しているシステムで互換性のある 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 プロパティは、コンパイルされた Java ソースと Kotlin ソースのバイトコードを生成するときに使用される Java クラス形式のバージョンを決定します。

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

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

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

Kotlin

android {
    compileOptions {
        sourceCompatibility = JavaVersion.VERSION_17
        targetCompatibility = JavaVersion.VERSION_17
    }
}

Groovy

android {
    compileOptions {
        sourceCompatibility JavaVersion.VERSION_17
        targetCompatibility JavaVersion.VERSION_17
    }
}

2.2 より前のバージョンの Kotlin を使用している場合は、kotlinOptions も設定する必要があります。

Kotlin

android {
    kotlinOptions {
        jvmTarget = "17"
    }
}

Groovy

android {
    kotlinOptions {
        jvmTarget = "17"
    }
}

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