Mit Gradle-Versionskatalogen können Sie Abhängigkeiten und Plug-ins skalierbar hinzufügen und verwalten. Mit Gradle-Versionskatalogen können Sie Abhängigkeiten und Plug-ins einfacher verwalten, wenn Sie mehrere Module haben. Anstatt Abhängigkeitsnamen und ‑versionen in einzelnen Build-Dateien fest zu codieren und jeden Eintrag zu aktualisieren, wenn Sie eine Abhängigkeit aktualisieren müssen, können Sie einen zentralen Versionskatalog mit Abhängigkeiten erstellen, auf die verschiedene Module mit Unterstützung von Android Studio typsicher verweisen können.
Diese Seite enthält grundlegende Informationen zur Migration Ihrer Android-App zu Versionskatalogen. Weitere Informationen finden Sie unter Build-Abhängigkeiten hinzufügen und in der Gradle-Dokumentation.
Versionskatalogdatei erstellen
Erstellen Sie zuerst eine Versionskatalogdatei. Erstellen Sie im Ordner gradle Ihres Stammprojekts eine Datei mit dem Namen libs.versions.toml. Gradle sucht standardmäßig in der Datei libs.versions.toml nach dem Katalog. Wir empfehlen daher, diesen Standardnamen zu verwenden.
Fügen Sie in der Datei libs.versions.toml die folgenden Abschnitte hinzu:
[versions]
[libraries]
[plugins]
Die Abschnitte werden so verwendet:
- Definieren Sie im Block
versionsVariablen, die die Versionen Ihrer Abhängigkeiten und Plug-ins enthalten. Sie verwenden diese Variablen in den nachfolgenden Blöcken (den Blöckenlibrariesundplugins). - Definieren Sie im Block
librariesIhre Abhängigkeiten. - Definieren Sie im Block
pluginsIhre Plug-ins.
Migrationsschritte
Wir empfehlen, die Schritte in der angegebenen Reihenfolge auszuführen. Ein Build kann Abhängigkeiten und Plug-ins aus Build-Skripts und Katalogen gleichzeitig nutzen. Nehmen Sie sich also Zeit, um Ihre Abhängigkeiten und Plug-ins einzeln zu migrieren.
Der Migrationsprozess umfasst Folgendes:
- Fügen Sie den neuen Eintrag dem Katalog hinzu.
- Synchronisieren Sie Ihr Android-Projekt.
- Ersetzen Sie die vorherige Stringdeklaration durch die typsichere Zugriffsfunktion für den Katalog.
Abhängigkeiten migrieren
Fügen Sie für jede Abhängigkeit einen Eintrag in den Abschnitten versions und libraries der Datei libs.versions.toml hinzu. Synchronisieren Sie Ihr Projekt und ersetzen Sie dann die Deklarationen in den Build-Dateien durch die Katalognamen.
Dieses Code-Snippet zeigt die Datei build.gradle.kts vor dem Entfernen der Abhängigkeit:
Kotlin
dependencies { implementation("androidx.core:core-ktx:1.9.0") }
Groovy
dependencies { implementation 'androidx.core:core-ktx:1.9.0' }
In diesem Code-Snippet wird gezeigt, wie die Abhängigkeit in der Versionskatalogdatei definiert wird:
[versions]
ktx = "1.9.0"
[libraries]
androidx-ktx = { group = "androidx.core", name = "core-ktx", version.ref = "ktx" }
Die empfohlene Benennung für den Abhängigkeitenblock in Katalogen ist Dash-Case (z. B. androidx-ktx), um die Unterstützung bei der Codevervollständigung in Ihren Build-Dateien zu verbessern.
Definieren Sie in der Datei build.gradle.kts jedes Moduls, das die Abhängigkeit erfordert, die Abhängigkeiten mit den Namen, die Sie in der TOML-Datei definiert haben.
Kotlin
dependencies { implementation(libs.androidx.ktx) }
Groovy
dependencies { implementation libs.androidx.ktx }
Plug-ins migrieren
Fügen Sie in der Datei libs.versions.toml sowohl im Abschnitt „versions“ als auch im Abschnitt „plugins“ einen Eintrag für jedes Plug-in hinzu. Synchronisieren Sie Ihr Projekt und ersetzen Sie dann die Deklarationen im plugins{}-Block in den Build-Dateien durch die Katalognamen.
Dieses Code-Snippet zeigt die Datei build.gradle.kts vor dem Entfernen des Plug-ins:
Kotlin
// Top-level `build.gradle.kts` file plugins { id("com.android.application") version "7.4.1" apply false } // Module-level `build.gradle.kts` file plugins { id("com.android.application") }
Groovy
// Top-level `build.gradle` file plugins { id 'com.android.application' version '7.4.1' apply false } // Module-level `build.gradle` file plugins { id 'com.android.application' }
In diesem Code-Snippet wird gezeigt, wie das Plug-in in der Versionskatalogdatei definiert wird:
[versions]
androidGradlePlugin = "7.4.1"
[plugins]
android-application = { id = "com.android.application", version.ref = "androidGradlePlugin" }
Wie bei Abhängigkeiten wird für plugins-Blockkatalogeinträge die Formatierung mit Bindestrichen (z. B. android-application) empfohlen, um die Codevervollständigung in Ihren Build-Dateien zu verbessern.
Der folgende Code zeigt, wie das com.android.application-Plug-in in den build.gradle.kts-Dateien auf oberster Ebene und auf Modulebene definiert wird. Verwenden Sie alias für Plug-ins, die aus der Versionskatalogdatei stammen, und id für Plug-ins, die nicht aus der Versionskatalogdatei stammen, z. B. Konventions-Plug-ins.
Kotlin
// Top-level build.gradle.kts plugins { alias(libs.plugins.android.application) apply false } // module build.gradle.kts plugins { alias(libs.plugins.android.application) }
Groovy
// Top-level build.gradle plugins { alias libs.plugins.android.application apply false } // module build.gradle plugins { alias libs.plugins.android.application }
Weitere Informationen
Weitere Informationen zu zusätzlichen Optionen für die Konfiguration Ihres Versionskatalogs finden Sie in den folgenden Ressourcen:
- Das TOML-Dateiformat für den Versionskatalog dokumentiert zusätzliche Optionen zum Konfigurieren Ihrer Katalogdatei.
- Now in Android ist unsere Beispiel-App, die Versionskataloge verwendet.