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

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 という依存関係のバージョンのエイリアスを追加します（[Project] ビューの gradle ディレクトリまたは [Android] ビューの Gradle Scripts の下）。

   [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 ブロック内で、複数の依存関係コンフィグレーション（前述の 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.5.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.5.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 には、アプリにコンパイルされるライブラリ依存関係を記述するメタデータが含まれます。アプリをアップロードすると、Google 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」名前空間グループ内で、「app-magic」ライブラリのバージョン 12.3 への依存関係を宣言しています。リモート バイナリの依存関係宣言は、次の省略形です。

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: で定義されたライブラリ名と一致する必要があります。アプリのビルド時、ビルドシステムはライブラリ モジュールをコンパイルし、コンパイルしたコンテンツをアプリにパッケージ化します。

ビルドファイルでは、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'
}