Cómo agregar dependencias de compilación

El sistema de compilación de Gradle en Android Studio te permite incluir binarios y otros módulos de biblioteca a tu compilación como dependencias. Las dependencias pueden ubicarse en tu máquina o en un repositorio remoto, y cualquier dependencia transitiva que estas declaren se incluirá automáticamente. En esta página, se describe cómo usar dependencias con tu proyecto de Android, lo que incluye son los detalles sobre los comportamientos y las configuraciones que son el complemento de Android para Gradle (AGP). A fin de obtener una guía conceptual más detallada sobre las dependencias de Gradle, también deberías consultar la Guía de Gradle para la administración de dependencias. Sin embargo, recuerda que tu proyecto de Android solo debe usar los parámetros de configuración de dependencias que se definen en esta página.

Cómo agregar una dependencia de biblioteca o complemento

La mejor manera de agregar y administrar dependencias de compilación es usar catálogos de versiones, el método que usan los nuevos proyectos de forma predeterminada. En esta sección, se abarcan los temas más comunes tipos de configuraciones que se usan para proyectos de Android consulta la Documentación de Gradle para conocer más opciones. Para ver un ejemplo de una app que usa catálogos de versiones, consulta Ahora en Android. Si ya configuraste dependencias de compilación sin catálogos de versiones y con un proyecto de varios módulos, te recomendamos Migración.

Para obtener orientación sobre cómo agregar y administrar dependencias nativas (no común), consulta Dependencias nativas.

En el siguiente ejemplo, agregamos un objeto binario remoto dependencia (el componente de Jetpack Macrobenchmark biblioteca), módulo de biblioteca local dependencia (myLibrary) y un complemento (el complemento de Android para Gradle) a nuestro proyecto. Estas son las preguntas pasos para agregar estas dependencias a tu proyecto:

1. Agrega un alias para la versión de la dependencia que quieres en el Sección [versions] del archivo de catálogo de versiones, llamada libs.versions.toml (en el directorio gradle de vista Project o secuencias de comandos de Gradle en la vista Android):

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

   Los alias pueden incluir guiones o guiones bajos. Estos alias generan valores anidados al que puedes hacer referencia en las secuencias de comandos de compilación. Las referencias comienzan con el nombre del catálogo, la parte libs de libs.versions.toml. Cuándo con un catálogo de versiones único, te recomendamos que mantengas el valor predeterminado de "libs".

2. Agrega un alias para la dependencia en [libraries] (para binarios remotos o módulos de bibliotecas locales) o [plugins] (para (complementos) del archivo 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" }
   

   Algunas bibliotecas están disponibles en una lista de materiales (BoM) publicada que grupos de familias de bibliotecas y sus versiones. Puedes incluir una BoM en tu catálogo de versiones y archivos de compilación, y dejar que administre esas versiones por ti. Consulta Cómo usar la lista de materiales para obtener más detalles.

3. Agrega una referencia al alias de dependencia a la secuencia de comandos de compilación del módulos que requieren la dependencia. Convertir el alias guiones bajos y guiones en puntos cuando haces referencia a ellos desde una secuencia de comandos de compilación. Nuestra secuencia de comandos de compilación a nivel de módulo se vería así:

   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
   }
   

   Las referencias de complementos incluyen plugins después del nombre del catálogo. las referencias de la versión incluyen versions después del nombre del catálogo (versión las referencias son poco comunes; consulta Dependencias con los mismos números de versión para ver ejemplos de referencias de versiones). Biblioteca las referencias no incluyen un calificador libraries, por lo que no puedes usar versions o plugins al comienzo de una biblioteca alias.

Configurar dependencias

Dentro del bloque dependencies, puedes declarar una dependencia de biblioteca con uno de varios parámetros de configuración de dependencias diferentes (como implementation anteriormente). La configuración de cada dependencia le proporciona a Gradle diferentes instrucciones para usarla. En la siguiente tabla, se describe cada una de las configuraciones que puedes usar para una dependencia en tu proyecto de 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')
}

Cómo configurar dependencias para una variante de compilación específica

Todas las configuraciones anteriores aplican dependencias a todas las variantes de compilación. Si sino que declaras una dependencia solo para una compilación específica de origen de la variante o de una fuente de prueba set, debes escribir en mayúscula la configuración y agrégale un prefijo con el nombre de la variante de compilación o el conjunto de orígenes de prueba.

Por ejemplo, para agregar una dependencia binaria remota solo a tu app "free" producto variante con la configuración implementation, usa lo siguiente:

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

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

