Derleme bağımlılıkları ekleme

Android Studio'daki Gradle derleme sistemi, derlemenize harici ikili dosyalar veya diğer kitaplık modüllerini bağımlı olarak eklemenize olanak tanır. Bağımlılıklar makinenizde veya uzaktaki bir depoda bulunabilir ve belirttikleri 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 projenizle 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ılavuzunu da inceleyebilirsiniz. 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ığı ekleyip 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 projeleri için kullanılan en yaygın yapılandırma türleri ele alınmaktadır. Daha fazla seçenek için Gradle belgelerine bakın. Sürüm kataloglarını kullanan bir uygulama örneği için Android'de kullanıma sunuldu başlıklı makaleyi inceleyin. Sürüm katalogları olmadan derleme bağımlılıkları oluşturduysanız ve çok modüllü bir projeniz varsa taşımanızı öneririz.

Yerel bağımlılıkları (yaygın olmayan) ekleme ve yönetmeyle ilgili yardım için Yerel bağımlılıklar başlıklı makaleyi inceleyin.

Aşağıdaki örnekte, projemize bir uzak ikili bağımlılığı (Jetpack Macrobenchmark kitaplığı), yerel kitaplık modülü bağımlılığı (myLibrary) ve bir eklenti bağımlılığı (Android Gradle eklentisi) ekliyoruz. Bu bağımlılıkları projenize eklemek için genel adımlar şunlardır:

1. Sürüm katalogu dosyasının [versions] bölümünde, istediğiniz bağımlılık sürümünün libs.versions.toml adlı bir takma adı ekleyin (Proje görünümünde gradle dizininin altında veya Android görünümünde Gradle Komut Dosyaları altında):

   [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 yerleştirilmiş değerler oluşturur. Referanslar, libs.versions.toml öğesinin libs kısmı olan katalog adıyla başlar. Tek sürümlü bir katalog kullanırken varsayılan "libs" değerini korumanızı öneririz.

2. libs.versions.toml dosyasının [libraries] (uzak ikili dosyalar veya yerel kitaplık modülleri için) veya [plugins] (eklentiler için) bölümlerine 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 Listesi'nde (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.

3. Bağımlılığı gerektiren modüllerin derleme komut dosyasına bağımlılık takma adına bir referans ekleyin. Takma ada bir derleme komut dosyasından referans verirken takma adın alt çizgilerini ve kısa çizgilerini noktaya 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)
   }

   Groovy

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

   Eklenti referansları, katalog adından sonra plugins içerir ve sürüm referansları, katalog adından sonra versions içerir (sürüm referansları yaygın değildir; sürüm referansları örnekleri için Aynı sürüm numaralarına sahip bağımlılar bölümüne bakın.) Kitaplık referansları libraries seçici içermez. Bu nedenle, kitaplık takma adının başında versions veya plugins kullanamazsınız.

Bağımlılıkları yapılandırma

dependencies bloğunun içinde, çeşitli farklı bağımlılık yapılandırmalarından birini (daha önce gösterilen implementation gibi) kullanarak bir kitaplık bağımlılığı beyan edebilirsiniz. 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 projenizde bağımlılık için kullanabileceğiniz yapılandırmaların her biri açıklanmaktadır.

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

Belirli bir derleme varyantı için bağımlılıkları yapılandırma

Yukarıdaki yapılandırmaların tümü, tüm derleme varyantlarına bağımlılık uygular. Bunun yerine yalnızca belirli bir derleme varyantı kaynak grubu veya test kaynak grubu için bağımlılık beyan etmek istiyorsanız yapılandırma adını büyük harfle yazmalı ve derleme varyantının veya test kaynak grubunun adıyla ön ek olarak eklemeniz gerekir.

Örneğin, implementation yapılandırmasını kullanarak yalnızca "ücretsiz" ürün çeşidinize uzak bir ikili bağımlılık eklemek için şunları kullanın:

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

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

Ancak, bir ürün çeşidini 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:

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

Yerel testleriniz ve enstrümante edilmiş testleriniz için implementation bağımlılıkları eklemek isterseniz aşağıdaki gibi görünür:

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

