Nawigacja po projektach z wieloma modułami

Wykres nawigacyjny może składać się z dowolnej kombinacji tych elementów:

  • Pojedyncze miejsce docelowe, np. miejsce docelowe <fragment>.
  • Zagnieżdżony graf, który zawiera zestaw powiązanych miejsc docelowych.
  • Element <include>, który umożliwia umieszczenie innego pliku wykresu nawigacji tak, jakby był zagnieżdżony.

Ta elastyczność pozwala łączyć mniejsze wykresy nawigacyjne w kompletny wykres nawigacyjny aplikacji, nawet jeśli te mniejsze wykresy są dostarczane przez osobne moduły.

W przykładach w tym temacie każdy moduł funkcji koncentruje się wokół jednej funkcji i zawiera pojedynczy wykres nawigacyjny, który obejmuje wszystkie miejsca docelowe potrzebne do zaimplementowania tej funkcji. W aplikacji produkcyjnej możesz mieć wiele podmodułów na niższym poziomie, które są szczegółami implementacji tego modułu funkcji wyższego poziomu. Każdy z tych modułów funkcji jest bezpośrednio lub pośrednio uwzględniony w module app. Przykładowa aplikacja wielomodułowa używana w tym dokumencie ma taką strukturę:

wykres zależności dla przykładowej aplikacji wielomodułowej
miejsce docelowe uruchomienia przykładowej aplikacji,
Rysunek 1. Architektura aplikacji i miejsce docelowe uruchomienia przykładowej aplikacji.

Każdy moduł funkcji jest samodzielną jednostką z własnym wykresem nawigacji i miejscami docelowymi. Moduł app zależy od każdego z nich i dodaje je jako szczegóły implementacji w pliku build.gradle, jak pokazano poniżej:

Dynamiczny

dependencies {
    ...
    implementation project(":feature:home")
    implementation project(":feature:favorites")
    implementation project(":feature:settings")

Kotlin

dependencies {
    ...
    implementation(project(":feature:home"))
    implementation(project(":feature:favorites"))
    implementation(project(":feature:settings"))

Rola modułu app

Moduł app odpowiada za dostarczanie pełnego wykresu aplikacji i dodawanie elementu NavHost do interfejsu. W grafie nawigacji modułu app możesz odwoływać się do grafów biblioteki za pomocą <include>. Chociaż użycie <include> jest funkcjonalnie takie samo jak użycie wykresu zagnieżdżonego, <include> obsługuje wykresy z innych modułów projektu lub z projektów bibliotecznych, jak w tym przykładzie:

<?xml version="1.0" encoding="utf-8"?>
<navigation xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    xmlns:tools="http://schemas.android.com/tools"
    android:id="@+id/nav_graph"
    app:startDestination="@id/home_nav_graph">

    <include app:graph="@navigation/home_navigation" />
    <include app:graph="@navigation/favorites_navigation" />
    <include app:graph="@navigation/settings_navigation" />
</navigation>

Gdy biblioteka zostanie uwzględniona w grafie nawigacji najwyższego poziomu, możesz w razie potrzeby przechodzić do grafów biblioteki. Możesz na przykład utworzyć działanie, które spowoduje przejście do wykresu ustawień z fragmentu wykresu nawigacji, jak pokazano poniżej:

<?xml version="1.0" encoding="utf-8"?>
<navigation xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    xmlns:tools="http://schemas.android.com/tools"
    android:id="@+id/nav_graph"
    app:startDestination="@id/home_nav_graph">

    <include app:graph="@navigation/home_navigation" />
    <include app:graph="@navigation/favorites_navigation" />
    <include app:graph="@navigation/settings_navigation" />

    <fragment
        android:id="@+id/random_fragment"
        android:name="com.example.android.RandomFragment"
        android:label="@string/fragment_random" >
        <!-- Launch into Settings Navigation Graph -->
        <action
            android:id="@+id/action_random_fragment_to_settings_nav_graph"
            app:destination="@id/settings_nav_graph" />
    </fragment>
</navigation>

Jeśli kilka modułów funkcji musi odwoływać się do wspólnego zestawu miejsc docelowych, np. wykresu logowania, nie należy uwzględniać tych wspólnych miejsc docelowych w wykresie nawigacji każdego modułu funkcji. Zamiast tego dodaj te typowe miejsca docelowe do wykresu nawigacji modułu app. Każdy moduł funkcji może następnie przechodzić między modułami funkcji, aby przechodzić do tych wspólnych miejsc docelowych.

W poprzednim przykładzie działanie określa miejsce docelowe nawigacji jako @id/settings_nav_graph. Ten identyfikator odnosi się do miejsca docelowego zdefiniowanego w dołączonym wykresie @navigation/settings_navigation.

Nawigacja najwyższego poziomu w module aplikacji

Komponent nawigacji zawiera klasę NavigationUI. Ta klasa zawiera metody statyczne, które zarządzają nawigacją za pomocą górnego paska aplikacji, panelu nawigacji i dolnego paska nawigacyjnego. Jeśli miejsca docelowe najwyższego poziomu w aplikacji składają się z elementów interfejsu dostarczanych przez moduły funkcji, moduł app jest naturalnym miejscem na umieszczenie nawigacji najwyższego poziomu i elementów interfejsu. Moduł aplikacji zależy od współpracujących modułów funkcji, dlatego wszystkie ich miejsca docelowe są dostępne z poziomu kodu zdefiniowanego w module aplikacji. Oznacza to, że możesz używać NavigationUI, aby powiązać miejsca docelowe z pozycjami menu, jeśli identyfikator pozycji jest zgodny z identyfikatorem miejsca docelowego.

Na rysunku 2 przykładowy moduł app definiuje BottomNavigationView w swojej głównej aktywności. Identyfikatory elementów menu w menu są zgodne z identyfikatorami wykresów nawigacyjnych wykresów biblioteki:

<?xml version="1.0" encoding="utf-8"?>
<menu xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto">

    <item
        android:id="@id/home_nav_graph"
        android:icon="@drawable/ic_home"
        android:title="Home"
        app:showAsAction="ifRoom"/>

    <item
        android:id="@id/favorites_nav_graph"
        android:icon="@drawable/ic_favorite"
        android:title="Favorites"
        app:showAsAction="ifRoom"/>

    <item
        android:id="@id/settings_nav_graph"
        android:icon="@drawable/ic_settings"
        android:title="Settings"
        app:showAsAction="ifRoom" />
</menu>

Aby umożliwić NavigationUI obsługę dolnego paska nawigacyjnego, wywołaj setupWithNavController z onCreate w klasie głównej aktywności, jak w tym przykładzie:

Kotlin

override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    setContentView(R.layout.activity_main)
    val navHostFragment =
        supportFragmentManager.findFragmentById(R.id.nav_host_fragment) as NavHostFragment
    val navController = navHostFragment.navController

    findViewById<BottomNavigationView>(R.id.bottom_nav)
            .setupWithNavController(navController)
}

Java

@Override
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);
    NavHostFragment navHostFragment =
            (NavHostFragment) supportFragmentManager.findFragmentById(R.id.nav_host_fragment);
    NavController navController = navHostFragment.getNavController();
    BottomNavigationView bottomNav = findViewById(R.id.bottom_nav);

    NavigationUI.setupWithNavController(bottomNav, navController);
}

