ビルド依存関係を追加する

Android Studio の Gradle ビルドシステムを使用すると、外部バイナリや他のライブラリ モジュールを依存関係としてビルドに含めることができます。依存関係は、マシン上またはリモート リポジトリで見つけることができます。推移的な依存関係が宣言されている場合、それも自動的に含まれます。このページでは、Android Gradle プラグイン（AGP）に固有の動作と構成を含め、Android プロジェクトで依存関係を使用する方法について詳しく説明します。Gradle の依存関係の概念をより深く理解するには、依存関係管理に関する Gradle のガイドをご覧ください。ただし、Android プロジェクトでは、このページで定義されている依存関係コンフィグレーションのみを使用する必要がある点に注意してください。

ライブラリまたはプラグインの依存関係を追加する

ビルド依存関係を追加して管理する最善の方法は、バージョン カタログを使用することです。これは、新しいプロジェクトでデフォルトで使用される方法です。このセクションでは、Android プロジェクトで使用される最も一般的な構成タイプについて説明します。その他のオプションについては、Gradle のドキュメントをご覧ください。バージョン カタログを使用するアプリの例については、Now in Android をご覧ください。バージョン カタログなしでビルド依存関係がすでに設定されており、マルチモジュール プロジェクトがある場合は、移行することをおすすめします。

ネイティブ依存関係（一般に使用されないもの）の追加と管理については、ネイティブ依存関係をご覧ください。

次の例では、リモート バイナリ依存関係（Jetpack Macrobenchmark ライブラリ）、ローカル ライブラリ モジュール依存関係（myLibrary）、プラグイン依存関係（Android Gradle プラグイン）をプロジェクトに追加します。これらの依存関係をプロジェクトに追加する一般的な手順は次のとおりです。

1. バージョン カタログ ファイルの [versions] セクションに、必要な依存関係のバージョンのエイリアス（libs.versions.toml）を追加します（プロジェクト ビューの gradle ディレクトリまたは Android ビューの Gradle スクリプトの下）。

   [versions]
   agp = "8.3.0"
   androidx-macro-benchmark = "1.2.2"
   my-library = "1.4"
   
   [libraries]
   ...
   
   [plugins]
   ...
   

   エイリアスにはダッシュまたはアンダースコアを含めることができます。これらのエイリアスは、ビルド スクリプトで参照できるネストされた値を生成します。参照は、カタログの名前（libs.versions.toml の libs 部分）で始まります。単一バージョンのカタログを使用する場合は、デフォルト値の「libs」のままにすることをおすすめします。

2. libs.versions.toml ファイルの [libraries]（リモート バイナリまたはローカル ライブラリ モジュールの場合）または [plugins]（プラグインの場合）セクションに、依存関係のエイリアスを追加します。

   [versions]
   ...
   
   [libraries]
   androidx-benchmark-macro = { group = "androidx.benchmark", name = "benchmark-macro-junit4", version.ref = "androidx-macro-benchmark" }
   my-library = { group = "com.myapplication", name = "mylibrary", version.ref = "my-library" }
   
   [plugins]
   androidApplication = { id = "com.android.application", version.ref = "agp" }
   

   一部のライブラリは、ライブラリのファミリーとそのバージョンをグループ化した公開済みの部品構成表（BOM）で入手できます。バージョン カタログとビルドファイルに BOM を含めて、BOM にバージョンの管理を任せることができます。詳細については、部品構成表を使用するをご覧ください。

3. 依存関係を必要とするモジュールのビルド スクリプトに、依存関係のエイリアスの参照を追加します。ビルド スクリプトからエイリアスを参照する場合は、エイリアスのアンダースコアとダッシュをドットに変換します。モジュール レベルのビルド スクリプトは次のようになります。

   Kotlin

   plugins {
     alias(libs.plugins.androidApplication)
   }
   
   dependencies {
     implementation(libs.androidx.benchmark.macro)
     implementation(libs.my.library)
   }

   Groovy

   plugins {
     alias 'libs.plugins.androidApplication'
   }
   
   dependencies {
     implementation libs.androidx.benchmark.macro
     implementation libs.my.library
   }

   プラグインの参照にはカタログ名の後に plugins が含まれ、バージョンの参照にはカタログ名の後に versions が含まれます（バージョンの参照は一般的ではありません。バージョンの参照の例については、同じバージョン番号の依存関係をご覧ください）。ライブラリ参照には libraries 修飾子が含まれていないため、ライブラリ エイリアスの先頭に versions または plugins を使用できません。

