一文詳解Jetpack Android新一代導航管理Navigation

2023-11-03 18:00:25

前言

不知道小夥伴們是否注意到，用AS建立一個預設的新專案後，MainActivity已經有了很大的不同，最大的區別就是新增加了兩個Fragment，同時我們注意到這兩個Fragment之間跳轉的時候並沒有使用之前FragmentTransaction這種形式，而是使用了NavController和NavHostFragment，這就是新一代導航管理————Navigation。

專案中依賴Navigation：

implementation 'androidx.navigation:navigation-fragment-ktx:2.3.5'
implementation 'androidx.navigation:navigation-ui-ktx:2.3.5'

建立導航檢視

新建一個Android Resource File，型別選擇Navigation即可，輸入名稱後我們就建立了一個導航檢視。

在導航試圖中，我們可以通過新增activity/fragment等標籤手動新增頁面，也支援在Design頁面中通過介面新增，如下：

注意：這樣新增後手動修改一下label。如果我們將Navigation與ToolBar連線，會在標題列這個label。

範例中新增了兩個頁面，新增後程式碼如下：

<?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">
    <fragment
        android:id="@+id/FirstFragment"
        android:name="com.xxx.xxx.FirstFragment"
        android:label="@string/first_fragment_label"
        tools:layout="@layout/fragment_first">
    </fragment>
    <fragment
        android:id="@+id/SecondFragment"
        android:name="com.xxx.xxx.SecondFragment"
        android:label="@string/second_fragment_label"
        tools:layout="@layout/fragment_second">
    </fragment>
</navigation>

除了新增Fragment和Activity，Google還提供了一個預留位置placeholder，新增加完程式碼如下：

<fragment android:id="@+id/placeholder" />

用於暫時佔位以便後面可以替換為Fragment和Activity

新增完頁面後，我們還需要新增頁面之間的導航，可以手動新增action標籤，當然也可以通過拖拽來實現，如下：

這樣我們就新增了一個從FirstFragment導航到SecondFragment的動作，我們再新增一個逆向的動作，最終的程式碼如下：

<?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">
    <fragment
        android:id="@+id/FirstFragment"
        android:name="com.xxx.xxx.FirstFragment"
        android:label="@string/first_fragment_label"
        tools:layout="@layout/fragment_first">
        <action
            android:id="@+id/action_FirstFragment_to_SecondFragment"
            app:destination="@id/SecondFragment" />
    </fragment>
    <fragment
        android:id="@+id/SecondFragment"
        android:name="com.xxx.xxx.SecondFragment"
        android:label="@string/second_fragment_label"
        tools:layout="@layout/fragment_second">
        <action
            android:id="@+id/action_SecondFragment_to_FirstFragment"
            app:destination="@id/FirstFragment" />
    </fragment>
</navigation>

注意預留位置placeholder同樣支援新增導航。

這樣就實現了兩個頁面間的導航，最後還需要為這個navigation設定id和預設頁面startDestination，如下：

<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/FirstFragment">

這樣導航檢視就建立完成了。可以看到Google力圖通過視覺化工具來簡化開發工作，這對我們開發者來說非常有用，可以省去大量編寫同質化程式碼的時間。

新增NavHost

下一步我們需要向Activity中新增導航宿主，導航宿主是一個空頁面，必須實現NavHost介面，我們使用Navigation提供的預設NavHost————NavHostFragment即可。如下：

<fragment
    android:id="@+id/nav_host_fragment_content_main"
    android:name="androidx.navigation.fragment.NavHostFragment"
    android:layout_width="0dp"
    android:layout_height="0dp"
    app:defaultNavHost="true"
    app:layout_constraintBottom_toBottomOf="parent"
    app:layout_constraintLeft_toLeftOf="parent"
    app:layout_constraintRight_toRightOf="parent"
    app:layout_constraintTop_toTopOf="parent"
    app:navGraph="@navigation/nav_graph" />

在Activity的檢視中新增一個fragment標籤，android:name設定為實現類，即NavHostFragment；app:navGraph設定為剛才新建的導航檢視。

注意app:defaultNavHost="true"，設定為true後表示將這個NavHostFragment設定為預設導航宿主，這樣就會攔截系統的返回按鈕事件。同一佈局中如果有多個導航宿主（比如雙視窗）則必須制定一個為預設的導航宿主。

這時候我們執行應用，就可以發現Activity中已經可以展示FirstFragment了。

findNavController

我們重點來看看findNavController()，它是一個擴充套件函數，如下：

fun Fragment.findNavController(): NavController =
        NavHostFragment.findNavController(this)

實際上是NavHostFragment的一個靜態函數findNavController：

@NonNull
public static NavController findNavController(@NonNull Fragment fragment) {
    ...
    View view = fragment.getView();
    if (view != null) {
        return Navigation.findNavController(view);
    }
    // For DialogFragments, look at the dialog's decor view
    Dialog dialog = fragment instanceof DialogFragment
            ? ((DialogFragment) fragment).getDialog()
            : null;
    if (dialog != null && dialog.getWindow() != null) {
        return Navigation.findNavController(dialog.getWindow().getDecorView());
    }
    throw new IllegalStateException("Fragment " + fragment
            + " does not have a NavController set");
}

