Migracja kompilacji do katalogów wersji

Katalogi wersji Gradle umożliwiają dodawanie i utrzymywanie zależności oraz wtyczek w skalowalny sposób. Korzystanie z katalogów wersji Gradle ułatwia zarządzanie zależnościami i wtyczkami, gdy masz wiele modułów. Zamiast kodować na stałe nazwy i wersje zależności w poszczególnych plikach kompilacji i aktualizować każdy wpis, gdy trzeba uaktualnić zależność, możesz utworzyć centralny katalog wersji zależności, do którego różne moduły mogą odwoływać się w sposób bezpieczny dla typu, korzystając z pomocy Android Studio.

Na tej stronie znajdziesz podstawowe informacje o migracji aplikacji na Androida do katalogów wersji. Więcej informacji znajdziesz w artykule Dodawanie zależności kompilacji i w dokumentacji Gradle.

Tworzenie pliku katalogu wersji

Zacznij od utworzenia pliku katalogu wersji. W folderze gradle projektu głównego utwórz plik o nazwie libs.versions.toml. Gradle domyślnie szuka katalogu w pliku libs.versions.toml, dlatego zalecamy użycie tej domyślnej nazwy.

W pliku libs.versions.toml dodaj te sekcje:

[versions]

[libraries]

[plugins]

Sekcje są używane w ten sposób:

  • W bloku versions zdefiniuj zmienne, które przechowują wersje zależności i wtyczek. Użyjesz tych zmiennych w kolejnych blokach (libraries i plugins).
  • W bloku libraries zdefiniuj zależności.
  • W bloku plugins zdefiniuj wtyczki.

Kroki migracji

Zalecamy wykonanie tych czynności w podanej kolejności. Kompilacja może jednocześnie wykorzystywać zależności i wtyczki ze skryptów kompilacji i katalogów, więc możesz poświęcić czas na migrację poszczególnych zależności i wtyczek.

Proces migracji:

  1. Dodaj nowy wpis do katalogu.
  2. Zsynchronizuj projekt aplikacji na Androida.
  3. Zastąp poprzednią deklarację ciągu znaków akcesorem zabezpieczeń wpisywania katalogu.

Migracja zależności

Dodaj wpis dla każdej zależności w sekcjach versions i libraries pliku libs.versions.toml. Zsynchronizuj projekt, a następnie zastąp ich deklaracje w plikach kompilacji nazwami katalogów.

Ten fragment kodu pokazuje plik build.gradle.kts przed usunięciem zależności:

Kotlin

dependencies {
    implementation("androidx.core:core-ktx:1.9.0")

}

Dynamiczny

dependencies {
    implementation 'androidx.core:core-ktx:1.9.0'

}

Ten fragment kodu pokazuje, jak zdefiniować zależność w pliku katalogu wersji:

[versions]
ktx = "1.9.0"

[libraries]
androidx-ktx = { group = "androidx.core", name = "core-ktx", version.ref = "ktx" }

Zalecana nazwa bloku zależności w katalogach to dash-case (np. androidx-ktx), ponieważ zapewnia lepszą pomoc w uzupełnianiu kodu w plikach kompilacji.

W pliku build.gradle.kts każdego modułu, który wymaga zależności, zdefiniuj zależności, używając nazw zdefiniowanych w pliku TOML.

Kotlin

dependencies {
   implementation(libs.androidx.ktx)

}

Dynamiczny

dependencies {
   implementation libs.androidx.ktx

}

Migracja wtyczek

Dodaj wpis dla każdej wtyczki w sekcjach wersji i wtyczek w pliku libs.versions.toml. Zsynchronizuj projekt, a następnie zastąp deklaracje w bloku plugins{} w plikach kompilacji nazwami katalogów.

Ten fragment kodu pokazuje plik build.gradle.kts przed usunięciem wtyczki:

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

}

Dynamiczny

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

}

Ten fragment kodu pokazuje, jak zdefiniować wtyczkę w pliku katalogu wersji:

[versions]
androidGradlePlugin = "7.4.1"

[plugins]
android-application = { id = "com.android.application", version.ref = "androidGradlePlugin" }

Podobnie jak w przypadku zależności, zalecanym formatowaniem wpisów w katalogu bloków plugins jest dash-case (np. android-application), co ułatwia uzupełnianie kodu w plikach kompilacji.

Poniższy kod pokazuje, jak zdefiniować wtyczkę com.android.application w plikach build.gradle.kts na poziomie najwyższym i na poziomie modułu. Używaj alias w przypadku wtyczek pochodzących z pliku katalogu wersji i id w przypadku wtyczek, które nie pochodzą z pliku katalogu wersji, takich jak wtyczki konwencji.

Kotlin

// Top-level build.gradle.kts
plugins {
   alias(libs.plugins.android.application) apply false

}

// module build.gradle.kts
plugins {
   alias(libs.plugins.android.application)

}

Dynamiczny

// Top-level build.gradle
plugins {
   alias libs.plugins.android.application apply false

}

// module build.gradle
plugins {
   alias libs.plugins.android.application

}

Więcej informacji

Więcej informacji o dodatkowych opcjach konfigurowania katalogu wersji znajdziesz w tych materiałach: