Aggiungi dipendenze build

Il sistema di compilazione Gradle in Android Studio ti consente di includere come dipendenze nel tuo progetto i binari esterni o altri moduli della libreria. Le dipendenze possono essere situate sulla tua macchina o in un repository remoto e anche eventuali dipendenze transitive dichiarate sono incluse automaticamente. Questa pagina descrive come utilizzare le dipendenze con il progetto Android, inclusi dettagli su comportamenti e configurazioni specifici del plug-in Android Gradle (AGP). Per una guida concettuale più approfondita alle dipendenze Gradle, consulta la guida di Gradle per la gestione delle dipendenze, ma ricorda che il progetto Android deve utilizzare solo le configurazioni delle dipendenze definite in questa pagina.

Aggiungere una dipendenza da libreria o plug-in

Il modo migliore per aggiungere e gestire le dipendenze di compilazione è utilizzare i cataloghi delle versioni, il metodo utilizzato per impostazione predefinita dai nuovi progetti. Questa sezione illustra i tipi di configurazioni più comuni utilizzati per i progetti Android. Per altre opzioni, consulta la documentazione di Gradle. Per un esempio di app che utilizza i cataloghi di versioni, consulta Novità di Android. Se hai già configurato le dipendenze di compilazione senza cataloghi delle versioni e hai un progetto multi-modulo, ti consigliamo di eseguire la migrazione.

Per indicazioni su come aggiungere e gestire le dipendenze native (non comuni), consulta Dipendenze native.

Nell'esempio seguente, aggiungiamo al progetto una dipendenza da codice binario remoto (la libreria Jetpack Macrobenchmark), una dipendenza dal modulo della libreria locale (myLibrary) e una dipendenza dal plug-in (il plug-in Android Gradle). Di seguito sono riportati i passaggi generali per aggiungere queste dipendenze al progetto:

1. Aggiungi un alias per la versione della dipendenza che preferisci nella sezione [versions] del file del catalogo delle versioni, chiamato libs.versions.toml (nella directory gradle nella visualizzazione Progetto o Script Gradle nella visualizzazione Android):

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

   Gli alias possono includere trattini o trattini bassi. Questi alias generano valori nidificati a cui puoi fare riferimento negli script di compilazione. I riferimenti iniziano con il nome del catalogo, la parte libs di libs.versions.toml. Quando utilizzi un catalogo con una sola versione, ti consigliamo di mantenere il valore predefinito di "libs".

2. Aggiungi un alias per la dipendenza nelle sezioni [libraries] (per i file binari remoti o i moduli della libreria locale) o [plugins] (per i plug-in) del 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" }
   

   Alcune librerie sono disponibili in una distinta dei materiali (BOM) pubblicata che raggruppa famiglie di librerie e le relative versioni. Puoi includere una distinta nel catalogo delle versioni e nei file di compilazione e lasciare che sia il catalogo a gestire le versioni per te. Per maggiori dettagli, consulta Utilizzare la distinta componenti.

3. Aggiungi un riferimento all'alias della dipendenza allo script di compilazione dei moduli che richiedono la dipendenza. Converti i trattini bassi e i trattini degli alias in punti quando fai riferimento a un alias da uno script di compilazione. Il nostro script di compilazione a livello di modulo dovrebbe avere il seguente aspetto:

   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
   }

   I riferimenti ai plug-in includono plugins dopo il nome del catalogo e i riferimenti alle versioni includono plugins dopo il nome del catalogo (i riferimenti alle versioni sono rari; consulta Dipendenze con gli stessi numeri di versione per esempi di riferimenti alle versioni).versions I riferimenti alle librerie non includono un qualificatore libraries, pertanto non puoi utilizzare versions o plugins all'inizio di un alias della libreria.

Configura le dipendenze

All'interno del blocco dependencies, puoi dichiarare una dipendenza dalla libreria utilizzando una di diverse configurazioni di dipendenza (ad esempio implementation mostrato in precedenza). Ogni configurazione delle dipendenze fornisce a Gradle istruzioni diverse su come utilizzare la dipendenza. La tabella seguente descrive ciascuna delle configurazioni che puoi utilizzare per una dipendenza nel progetto 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')
}

Configurare le dipendenze per una variante di compilazione specifica

Tutte le configurazioni precedenti applicano le dipendenze a tutte le varianti di build. Se invece vuoi dichiarare una dipendenza solo per un insieme di origini di variante di build specifico o per un insieme di origini di test, devi usare lettere maiuscole per il nome della configurazione e anteporre il nome della variante di build o dell'insieme di origini di test.

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

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

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