通過原始碼可以看到最終是執行了Navigation的findNavController函數，它的程式碼如下：

@NonNull
public static NavController findNavController(@NonNull View view) {
    NavController navController = findViewNavController(view);
    ...
    return navController;
}

這裡是通過findViewNavController函數來獲取NavController的，它的程式碼如下：

@Nullable
private static NavController findViewNavController(@NonNull View view) {
    while (view != null) {
        NavController controller = getViewNavController(view);
        if (controller != null) {
            return controller;
        }
        ViewParent parent = view.getParent();
        view = parent instanceof View ? (View) parent : null;
    }
    return null;
}

這裡可以看到通過view來獲取NavController，如果沒有則向上層查詢（父view）直到找到或到根結點。getViewNavController程式碼如下：

@Nullable
private static NavController getViewNavController(@NonNull View view) {
    Object tag = view.getTag(R.id.nav_controller_view_tag);
    NavController controller = null;
    if (tag instanceof WeakReference) {
        controller = ((WeakReference<NavController>) tag).get();
    } else if (tag instanceof NavController) {
        controller = (NavController) tag;
    }
    return controller;
}

看到這裡獲取view中key為R.id.nav_controller_view_tag的tag，這個tag就是NavController，那麼這個tag又從哪來的？

其實就是上面我們提到導航宿主————NavHostFragment，在他的onViewCreated中可以看到如下程式碼：

@Override
public void onViewCreated(@NonNull View view, @Nullable Bundle savedInstanceState) {
    super.onViewCreated(view, savedInstanceState);
    if (!(view instanceof ViewGroup)) {
        throw new IllegalStateException("created host view " + view + " is not a ViewGroup");
    }
    Navigation.setViewNavController(view, mNavController);
    // When added programmatically, we need to set the NavController on the parent - i.e.,
    // the View that has the ID matching this NavHostFragment.
    if (view.getParent() != null) {
        mViewParent = (View) view.getParent();
        if (mViewParent.getId() == getId()) {
            Navigation.setViewNavController(mViewParent, mNavController);
        }
    }
}

這裡的mNavController是在NavHostFragment的onCreate中建立出來的，是一個NavHostController物件，它繼承NavController，所以就是NavController。

可以看到onViewCreated中呼叫了Navigation的setViewNavController函數，它的程式碼如下：

public static void setViewNavController(@NonNull View view,
        @Nullable NavController controller) {
    view.setTag(R.id.nav_controller_view_tag, controller);
}

這樣就將NavController加入tag中了，通過findNavController()就可以得到這個NavController來執行導航了。

注意在onViewCreated中不僅為Fragment的View新增了tag，同時還為其父View也新增了，這樣做的目的是在Activity中也可以獲取到NavController，這點下面就會遇到。

ToolBar

Google提供了Navigation與ToolBar連線的功能，程式碼如下：

val navController = findNavController(R.id.nav_host_fragment_content_main)
appBarConfiguration = AppBarConfiguration(navController.graph)
setupActionBarWithNavController(navController, appBarConfiguration)

上面我們提到，如果Navigation與ToolBar連線，標題列會自動顯示在導航檢視中設定好的label。

注意這裡的findNavController是Activity的擴充套件函數，它最終一樣會呼叫Navigation的對應函數，所以與Fragment的流程是一樣的。而上面我們提到了，在NavHostFragment中給上層View也設定了tag，所以在這裡才能獲取到NavController。

除了這個，我們還可以發現當在切換頁面的時候，標題列的返回按鈕也會自動顯示和隱藏。當導航到第二個頁面SecondFragment，返回按鈕顯示；當回退到首頁時，返回按鈕隱藏。

但是此時返回按鈕點選無效，因為我們還需要重寫一個函數：

override fun onSupportNavigateUp(): Boolean {
    val navController = findNavController(R.id.nav_host_fragment_content_main)
    return navController.navigateUp(appBarConfiguration)
            || super.onSupportNavigateUp()
}

這樣當點選標題列的返回按鈕時，會執行NavController的navigateUp函數，就會退回到上一頁面。

總結

可以看出通過Google推出的這個Navigation，可以讓開發者更加優雅管理導航，同時也簡化了這部分的開發工作，視覺化功能可以讓開發者更直觀的進行管理。除此之外，Google還提供了Safe Args Gradle外掛，該外掛可以生成簡單的物件和構建器類，這些類支援在目的地之間進行型別安全的導航和引數傳遞。關於這個大家可以參考官方檔案developer.android.google.cn/guide/navig… 即可。

以上就是一文詳解Jetpack Android新一代導航管理Navigation的詳細內容，更多關於Jetpack Android導航管理Navigation的資料請關注it145.com其它相關文章！

一文詳解Jetpack Android新一代導航管理Navigation

目錄

前言

建立導航檢視

新增NavHost

導航

findNavController

ToolBar

總結

熱門文章