Sin embargo, si deseas agregar una dependencia para una variante que combina un producto y un tipo de compilación, debes inicializar el nombre de la configuración:

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

Las dependencias implementation que agregues en las pruebas instrumentadas y las locales tendrán el siguiente aspecto:

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

Sin embargo, algunas opciones de configuración no son útiles en esta situación. Por ejemplo, como otros módulos no pueden depender de androidTest, verás la siguiente advertencia si usas la configuración androidTestApi:

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

Orden de las dependencias

El orden en el que enumeras tus dependencias indica la prioridad de cada una: la primera biblioteca tendrá mayor prioridad que la segunda, la segunda tendrá mayor prioridad que la tercera, y así sucesivamente. Este orden es importante en el caso de que se combinen los recursos o se combinen los elementos del manifiesto en tu app desde las bibliotecas.

Por ejemplo, si en tu proyecto se declara lo siguiente:

• Hay una dependencia en LIB_A y LIB_B (en ese orden).
• Además, LIB_A depende de LIB_C y LIB_D (en ese orden).
• LIB_B también depende de LIB_C.

Luego, el orden de la dependencia única será el siguiente:

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

De esta manera, se garantiza que tanto LIB_A como LIB_B puedan anular a LIB_C; además, LIB_D sigue teniendo mayor prioridad que LIB_B porque LIB_A (que depende de esta) tiene mayor prioridad que LIB_B.

Para descubrir cómo se fusionan los manifiestos de diferentes fuentes o dependencias de proyectos, consulta Cómo fusionar varios archivos de manifiestos.

Información de la dependencia de Play Console

Cuando compilas tu app, AGP incluye metadatos que describen la biblioteca las dependencias que se compilan en tu app. Cuando subes tu app, el ícono de Play La consola inspecciona estos metadatos para brindar alertas sobre problemas conocidos con SDKs las dependencias que usa tu app y, en algunos casos, proporcionar comentarios prácticos para resolver esos problemas.

Los datos se comprimen, encriptan con una clave de firma de Google Play y se almacenan en el bloque de firma de tu app de lanzamiento. Recomendamos mantener estas dependencias para garantizar una experiencia del usuario segura y positiva. Para inhabilitarlo, incluye siguiendo dependenciesInfo bloque en el archivo build.gradle.kts de tu módulo.

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

Para obtener más información sobre nuestras políticas y posibles problemas con las dependencias, consulta nuestra página de asistencia para usar los SDK de terceros en tu app.

Estadísticas del SDK

Android Studio muestra advertencias de lint en el archivo de catálogo de versiones y en la sección Project Structure Dialog para SDKs públicos en el Índice SDK de Google Play cuando se apliquen los siguientes problemas:

• Los autores marcan los SDKs como desactualizados.
• Los SDKs incumplen las políticas de Play.

Las advertencias indican que debes actualizar esas dependencias usar versiones desactualizadas podría impedir que publiques contenido en Google Play de Cloud en el futuro.

Cómo agregar dependencias de compilación sin catálogos de versiones

Recomendamos usar catálogos de versiones para agregar y administrar dependencias, es posible que los proyectos no los necesiten. Este es un ejemplo de un archivo de compilación que no usa Catálogos de versiones:

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

Este archivo de compilación declara una dependencia en la versión 12.3 de la función "app-magic" dentro de "com.example.android" un grupo de espacios de nombres. El objeto binario remoto La declaración de dependencia es una abreviatura de lo siguiente:

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

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

El archivo de compilación también declara una dependencia en un módulo de biblioteca de Android denominado “mibiblioteca”; este nombre debe coincidir con el nombre de la biblioteca definido con un include: en tu archivo settings.gradle.kts. Cuando compilas tu app, el sistema de compilación compila el módulo de biblioteca y empaqueta el contenido compilado resultante en el .

El archivo de compilación también declara una dependencia en el complemento de Android para Gradle. (com.application.android). Si tienes varios módulos que usan la misma solo puedes tener una versión única del complemento en la ruta de clase de la compilación en todos los módulos. En lugar de especificar la versión en cada módulo las secuencias de comandos de compilación, debes incluir la dependencia del complemento en la secuencia de comandos de compilación raíz. con la versión e indica que no la apliques. Agregar apply false le indica Gradle tome nota de la versión del complemento, pero no la use en la compilación raíz. Por lo general, la secuencia de comandos de compilación raíz está vacía, excepto este bloque 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
}

Si tienes un proyecto de un solo módulo, puedes especificar la versión explícitamente en la secuencia de comandos de compilación a nivel de módulo y deja vacía esta secuencia:

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

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