L'ordine in cui elenchi le dipendenze indica la priorità di ciascuna: la prima raccolta ha una priorità più alta della seconda, la seconda ha una priorità più alta della terza e così via. Questo ordine è importante nel caso in cui le risorse vengano unite o gli elementi del manifest vengano uniti all'app dalle librerie.

Ad esempio, se il progetto dichiara quanto segue:

• Dipendenza da LIB_A e LIB_B (in questo ordine)
• e LIB_A dipende da LIB_C e LIB_D (in questo ordine)
• Inoltre, LIB_B dipende anche da LIB_C

L'ordine di dipendenza piatto sarà il seguente:

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

In questo modo, sia LIB_A che LIB_B possono sostituire LIB_C e LIB_D ha ancora una priorità più alta rispetto LIB_B perché LIB_A (che dipende da LIB_D) ha una priorità più alta rispetto a LIB_B.

Per ulteriori informazioni su come vengono uniti i manifest di origini/dipendenze di progetti diversi, consulta Unire più file manifest.

Informazioni sulle dipendenze per Play Console

Quando crei l'app, AGP include metadati che descrivono le dipendenze della libreria compilate nell'app. Quando carichi l'app, Play Console ispeziona questi metadati per fornire avvisi relativi a problemi noti con gli SDK e le dipendenze utilizzati dall'app e, in alcuni casi, fornire feedback utili per risolvere questi problemi.

I dati vengono compressi, criptati da una chiave di firma di Google Play e archiviati nel blocco di firma dell'app di rilascio. Ti consigliamo di conservare questo file delle dipendenze per un'esperienza utente positiva e sicura. Per disattivare questa funzionalità, includi il seguente blocco dependenciesInfo nel file build.gradle.kts del modulo.

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

Per ulteriori informazioni sulle nostre norme e sui potenziali problemi relativi alle dipendenze, consulta la nostra pagina di assistenza sull'utilizzo di SDK di terze parti nella tua app.

Approfondimenti sull'SDK

Android Studio mostra avvisi di lint nel file del catalogo delle versioni e nella finestra di dialogo Struttura del progetto per gli SDK pubblici nel Google Play SDK Index quando si verificano i seguenti problemi:

• Gli SDK sono contrassegnati come obsoleti dai relativi autori.
• Gli SDK violano le norme di Play.

Gli avvisi ti segnalano che devi aggiornare queste dipendenze, perché l'utilizzo di versioni obsolete potrebbe impedirti di pubblicare in Google Play Console in futuro.

Aggiungere dipendenze di compilazione senza cataloghi di versioni

Ti consigliamo di utilizzare i cataloghi delle versioni per aggiungere e gestire le dipendenze, ma i progetti semplici potrebbero non averne bisogno. Ecco un esempio di file di compilazione che non utilizza i cataloghi delle versioni:

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

Questo file di compilazione dichiara una dipendenza dalla versione 12.3 della libreria "app-magic", all'interno del gruppo di spazi dei nomi "com.example.android". La dichiarazione di dipendenza dal codice binario remoto è un'abbreviazione per quanto segue:

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

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

Il file di compilazione dichiara anche una dipendenza da un modulo della raccolta di Android denominato "mylibrary"; questo nome deve corrispondere al nome della raccolta definito con un include: nel file settings.gradle.kts. Quando compili l'app, il sistema di compilazione compila il modulo della libreria e pacchettizza i contenuti compilati risultanti nell'app.

Il file di build dichiara anche una dipendenza dal plug-in Gradle per Android (com.application.android). Se hai più moduli che utilizzano lo stesso plug-in, puoi avere una sola versione del plug-in nel percorso di classe di compilazione in tutti i moduli. Anziché specificare la versione in ciascuno degli script di compilazione del modulo, devi includere la dipendenza dal plug-in nello script di compilazione principale con la versione e indicare di non applicarla. L'aggiunta di apply false indica a Gradle di prendere nota della versione del plug-in, ma di non utilizzarla nella build principale. In genere, lo script di compilazione principale è vuoto, tranne per questo blocco 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
}

Se hai un progetto a un solo modulo, puoi specificare la versione esplicitamente nello script di compilazione a livello di modulo e lasciare vuoto lo script di compilazione a livello di progetto:

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

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