Android Studio'daki Gradle derleme sistemi, harici ikili dosyaları veya diğer kitaplık modüllerini bağımlılık olarak derlemenize dahil etmenize olanak tanır. Bağımlılıklar makinenizde veya uzak bir depoda bulunabilir ve bildirdikleri tüm geçişli bağımlılıklar da otomatik olarak dahil edilir. Bu sayfada, Android Gradle eklentisine (AGP) özgü davranışlar ve yapılandırmalarla ilgili ayrıntılar da dahil olmak üzere, Android projenizde bağımlılıkların nasıl kullanılacağı açıklanmaktadır. Gradle bağımlılıklarıyla ilgili daha ayrıntılı bir kavramsal kılavuz için Bağımlılık yönetimi için Gradle kılavuzu'na bakın. Ancak Android projenizin yalnızca bu sayfada tanımlanan bağımlılık yapılandırmalarını kullanması gerektiğini unutmayın.
Kitaplık veya eklenti bağımlılığı ekleme
Derleme bağımlılıklarını eklemenin ve yönetmenin en iyi yolu, yeni projelerin varsayılan olarak kullandığı yöntem olan sürüm kataloglarını kullanmaktır. Bu bölümde, Android projelerinde kullanılan en yaygın yapılandırma türleri ele alınmaktadır. Daha fazla seçenek için Gradle dokümanlarına bakın. Sürüm kataloglarını kullanan bir uygulama örneği için Now in Android'e bakın. Halihazırda sürüm katalogları olmadan oluşturma bağımlılıkları ayarladıysanız ve çok modüllü bir projeniz varsa taşımanızı öneririz.
Yerel bağımlılıkları (yaygın değildir) ekleme ve yönetme hakkında bilgi edinmek için Yerel bağımlılıklar başlıklı makaleyi inceleyin.
Aşağıdaki örnekte, projeye uzak ikili bağımlılık (Jetpack Macrobenchmark kitaplığı), yerel kitaplık modülü bağımlılığı (myLibrary) ve eklenti bağımlılığı (Android Gradle eklentisi) eklenir. Bu bağımlılıkları projenize eklemek için genel adımlar şunlardır:
Bağımlılığın istediğiniz sürümü için sürüm kataloğu dosyasının
[versions]bölümüne bir takma ad ekleyin. Bu dosya,libs.versions.tomlolarak adlandırılır (Proje görünümündekigradledizini altında veya Android görünümündeki Gradle Komut Dosyaları):[versions] agp = "8.3.0" androidx-macro-benchmark = "1.2.2" my-library = "1.4" [libraries] ... [plugins] ...Takma adlar tire veya alt çizgi içerebilir. Bu takma adlar, derleme komut dosyalarında referans verebileceğiniz iç içe değerler oluşturur. Referanslar, kataloğun adıyla başlar.
libs,libs.versions.tomlbölümü. Tek sürüm kataloğu kullanırken varsayılan değeri "libs." olarak bırakmanızı öneririz.[libraries](uzak ikililer veya yerel kitaplık modülleri için) ya da[plugins](eklentiler için)libs.versions.tomlbölümlerinde bağımlılık için bir takma ad ekleyin.[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" }Bazı kitaplıklar, kitaplık ailelerini ve sürümlerini gruplandıran yayınlanmış bir malzeme listesinde (BOM) bulunur. Sürüm kataloğunuza ve derleme dosyalarınıza bir BOM ekleyebilir ve bu sürümleri sizin için yönetmesine izin verebilirsiniz. Ayrıntılar için Malzeme Listesi'ni kullanma bölümüne bakın.
Bağımlılığı gerektiren modüllerin derleme komut dosyasına bağımlılık takma adına referans ekleyin. Bir derleme komut dosyasından referans verirken takma adın alt çizgilerini ve tirelerini nokta olarak dönüştürün. Modül düzeyindeki derleme komut dosyamız şu şekilde görünür:
Kotlin
plugins { alias(libs.plugins.androidApplication) } dependencies { implementation(libs.androidx.benchmark.macro) implementation(libs.my.library) }
Modern
plugins { alias 'libs.plugins.androidApplication' } dependencies { implementation libs.androidx.benchmark.macro implementation libs.my.library }
Eklenti referansları, katalog adından sonra
pluginsiçerir. Sürüm referansları ise katalog adından sonraversionsiçerir (Sürüm referansları yaygın değildir. Sürüm referanslarına ilişkin örnekler için Aynı sürüm numaralarına sahip bağımlılıklar bölümüne bakın). Kitaplık referanslarılibrariesnitelendirici içermediğinden kitaplık takma adının başındaversionsveyapluginskullanamazsınız.
Bağımlılıkları yapılandırma
dependencies bloğunda, çeşitli bağımlılık yapılandırmalarından (ör. daha önce gösterilen implementation) birini kullanarak kitaplık bağımlılığı bildirebilirsiniz. Her bağımlılık yapılandırması, Gradle'a bağımlılığın nasıl kullanılacağıyla ilgili farklı talimatlar sağlar. Aşağıdaki tabloda, Android projenizdeki bir bağımlılık için kullanabileceğiniz yapılandırmaların her biri açıklanmaktadır.
| Yapılandırma | Davranış |
|---|---|
implementation |
Gradle, bağımlılığı derleme sınıf yoluna ekler ve bağımlılığı derleme çıkışına paketler. Modülünüz bir implementation bağımlılığı yapılandırdığında Gradle'a, modülün derleme sırasında bağımlılığı diğer modüllere sızdırmasını istemediğinizi bildirir. Yani bağımlılık, mevcut modüle bağlı olan diğer modüllerin kullanımına sunulmaz.
|
api |
Gradle, bağımlılığı derleme sınıf yolu ve derleme çıkışına ekler. Bir modül api bağımlılığı içerdiğinde, Gradle'a modülün bu bağımlılığı diğer modüllere geçişli olarak aktarmak istediği bildirilir. Böylece bu bağımlılık, hem çalışma zamanında hem de derleme zamanında diğer modüller tarafından kullanılabilir.
Bu yapılandırmayı dikkatli bir şekilde ve yalnızca diğer yukarı akış tüketicilerine geçişli olarak aktarmanız gereken bağımlılıklarla kullanın. Bir |
compileOnly |
Gradle, bağımlılığı yalnızca derleme sınıf yoluna ekler
(yani derleme çıkışına eklenmez). Bu, bir Android modülü oluşturduğunuzda ve derleme sırasında bağımlılığa ihtiyacınız olduğunda yararlıdır ancak çalışma zamanında bağımlılığın mevcut olması isteğe bağlıdır. Örneğin, yalnızca derleme zamanı ek açıklamalarını içeren bir kitaplığa bağlıysanız (genellikle kod oluşturmak için kullanılır ancak çoğu zaman derleme çıktısına dahil edilmez) bu kitaplığı compileOnly olarak işaretleyebilirsiniz.
Bu yapılandırmayı kullanıyorsanız kitaplık modülünüz, bağımlılığın kullanılabilir olup olmadığını kontrol etmek için bir çalışma zamanı koşulu içermeli ve ardından, sağlanmadığı takdirde yine çalışabilmesi için davranışını sorunsuz bir şekilde değiştirmelidir. Bu, kritik olmayan geçici bağımlılıkları eklemeyerek nihai uygulamanın boyutunu küçültmeye yardımcı olur.
Not: |
runtimeOnly |
Gradle, bağımlılığı yalnızca derleme çıkışına ekler. Bu bağımlılık, çalışma zamanında kullanılabilir. Yani derleme sınıf yolu eklenmez.
Bu özellik Android'de nadiren kullanılır ancak günlüğe kaydetme uygulamaları sağlamak için sunucu uygulamalarında yaygın olarak kullanılır. Örneğin, bir kitaplık, uygulama içermeyen bir günlük kaydı API'si kullanabilir. Bu kitaplığın tüketicileri, kitaplığı implementation bağımlılığı olarak ekleyebilir ve kullanılacak gerçek günlük kaydı uygulaması için runtimeOnly bağımlılığı ekleyebilir.
|
ksp |
Bu yapılandırmalar, kodunuz derlenmeden önce ek açıklamaları ve diğer sembolleri işleyen kitaplıklar sağlar. Genellikle kodunuzu doğrular veya ek kod oluşturarak yazmanız gereken kodu azaltır. Bu tür bir bağımlılığı eklemek için Android Gradle eklentisi, JAR dosyasında aşağıdaki dosya varsa bağımlılığın bir ek açıklama işlemcisi olduğunu varsayar:
Eklenti, derleme sınıf yolunda bir ek açıklama işlemcisi algılarsa derleme hatası oluşturur.
Hangi yapılandırmayı kullanacağınıza karar verirken aşağıdakileri göz önünde bulundurun:
Açıklama işlemcilerini kullanma hakkında daha fazla bilgi için Açıklama işlemcileri ekleme başlıklı makaleyi inceleyin. |
lintChecks |
Bu yapılandırmayı, Android uygulama projenizi oluştururken Gradle'ın yürütmesini istediğiniz lint kontrollerini içeren bir kitaplığı dahil etmek için kullanın.
|
lintPublish |
Gradle'ın lint.jar dosyasına derlemesini ve AAR'nize paketlemesini istediğiniz lint kontrollerini dahil etmek için Android kitaplık projelerinde bu yapılandırmayı kullanın. Bu durum, AAR'nizi kullanan projelerin de bu lint kontrollerini uygulamasına neden olur. Yayınlanan AAR'ye lint kontrollerini dahil etmek için daha önce lintChecks bağımlılık yapılandırmasını kullanıyorsanız bu bağımlılıkları lintPublish yapılandırmasını kullanacak şekilde taşımanız gerekir.
Kotlindependencies { // 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")) } Moderndependencies { // 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') } |
Belirli bir derleme değişkeni için bağımlılıkları yapılandırma
Yukarıdaki tüm yapılandırmalar, tüm derleme varyantlarına bağımlılıklar uygular. Bunun yerine yalnızca belirli bir derleme değişkeni kaynak grubu veya testing source set için bağımlılık tanımlamak istiyorsanız yapılandırma adını büyük harfle yazıp başına derleme değişkeni veya testing source set adını eklemeniz gerekir.
Örneğin, implementation yapılandırmasını kullanarak yalnızca "free" ürün çeşnisine uzak bir ikili bağımlılık eklemek için şunu kullanın:
Kotlin
dependencies { freeImplementation("com.google.firebase:firebase-ads:21.5.1") }
Modern
dependencies { freeImplementation 'com.google.firebase:firebase-ads:21.5.1' }
Ancak bir ürün aroması ve derleme türünü birleştiren bir varyant için bağımlılık eklemek istiyorsanız yapılandırma adını başlatmanız gerekir:
Kotlin
// Initializes a placeholder for the freeDebugImplementation dependency configuration. val freeDebugImplementation by configurations.creating dependencies { freeDebugImplementation(project(":free-support")) }
Modern
configurations { // Initializes a placeholder for the freeDebugImplementation dependency configuration. freeDebugImplementation {} } dependencies { freeDebugImplementation project(":free-support") }
Yerel testleriniz ve enstrümanlı testleriniz için implementation bağımlılıkları eklemek isterseniz:
Kotlin
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") }
Modern
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' }
Ancak bazı yapılandırmalar bu durumda anlamlı değildir. Örneğin, diğer modüller androidTest modülüne bağlı olamayacağından androidTestApi yapılandırmasını kullanırsanız aşağıdaki uyarıyı alırsınız:
WARNING: Configuration 'androidTestApi' is obsolete and has been replaced with 'androidTestImplementation'.
Bağımlılık sırası
Bağımlılıklarınızı listeleme sıranız, her birinin önceliğini gösterir. Örneğin, ilk kitaplığın önceliği ikinciden, ikincinin önceliği de üçüncüden daha yüksektir. Bu sıra, kitaplıklardan uygulamanıza kaynaklar birleştirildiğinde veya manifest öğeleri birleştirildiğinde önemlidir.
Örneğin, projeniz aşağıdakileri bildiriyorsa:
LIB_AveLIB_B'ye (bu sırayla) bağımlılıkLIB_A,LIB_CveLIB_D'ye bağlıdır (bu sırayla)- Ayrıca
LIB_B,LIB_CSDK'sına da bağlıdır.
Bu durumda, düz bağımlılık sırası aşağıdaki gibi olur:
LIB_ALIB_DLIB_BLIB_C
Bu sayede hem LIB_A hem de LIB_B, LIB_C'yi geçersiz kılabilir. Ayrıca LIB_A (LIB_B'ye bağlıdır) LIB_B'den daha yüksek önceliğe sahip olduğundan LIB_D, LIB_B'den daha yüksek önceliğe sahip olmaya devam eder.
Farklı proje kaynaklarından veya bağımlılıklarından gelen manifestlerin nasıl birleştirildiği hakkında daha fazla bilgi için Birden fazla manifest dosyasını birleştirme başlıklı makaleyi inceleyin.
Play Console için bağımlılık bilgileri
AGP, uygulamanızı oluştururken uygulamanıza derlenen kitaplık bağımlılıklarını açıklayan meta verileri içerir. Uygulamanızı yüklerken Play Console, uygulamanızın kullandığı SDK'lar ve bağımlılıklarla ilgili bilinen sorunlar için uyarılar sağlamak ve bazı durumlarda bu sorunları çözmek için uygulanabilir geri bildirimler sağlamak üzere bu meta verileri inceler.
Veriler sıkıştırılır, Google Play imzalama anahtarıyla şifrelenir ve yayın uygulamanızın imzalama bloğunda saklanır. Güvenli ve olumlu bir kullanıcı deneyimi için bu bağımlılıklar dosyasını saklamanızı öneririz. Modülünüzün build.gradle.kts dosyasına aşağıdaki
dependenciesInfo
bloğunu ekleyerek bu özelliği devre dışı bırakabilirsiniz.
android {
dependenciesInfo {
// Disables dependency metadata when building APKs.
includeInApk = false
// Disables dependency metadata when building Android App Bundles.
includeInBundle = false
}
}
Politikalarımız ve bağımlılıklarla ilgili olası sorunlar hakkında daha fazla bilgi için uygulamanızda üçüncü taraf SDK kullanma başlıklı destek sayfamızı inceleyin.
SDK analizleri
Android Studio, aşağıdaki sorunlar geçerli olduğunda Google Play SDK Dizini'ndeki herkese açık SDK'lar için sürüm kataloğu dosyasında ve Proje Yapısı iletişim kutusunda lint uyarıları gösterir:
- SDK'lar yazarları tarafından eski olarak işaretlenir.
- SDK'lar Play politikalarını ihlal ediyor.
- SDK'larda bilinen güvenlik açıkları var.
- SDK'lar, yazarları tarafından kullanımdan kaldırılmıştır.
Uyarılar, bu bağımlılıkları güncellemeniz gerektiğine dair sinyallerdir. Çünkü eski sürümleri kullanmak, gelecekte Google Play Console'da yayın yapmanızı engelleyebilir.
Sürüm katalogları olmadan derleme bağımlılıkları ekleme
Bağımlılıkları eklemek ve yönetmek için sürüm kataloglarını kullanmanızı öneririz ancak basit projelerde bu kataloglara ihtiyaç duyulmayabilir. Aşağıda, sürüm kataloglarının kullanılmadığı bir derleme dosyası örneği verilmiştir:
Kotlin
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")) }
Modern
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') }
Bu derleme dosyası, "com.example.android" ad alanı grubundaki "app-magic" kitaplığının 12.3 sürümüne bağımlılık bildiriyor. Uzak ikili bağımlılık bildirimi, aşağıdakilerin kısaltmasıdır:
Kotlin
implementation(group = "com.example.android", name = "app-magic", version = "12.3")
Modern
implementation group: 'com.example.android', name: 'app-magic', version: '12.3'
Derleme dosyası, "mylibrary" adlı bir Android kitaplık modülüne bağımlılığı da bildirir. Bu ad, settings.gradle.kts dosyanızda include: ile tanımlanan kitaplık adıyla eşleşmelidir. Uygulamanızı oluşturduğunuzda derleme sistemi, kitaplık modülünü derler ve derlenen içerikleri uygulamada paketler.
Derleme dosyası, Android Gradle eklentisine (com.application.android) olan bağımlılığı da bildirir. Aynı eklentiyi kullanan birden fazla modülünüz varsa tüm modüllerde derleme sınıf yolunda eklentinin yalnızca tek bir sürümü olabilir. Sürümü her modülün derleme komut dosyalarında belirtmek yerine, eklenti bağımlılığını sürümle birlikte kök derleme komut dosyasına ekleyip uygulanmaması gerektiğini belirtmeniz gerekir. apply false eklemek, Gradle'a eklentinin sürümünü not etmesini ancak kök derlemede kullanmamasını söyler.
Genellikle kök derleme komut dosyası, bu plugins bloğu dışında boştur.
Kotlin
plugins { id("org.jetbrains.kotlin.android") version "1.9.0" apply false }
Modern
plugins { id 'com.android.application' version '8.3.0-rc02' apply false }
Tek modüllü bir projeniz varsa sürümü modül düzeyindeki derleme komut dosyasında açıkça belirtebilir ve proje düzeyindeki derleme komut dosyasını boş bırakabilirsiniz:
Kotlin
plugins { id("com.android.application") version "8.3.0" }
Modern
plugins { id 'com.android.application' version '8.3.0-rc02' }