依存関係の設定

dependencies ブロックで、複数の依存関係構成のうちの 1 つ（上記の implementation など）を使用して、ライブラリ依存関係を宣言できます。それぞれの依存関係構成は、依存関係の使用方法についてのさまざまな指示を Gradle に与えます。次の表は、Android プロジェクトで依存関係に使用できる各構成の説明です。

dependencies {
  // Executes lint checks from the ":checks" project at build time.
  lintChecks(project(":checks"))
  // Compiles lint checks from the ":checks-to-publish" into a
  // lint.jar file and publishes it to your Android library.
  lintPublish(project(":checks-to-publish"))
}

dependencies {
  // Executes lint checks from the ':checks' project at build time.
  lintChecks project(':checks')
  // Compiles lint checks from the ':checks-to-publish' into a
  // lint.jar file and publishes it to your Android library.
  lintPublish project(':checks-to-publish')
}

特定のビルド バリアントの依存関係を構成する

上記のすべての構成は、すべてのビルド バリアントに依存関係を適用します。これに対し、特定のビルド バリアントのソースセットまたはテスト用のソースセットのみに依存関係を宣言する場合は、構成名の先頭を大文字にして、その先頭に対象のビルド バリアントまたはテスト用のソースセットの名前を付加する必要があります。

たとえば、implementation 構成を使用して「free」プロダクト フレーバーにのみリモート バイナリ依存関係を追加するには、次のようにします。

dependencies {
    freeImplementation("com.google.firebase:firebase-ads:21.5.1")
}

dependencies {
    freeImplementation 'com.google.firebase:firebase-ads:21.5.1'
}

ただし、プロダクト フレーバーとビルドタイプを組み合わせたバリアントに依存関係を追加する場合は、コンフィグレーション名を初期化する必要があります。

// Initializes a placeholder for the freeDebugImplementation dependency configuration.
val freeDebugImplementation by configurations.creating

dependencies {
    freeDebugImplementation(project(":free-support"))
}

configurations {
    // Initializes a placeholder for the freeDebugImplementation dependency configuration.
    freeDebugImplementation {}
}

dependencies {
    freeDebugImplementation project(":free-support")
}

ローカルテストとインストルメンテーション テストに implementation 依存関係を追加するには、次のようにします。

dependencies {
    // Adds a remote binary dependency only for local tests.
    testImplementation("junit:junit:4.12")

    // Adds a remote binary dependency only for the instrumented test APK.
    androidTestImplementation("androidx.test.espresso:espresso-core:3.6.1")
}

dependencies {
    // Adds a remote binary dependency only for local tests.
    testImplementation 'junit:junit:4.12'

    // Adds a remote binary dependency only for the instrumented test APK.
    androidTestImplementation 'androidx.test.espresso:espresso-core:3.6.1'
}

ただし、この状況では、一部の構成は効果がありません。たとえば、他のモジュールが androidTest に依存できないため、androidTestApi 構成を使用すると、以下の警告が表示されます。

WARNING: Configuration 'androidTestApi' is obsolete and has been replaced with
'androidTestImplementation'.

依存関係の順序

依存関係をリストする順序は、それぞれの優先度を示します。たとえば、1 番目のライブラリは 2 番目のライブラリより優先度が高く、2 番目は 3 番目より優先度が高くなります。この順序は、ライブラリからアプリにリソースをマージする場合、またはマニフェスト要素をマージする場合に重要です。

たとえば、プロジェクトで以下を宣言したとします。

• LIB_A への依存関係と LIB_B への依存関係（この順序）
• LIB_A は LIB_C と LIB_D に依存（この順序）
• LIB_B も LIB_C に依存

この場合、依存関係の順序を展開すると次のようになります。

1. LIB_A
2. LIB_D
3. LIB_B
4. LIB_C

これにより、LIB_A と LIB_B はいずれも LIB_C より優先され、LIB_D は LIB_B よりも優先度が高くなります。これは、依存元の LIB_A の優先度が LIB_B より高いためです。

