Zalecanym sposobem przechodzenia między miejscami docelowymi jest użycie wtyczki Safe Args do Gradle. Ta wtyczka generuje klasy obiektów i konstruktorów, które umożliwiają bezpieczną nawigację między miejscami docelowymi. Używaj Safe Args do nawigacji i przekazywania danych między miejscami docelowymi.
Włączanie Safe Args
Aby dodać do projektu Safe Args, w pliku najwyższego poziomu build.gradle umieść ten kod:classpath
Groovy
buildscript { repositories { google() } dependencies { def nav_version = "2.10.2" classpath "androidx.navigation:navigation-safe-args-gradle-plugin:$nav_version" } }
Kotlin
buildscript { repositories { google() } dependencies { val nav_version = "2.10.2" classpath("androidx.navigation:navigation-safe-args-gradle-plugin:$nav_version") } }
Musisz też zastosować jedną z 2 dostępnych wtyczek.
Aby wygenerować kod w języku Java odpowiedni dla modułów Java lub mieszanych modułów Java i Kotlin, dodaj ten wiersz do pliku build.gradle aplikacji lub modułu:
Groovy
plugins { id 'androidx.navigation.safeargs' }
Kotlin
plugins { id("androidx.navigation.safeargs") }
Aby wygenerować kod w języku Kotlin odpowiedni dla modułów tylko w tym języku, dodaj:
Groovy
plugins { id 'androidx.navigation.safeargs.kotlin' }
Kotlin
plugins { id("androidx.navigation.safeargs.kotlin") }
W pliku gradle.properties musisz mieć android.useAndroidX=true zgodnie z informacjami w artykule Migracja do AndroidaX.
Wygenerowany kod
Po włączeniu Safe Args wygenerowany kod zawiera klasy i metody dla każdego zdefiniowanego działania, a także klasy odpowiadające każdemu miejscu docelowemu wysyłania i odbierania.
Safe Args generuje klasę dla każdego miejsca docelowego, w którym rozpoczyna się działanie. Wygenerowana nazwa klasy dodaje „Directions” do nazwy klasy miejsca docelowego. Jeśli na przykład miejsce docelowe, z którego pochodzi, ma nazwę SpecifyAmountFragment, wygenerowana klasa będzie miała nazwę SpecifyAmountFragmentDirections.
Wygenerowana klasa zawiera metodę statyczną dla każdego działania zdefiniowanego w miejscu docelowym. Ta metoda przyjmuje jako argumenty wszystkie zdefiniowane parametry działania i zwraca obiekt NavDirections, który można przekazać bezpośrednio do navigate().
Przykład Safe Args
Weźmy na przykład wykres nawigacyjny z jednym działaniem, które łączy 2 miejsca docelowe: SpecifyAmountFragment i ConfirmationFragment. ConfirmationFragment przyjmuje pojedynczy parametr float, który podajesz w ramach działania.
Safe Args generuje klasę SpecifyAmountFragmentDirections z jedną metodą actionSpecifyAmountFragmentToConfirmationFragment() i klasą wewnętrzną o nazwie ActionSpecifyAmountFragmentToConfirmationFragment. Klasa wewnętrzna pochodzi z NavDirections i przechowuje powiązany identyfikator działania oraz parametr float. Zwrócony obiekt NavDirections można następnie przekazać bezpośrednio do navigate(), jak w tym przykładzie:
Kotlin
override fun onClick(v: View) {
val amount: Float = ...
val action =
SpecifyAmountFragmentDirections
.actionSpecifyAmountFragmentToConfirmationFragment(amount)
v.findNavController().navigate(action)
}
Java
@Override
public void onClick(View view) {
float amount = ...;
action =
SpecifyAmountFragmentDirections
.actionSpecifyAmountFragmentToConfirmationFragment(amount);
Navigation.findNavController(view).navigate(action);
}
Więcej informacji o przekazywaniu danych między miejscami docelowymi za pomocą Safe Args znajdziesz w artykule Używanie Safe Args do przekazywania danych z zabezpieczeniami wpisywania.
Zapewnianie zabezpieczeń wpisywania za pomocą Safe Args
poruszać się między miejscami docelowymi za pomocą wtyczki Safe Args do Gradle. Ta wtyczka generuje proste klasy obiektów i kreatorów, które umożliwiają bezpieczną nawigację i przekazywanie argumentów między miejscami docelowymi.
Aby dodać do projektu Safe Args, w pliku najwyższego poziomu build.gradle umieść ten kod:classpath
Groovy
buildscript { repositories { google() } dependencies { def nav_version = "2.10.2" classpath "androidx.navigation:navigation-safe-args-gradle-plugin:$nav_version" } }
Kotlin
buildscript { repositories { google() } dependencies { val nav_version = "2.10.2" classpath("androidx.navigation:navigation-safe-args-gradle-plugin:$nav_version") } }
Musisz też zastosować jedną z 2 dostępnych wtyczek.
Aby wygenerować kod w języku Java odpowiedni dla modułów Java lub mieszanych modułów Java i Kotlin, dodaj ten wiersz do pliku build.gradle aplikacji lub modułu:
Groovy
plugins { id 'androidx.navigation.safeargs' }
Kotlin
plugins { id("androidx.navigation.safeargs") }
Aby wygenerować kod w języku Kotlin odpowiedni dla modułów tylko w tym języku, dodaj:
Groovy
plugins { id 'androidx.navigation.safeargs.kotlin' }
Kotlin
plugins { id("androidx.navigation.safeargs.kotlin") }
W pliku gradle.properties musisz mieć android.useAndroidX=true zgodnie z informacjami w artykule Migracja do AndroidaX.
Po włączeniu Safe Args wtyczka generuje kod zawierający klasy i metody dla każdego zdefiniowanego działania. W przypadku każdego działania Safe Args generuje też klasę dla każdego miejsca docelowego, z którego pochodzi działanie. Wygenerowana nazwa klasy jest połączeniem nazwy klasy miejsca docelowego i słowa „Directions”. Jeśli na przykład miejsce docelowe ma nazwę SpecifyAmountFragment, wygenerowana klasa będzie miała nazwę SpecifyAmountFragmentDirections. Wygenerowana klasa zawiera statyczną metodę dla każdego działania zdefiniowanego w miejscu docelowym. Ta metoda przyjmuje jako argumenty dowolne zdefiniowane parametry działania i zwraca obiekt NavDirections, który można przekazać do navigate().
Załóżmy na przykład, że mamy wykres nawigacyjny z jednym działaniem, które łączy miejsce docelowe, z którego pochodzi, SpecifyAmountFragment, z miejscem docelowym, do którego jest kierowane, ConfirmationFragment.
Safe Args generuje klasę SpecifyAmountFragmentDirections z jedną metodą actionSpecifyAmountFragmentToConfirmationFragment(), która zwraca obiekt NavDirections. Zwrócony obiekt NavDirections można następnie przekazać bezpośrednio do navigate(), jak w tym przykładzie:
Kotlin
override fun onClick(view: View) {
val action =
SpecifyAmountFragmentDirections
.actionSpecifyAmountFragmentToConfirmationFragment()
view.findNavController().navigate(action)
}
Java
@Override
public void onClick(View view) {
NavDirections action =
SpecifyAmountFragmentDirections
.actionSpecifyAmountFragmentToConfirmationFragment();
Navigation.findNavController(view).navigate(action);
}
Więcej informacji o przekazywaniu danych między miejscami docelowymi za pomocą Safe Args znajdziesz w sekcji Używanie Safe Args do przekazywania danych z zabezpieczeniami wpisywania w artykule Przekazywanie danych między miejscami docelowymi.