Menambahkan dependensi build

Sistem build Gradle di Android Studio memungkinkan Anda menyertakan biner atau modul library lainnya ke build Anda sebagai dependensi. Dependensi dapat ditemukan di komputer Anda atau di repositori jarak jauh, dan setiap dependensi transitif yang dideklarasikan akan otomatis disertakan. Halaman ini menjelaskan cara menggunakan dependensi dengan project Android Anda, termasuk tentang perilaku dan konfigurasi yang spesifik untuk plugin Android Gradle (AGP). Untuk panduan konseptual yang lebih mendalam tentang dependensi Gradle, sebaiknya Anda juga membaca Panduan Gradle untuk pengelolaan dependensi, tetapi ingat bahwa project Android Anda hanya boleh menggunakan konfigurasi dependensi yang ditentukan pada halaman ini.

Menambahkan library atau dependensi plugin

Cara terbaik untuk menambahkan dan mengelola dependensi build adalah dengan menggunakan katalog versi, metode yang digunakan proyek baru secara {i>default<i}. Bagian ini membahas hal-hal yang paling umum jenis konfigurasi yang digunakan untuk project Android; lihat Dokumentasi Gradle untuk opsi lainnya. Untuk contoh aplikasi yang menggunakan katalog versi, lihat Kini di Android. Jika Anda telah menyiapkan dependensi build tanpa katalog versi dan memiliki project multi-modul, sebaiknya bermigrasi.

Untuk panduan menambahkan dan mengelola dependensi native (tidak umum), lihat Dependensi native.

Pada contoh berikut, kami menambahkan biner jarak jauh dependensi (Jetpack Macrobenchmark library), modul library lokal dependensi (myLibrary), dan plugin (plugin Android Gradle) ke project kita. Berikut adalah langkah-langkah untuk menambahkan dependensi ini ke project Anda:

1. Tambahkan alias untuk versi dependensi yang Anda inginkan dalam Bagian [versions] di file katalog versi, yang disebut libs.versions.toml (pada direktori gradle di Tampilan Project atau Gradle Scripts di tampilan Android):

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

   Alias dapat menyertakan tanda hubung atau garis bawah. Alias ini menghasilkan nilai bertingkat yang dapat direferensikan dalam skrip build. Referensi dimulai dengan nama katalog, bagian libs dari libs.versions.toml. Kapan menggunakan satu katalog versi, sebaiknya pertahankan nilai default "libs".

2. Tambahkan alias untuk dependensi dalam [libraries] (untuk biner jarak jauh atau modul library lokal) atau [plugins] (untuk plugin) dari file libs.versions.toml.

   [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" }
   

   Beberapa library tersedia dalam Bill of Materials (BOM) yang telah dipublikasikan yang kelompok library dan versinya. Anda dapat menyertakan BOM dalam katalog versi, dan file build, serta mengizinkannya mengelola versi tersebut untuk Anda. Lihat Menggunakan Bill of Materials untuk mengetahui detailnya.

3. Tambahkan referensi ke alias dependensi ke skrip build dari modul yang memerlukan dependensi. Konversi alias garis bawah dan tanda hubung menjadi titik-titik saat Anda mereferensikannya dari skrip build. Skrip build level modul kami akan terlihat seperti ini:

   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
   }
   

   Referensi plugin menyertakan plugins setelah nama katalog, dan referensi versi menyertakan versions setelah nama katalog (versi jarang digunakan; lihat Dependensi dengan nomor versi yang sama sebagai contoh referensi versi.) Galeri foto referensi tidak menyertakan penentu libraries, sehingga Anda tidak dapat menggunakan versions atau plugins di awal library alias.

Mengonfigurasi dependensi

Di dalam blok dependencies, Anda dapat mendeklarasikan dependensi library menggunakan satu dari beberapa konfigurasi dependensi yang berbeda (seperti implementation yang ditampilkan sebelumnya). Setiap konfigurasi dependensi memberikan petunjuk yang berbeda kepada Gradle tentang cara menggunakan dependensi. Tabel berikut menjelaskan setiap konfigurasi yang dapat Anda gunakan untuk dependensi di project Android Anda.

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')
}

Mengonfigurasi dependensi untuk varian build tertentu

Semua konfigurasi sebelumnya menerapkan dependensi ke semua varian build. Jika Anda ingin mendeklarasikan dependensi hanya untuk build tertentu set sumber varian atau untuk sumber pengujian tetapkan, Anda harus menggunakan huruf besar untuk konfigurasi dan berikan awalan dengan nama varian build atau set sumber pengujian.

Misalnya, untuk menambahkan dependensi biner jarak jauh hanya ke dependensi "free" produk menggunakan konfigurasi implementation, gunakan ini:

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

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

Namun, jika Anda ingin menambahkan dependensi untuk varian yang menggabungkan produk dan jenis build, maka Anda harus menginisialisasi nama konfigurasi:

// 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")
}

Untuk menambahkan dependensi implementation bagi pengujian lokal dan pengujian berinstrumen, caranya adalah seperti berikut:

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'
}

Namun, konfigurasi tertentu tidak cocok dengan situasi ini. Misalnya, karena modul lain tidak dapat bergantung pada androidTest, Anda akan mendapatkan peringatan berikut jika menggunakan konfigurasi androidTestApi:

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

Urutan dependensi

Urutan pencantuman dependensi menunjukkan prioritas untuk setiap dependensi: library pertama memiliki prioritas lebih tinggi daripada library kedua, library kedua memiliki prioritas lebih tinggi daripada library ketiga, dan seterusnya. Urutan ini penting jika resource digabungkan atau elemen manifes digabungkan ke dalam aplikasi Anda dari library.

Misalnya, jika project Anda mendeklarasikan dependensi berikut:

• Dependensi pada LIB_A dan LIB_B (dalam urutan tersebut)
• Dan LIB_A bergantung pada LIB_C dan LIB_D (dalam urutan tersebut)
• Serta LIB_B juga bergantung pada LIB_C

Urutan dependensi rata akan menjadi seperti berikut:

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

Ini memastikan bahwa baik LIB_A maupun LIB_B dapat menggantikan LIB_C; dan LIB_D masih lebih tinggi prioritasnya daripada LIB_B karena LIB_A (yang bergantung padanya) memiliki prioritas lebih tinggi daripada LIB_B.

Untuk mengetahui informasi selengkapnya tentang penggabungan manifes dari sumber/dependensi project yang berbeda, baca Menggabungkan beberapa file manifes.

Informasi dependensi untuk Konsol Play

Saat membangun aplikasi, AGP menyertakan metadata yang menjelaskan library dependensi yang dikompilasi ke dalam aplikasi Anda. Saat mengupload aplikasi Anda, Play Store Konsol memeriksa metadata guna memberikan pemberitahuan untuk masalah umum pada SDK dan dependensi yang digunakan aplikasi Anda, dan, dalam beberapa kasus, memberikan masukan yang dapat ditindaklanjuti untuk menyelesaikan masalah tersebut.

Data dikompresi, dienkripsi oleh kunci penandatanganan Google Play, dan disimpan di blok penandatanganan aplikasi rilis Anda. Sebaiknya pertahankan dependensi ini untuk menciptakan pengalaman pengguna yang aman dan positif. Anda dapat memilih tidak ikut dengan menyertakan mengikuti dependenciesInfo di file build.gradle.kts modul Anda.

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

Untuk informasi lengkap kebijakan kami dan potensi masalah dengan dependensi, lihat halaman dukungan kami tentang menggunakan SDK pihak ketiga di aplikasi Anda.

Insight SDK

Android Studio menampilkan peringatan lint dalam file katalog versi dan Project Dialog Struktur untuk SDK publik di Google Play SDK Index jika masalah berikut terjadi:

• SDK ditandai sebagai usang oleh penulisnya.
• SDK melanggar kebijakan Play.

Peringatan merupakan sinyal bahwa Anda harus memperbarui dependensi tersebut, karena menggunakan versi yang sudah usang dapat mencegah Anda memublikasikan ke Google Play Konsol di masa mendatang.

Menambahkan dependensi build tanpa katalog versi

Sebaiknya gunakan katalog versi untuk menambahkan dan mengelola dependensi, tetapi hal ini sederhana proyek mungkin tidak membutuhkannya. Berikut contoh file build yang tidak menggunakan katalog versi:

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')
}

File build ini mendeklarasikan dependensi pada "app-magic" versi 12.3 library, di dalam "com.example.android" grup namespace. Biner jarak jauh deklarasi dependensi adalah singkatan untuk hal-hal berikut:

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

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

File build juga mendeklarasikan dependensi pada modul library Android bernama "mylibrary"; nama ini harus cocok dengan nama library yang ditentukan dengan include: di file settings.gradle.kts Anda. Saat Anda membangun aplikasi, sistem build mengompilasi modul {i>library<i} dan memaketkan konten terkompilasi yang dihasilkan ke dalam .

File build juga mendeklarasikan dependensi pada plugin Android Gradle (com.application.android). Jika Anda memiliki beberapa modul yang menggunakan , Anda hanya bisa memiliki satu versi plugin pada classpath build di semua modul. Daripada menetapkan versi di setiap modul, Anda harus menyertakan dependensi plugin dalam skrip build root dengan versi, dan menunjukkan untuk tidak menerapkannya. Menambahkan apply false memberi tahu Gradle untuk mencatat versi plugin, tetapi tidak untuk menggunakannya dalam build root. Biasanya skrip build root kosong kecuali untuk blok plugins ini.

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

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

Jika memiliki project modul tunggal, Anda dapat menentukan versi secara eksplisit di skrip build level modul dan biarkan skrip build level project kosong:

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

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