異なるプロジェクトのソースや依存関係のマニフェストをマージする方法については、複数のマニフェスト ファイルをマージするをご覧ください。

Google Play Console の依存関係情報

アプリをビルドすると、アプリにコンパイルされるライブラリ依存関係を記述するメタデータが AGP に含まれます。アプリをアップロードすると、Play Console でこのメタデータが検査され、アプリで使用されている SDK と依存関係に関する既知の問題のアラートが提供されます。また、問題を解決するための実用的なフィードバックが提供される場合もあります。

データは圧縮され、Google Play の署名鍵で暗号化されて、リリースアプリの署名ブロックに保存されます。この依存関係ファイルを保持して、安全で優れたユーザー エクスペリエンスのために役立てることをおすすめします。オプトアウトするには、モジュールの build.gradle.kts ファイルに次の dependenciesInfo ブロックを含めます。

android {
    dependenciesInfo {
        // Disables dependency metadata when building APKs.
        includeInApk = false
        // Disables dependency metadata when building Android App Bundles.
        includeInBundle = false
    }
}

依存関係に関する Google のポリシーと潜在的な問題について詳しくは、アプリでサードパーティの SDK を使用する場合のサポートページをご覧ください。

SDK 分析情報

Android Studio では、次の問題が適用される場合、バージョン カタログ ファイルと Google Play SDK Index の公開 SDK の [Project Structure] ダイアログに lint 警告が表示されます。

• SDK が作成者によって古いとマークされている。
• SDK が Google Play ポリシーに違反している。

古いバージョンを使用すると Google Play Console に今後公開できなくなる可能性があるため、こうした警告は該当する依存関係を更新するためのシグナルになります。

バージョン カタログなしでビルド依存関係を追加する

バージョン カタログを使用して依存関係を追加、管理することをおすすめしますが、シンプルなプロジェクトでは必要がない場合があります。バージョン カタログを使用しないビルドファイルの例を次に示します。

plugins {
    id("com.android.application")
}

android { ... }

dependencies {
    // Dependency on a remote binary
    implementation("com.example.android:app-magic:12.3")
    // Dependency on a local library module
    implementation(project(":mylibrary"))
}

plugins {
    id 'com.android.application'
}

android { ... }

dependencies {
    // Dependency on a remote binary
    implementation 'com.example.android:app-magic:12.3'
    // Dependency on a local library module
    implementation project(':mylibrary')
}

このビルドファイルは、「com.example.android」名前空間グループ内に存在するバージョン 12.3 の「app-magic」ライブラリへの依存関係を宣言しています。リモート バイナリ依存関係の宣言は、次の省略形です。

implementation(group = "com.example.android", name = "app-magic", version = "12.3")

implementation group: 'com.example.android', name: 'app-magic', version: '12.3'

このビルドファイルは、「mylibrary」という名前の Android ライブラリ モジュールへの依存関係も宣言します。この名前は、settings.gradle.kts ファイルの include: で定義されているライブラリ名と一致する必要があります。アプリのビルド時に、ビルドシステムはライブラリ モジュールをコンパイルし、その結果を APK にパッケージ化します。

ビルドファイルでは、Android Gradle プラグイン（com.application.android）の依存関係も宣言します。同じプラグインを使用するモジュールが複数ある場合、すべてのモジュールのビルド クラスパスに存在できるプラグインのバージョンは 1 つだけです。各モジュールのビルドスクリプトでバージョンを指定する代わりに、ルートビルド スクリプトにバージョンとともにプラグインの依存関係を含め、適用しないことを示します。apply false を追加すると、Gradle にプラグインのバージョンをメモするように指示しますが、ルートビルドで使用しないように指示します。通常、ルートビルド スクリプトは、この plugins ブロックを除いて空です。

plugins {
    id("org.jetbrains.kotlin.android") version "1.9.0" apply false
}

plugins {
    id ‘com.android.application’ version ‘8.3.0-rc02’ apply false
}

単一モジュール プロジェクトの場合は、モジュール レベルのビルド スクリプトでバージョンを明示的に指定し、プロジェクト レベルのビルド スクリプトを空のままにできます。

plugins {
    id("com.android.application") version "8.3.0"
}

plugins {
    id 'com.android.application' version '8.3.0-rc02'
}