Ancak bu durumda belirli yapılandırmalar anlamlı değildir. Örneğin, diğer modüller androidTest'e 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ı listelediğiniz sıra, her birinin önceliğini belirtir: İlk kitaplık ikinci kitaplıktan, ikinci kitaplık üçüncü kitaplıktan daha yüksek önceliğe sahiptir. Kaynakların birleştirilmesi veya manifest öğelerinin kitaplıklardan uygulamanızla birleştirilmesi durumunda bu sıra önemlidir.

Örneğin, projenizde aşağıdakiler belirtilmişse:

• LIB_A ve LIB_B'a bağımlılık (bu sırayla)
• LIB_A, LIB_C ve LIB_D değerlerine bağlı olarak (bu sırayla)
• LIB_B, LIB_C'a da bağlıdır.

Bu durumda, sabit bağımlılık sırası aşağıdaki gibi olur:

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

Bu sayede hem LIB_A hem de LIB_B, LIB_C öğesini geçersiz kılabilir. Ayrıca LIB_D öğesinin önceliği, LIB_B değerinden daha yüksek olur çünkü LIB_A (buna bağlıdır) LIB_B değerinden daha yüksek önceliğe sahiptir.

Farklı proje kaynaklarından/bağımlılıklardan gelen manifest dosyalarının 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ızda derlenen kitaplık bağımlılıklarını açıklayan meta verileri ekler. Play Console, uygulamanızı yüklerken bu meta verileri inceleyerek uygulamanızın kullandığı SDK'lar ve bağımlılıklarla ilgili bilinen sorunlarla ilgili uyarılar sağlar ve bazı durumlarda bu sorunları çözmek için uygulanabilir geri bildirim sunar.

Veriler sıkıştırılır, bir Google Play imzalama anahtarıyla şifrelenir ve yayınlama uygulamanızın imzalama bloğunda depolanır. Güvenli ve olumlu bir kullanıcı deneyimi için bu bağımlılık 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'ları kullanma konulu destek sayfamıza göz atın.

SDK analizleri

Android Studio, aşağıdaki sorunlar geçerli olduğunda sürüm kataloğu dosyasında ve Google Play SDK Dizini'ndeki herkese açık SDK'lar için Proje Yapısı İletişim Kutusu'nda lint uyarıları gösterir:

• SDK'lar, yazarları tarafından güncel olmadığı şekilde işaretlenir.
• SDK'lar Play politikalarını ihlal ediyor.

Uyarılar, eski sürümlerin kullanılması gelecekte Google Play Console'da uygulama yayınlamanızı engelleyebileceği için bu bağımlılıkları güncellemeniz gerektiğini gösteren sinyallerdir.

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 bunlara ihtiyaç duyulmayabilir. Sürüm kataloglarının kullanılmadığı bir derleme dosyası örneğini burada bulabilirsiniz:

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

Bu derleme dosyası, "com.example.android" ad alanını içeren gruptaki "app-magic" kitaplığının 12.3 sürümüne bağımlılık belirtir. Uzak ikili bağımlılık beyanı aşağıdakilerin kısaltmasıdır:

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

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

Derleme dosyası ayrıca "mylibrary" adlı bir Android kitaplık modülüne bağımlılık da belirtir. Bu ad, settings.gradle.kts dosyanızda include: ile tanımlanan kitaplık adıyla eşleşmelidir. Uygulamanızı derlediğinizde derleme sistemi, kitaplık modülünü derler ve derlenen içeriği uygulamaya paketler.

Derleme dosyası, Android Gradle eklentisine (com.application.android) de bağımlılık bildirir. Aynı eklentiyi kullanan birden fazla modülünüz varsa tüm modüller genelinde derleme sınıf yolu için eklentinin yalnızca tek bir sürümüne sahip olabilirsiniz. Modül derleme komut dosyalarının her birinde sürümü belirtmek yerine, eklenti bağımlılığını kök derleme komut dosyasına sürümle birlikte eklemeniz ve uygulanmamasını belirtmeniz gerekir. apply false eklenmesi, Gradle'a eklentinin sürümünü not etmesini ancak kök derlemede kullanmamasını söyler. Kök derleme komut dosyası genellikle bu plugins bloğu dışında boştur.

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

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:

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

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