Dzięki temu kodowi NavigationUI przechodzi do odpowiedniego grafu biblioteki, gdy użytkownik kliknie element dolnego paska nawigacyjnego.

Pamiętaj, że ogólnie nie zaleca się, aby moduł aplikacji był ściśle zależny od konkretnego miejsca docelowego umieszczonego głęboko w grafie nawigacyjnym modułów funkcji. W większości przypadków moduł aplikacji powinien wiedzieć tylko o punkcie wejścia do osadzonych lub dołączonych wykresów nawigacyjnych (dotyczy to również modułów funkcji). Jeśli chcesz utworzyć link do miejsca docelowego głęboko w wykresie nawigacji biblioteki, najlepiej użyć precyzyjnego linku. Precyzyjne linki to też jedyny sposób, aby biblioteka mogła przejść do miejsca docelowego na wykresie nawigacyjnym innej biblioteki.

Poruszanie się po modułach funkcji

W czasie kompilowania niezależne moduły funkcji nie widzą się nawzajem, więc nie możesz używać identyfikatorów do przechodzenia do miejsc docelowych w innych modułach. Zamiast tego użyj precyzyjnego linku, aby przejść bezpośrednio do miejsca docelowego powiązanego z precyzyjnym linkiem typu implicit.

Kontynuując poprzedni przykład, wyobraź sobie, że musisz przejść od przycisku w module :feature:home do miejsca docelowego zagnieżdżonego w module :feature:settings. Możesz to zrobić, dodając precyzyjny link do miejsca docelowego w grafie nawigacji ustawień, jak pokazano poniżej:

<?xml version="1.0" encoding="utf-8"?>
<navigation xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    xmlns:tools="http://schemas.android.com/tools"
    android:id="@+id/settings_nav_graph"
    app:startDestination="@id/settings_fragment_one">

    ...

    <fragment
        android:id="@+id/settings_fragment_two"
        android:name="com.example.google.login.SettingsFragmentTwo"
        android:label="@string/settings_fragment_two" >

        <deepLink
            app:uri="android-app://example.google.app/settings_fragment_two" />
    </fragment>
</navigation>

Następnie dodaj ten kod do metody onClickListener przycisku we fragmencie strony głównej:

Kotlin

button.setOnClickListener {
    val request = NavDeepLinkRequest.Builder
        .fromUri("android-app://example.google.app/settings_fragment_two".toUri())
        .build()
    findNavController().navigate(request)
}

Java

button.setOnClickListener(new View.OnClickListener() {
    @Override
    public void onClick(View view) {
        NavDeepLinkRequest request = NavDeepLinkRequest.Builder
            .fromUri(Uri.parse("android-app://example.google.app/settings_fragment_two"))
            .build();
        NavHostFragment.findNavController(this).navigate(request);
    }
});

W przeciwieństwie do nawigacji za pomocą identyfikatorów działań lub miejsc docelowych możesz przejść do dowolnego identyfikatora URI na dowolnym wykresie, nawet w różnych modułach.

Podczas nawigacji za pomocą identyfikatora URI stos wsteczny nie jest resetowany. To zachowanie różni się od nawigacji za pomocą precyzyjnych linków typu explicit, w przypadku której stos wsteczny jest zastępowany podczas nawigacji.