Jetpack Compose學習(11)——Navigation頁面導航的使用

来源:https://www.cnblogs.com/stars-one/archive/2023/02/25/17154864.html
-Advertisement-
Play Games

原文:Jetpack Compose學習(11)——Navigation頁面導航的使用 - Stars-One的雜貨小窩 在Android原生的View開發中的,也是有Navigation,原生我之後可能再出篇教程,今天講解的則是compose版本的Navigation組件的使用 本系列以往文章請查 ...


原文:Jetpack Compose學習(11)——Navigation頁面導航的使用 - Stars-One的雜貨小窩

在Android原生的View開發中的,也是有Navigation,原生我之後可能再出篇教程,今天講解的則是compose版本的Navigation組件的使用

本系列以往文章請查看此分類鏈接Jetpack compose學習

說明

在原生中,官方比較推薦使用單Activity+多Fragment模式來構建一個APP,而Fragment的切換需要使用FragmentManager來進行管理,比如add replace等方法,對於開發者來說,也是比較繁瑣,於是官方在Jetpack組件中就是推出了Navigation的庫,可以方便開發者快速去管理多Fragment的頁面堆棧問題

而今天的主要針對compose,compose的架構也是一個Activity+多個可組合項,而如何去切換可組合項?

以往的做法就是定義一個選中下標,下標更改了,重新渲染一下頁面,從而達到切換頁面的效果

而有了Navigation,則是可以在使用層面更為優雅和規範,也是方便管理,不易出現奇奇怪怪的堆棧問題等

基本使用

這裡我們以一個使用了NavigationBar組件的頁面進行改造

PS:這裡我是新版本的AS創建的項目,預設使用的是Material3的依賴包,所以底部導航欄組件就是NavigationBar,如果是Material2的依賴包,則是叫BottomNavigation

效果如下圖所示:

就是實現了兩個底部菜單,然後可以進行頁面的切換,代碼如下所示:

@OptIn(ExperimentalMaterial3Api::class)
@Preview(showBackground = true)
@Composable
fun MyApp() {
    
    var currentSelect by remember {
        mutableStateOf(0)
    }

    val menuData = listOf(
        BottomItemData("首頁", Icons.Filled.Home),
        BottomItemData("設置", Icons.Filled.Settings)
    )

    Scaffold(modifier = Modifier.fillMaxSize()
    , bottomBar = {
        NavigationBar() {
            menuData.forEachIndexed { index, bottomItemData ->
                NavigationBarItem(
                    selected = index == currentSelect,
                    onClick = {
                        currentSelect = index
                    },
                    icon = {
                        Icon(
                            imageVector = bottomItemData.icon,
                            contentDescription = "點擊按鈕"
                        )
                    },
                    label = {
                        Text(
                            text = (bottomItemData.label)
                        )
                    },
                )
            }
        }
    }
    ) { innerPadding ->
        //下麵第3步就是對此部分代碼進行更改
        
        //IDE強制要使用者innerPadding,這裡就簡單的列印一下
        println(innerPadding)
        if (currentSelect == 0) {
            Text("首頁")
        }else{
            Text("設置")
        }

    }
}

從上面代碼中,我們可以看到我們是通過currentSelect這個變數來進行頁面的顯示管理,實際上這裡管理會比較繁瑣,這個時候就得用到今天的主角Navigation了

1.引入依賴

implementation "androidx.navigation:navigation-compose:2.5.3"

2.聲明NavController

首先,就是使用rememberNavController獲得NavController對象

//導航
val navController = rememberNavController()

PS: 之後的跳轉和返回上一級就是使用此對象過來就行

3.使用NavHost,聲明頁面路由

在佈局content參數的函數里使用下麵這段代碼:

NavHost(navController = navController, startDestination = "MainPage") {
    //聲明名為MainPage的頁面路由
    composable("MainPage"){
        //頁面路由對應的頁面組件
        MainPage()
    }
    composable("SettingPage"){
        SettingPage()
    }
}

上面是聲明瞭兩個頁面,MainPage和SettingPage則是它兩的路由名,後面頁面跳轉需要使用到

NavHost方法中,參數需要上一步的NavController對象,startDestination則是開始的頁面為MainPage

簡單的解釋,就是可以把NavHost也看出一個頁面組件,這個組件預設顯示的是MainPage頁面

源碼如下,點擊展開 
@OptIn(ExperimentalMaterial3Api::class)
@Preview(showBackground = true)
@Composable
fun MyApp() {
    var currentSelect by remember {
        mutableStateOf(0)
    }

    //導航
    val navController = rememberNavController()

    val menuData = listOf(
        BottomItemData("首頁", Icons.Filled.Home),
        BottomItemData("設置", Icons.Filled.Settings)
    )

    Scaffold(modifier = Modifier.fillMaxSize()
    , bottomBar = {
        NavigationBar() {
            menuData.forEachIndexed { index, bottomItemData ->
                NavigationBarItem(
                    selected = index == currentSelect,
                    onClick = {
                        currentSelect = index
                    },
                    icon = {
                        Icon(
                            imageVector = bottomItemData.icon,
                            contentDescription = "點擊按鈕"
                        )
                    },
                    label = {
                        Text(
                            text = (bottomItemData.label)
                        )
                    },
                )
            }
        }
    }
    ) { innerPadding ->
        //IDE強制要使用者innerPadding,這裡就簡單的列印一下
        println(innerPadding)

        NavHost(navController = navController, startDestination = "MainPage") {
            composable("MainPage"){
                MainPage()
            }
            composable("SettingPage"){
                SettingPage()
            }
        }

    }
}

@Preview(showBackground = true)
@Composable
fun MainPage(){
    Column() {
        Text(text = "主頁")
    }
}

@Preview(showBackground = true)
@Composable
fun SettingPage() {
    Column(
        modifier = Modifier.fillMaxSize(),
        verticalArrangement = Arrangement.Center,
        horizontalAlignment = Alignment.CenterHorizontally
    ) {
        Text(text = "設置頁面")
    }
}

3.頁面跳轉

下麵則是兩個重要的方法:

  • navController.navigate() 頁面跳轉
  • navController.popBackStack() 回上一級,相當於點擊返回鍵

這裡,我們結合NavigationBar實現點擊底部按鈕切換不同的頁面

實現效果如下圖所示:

代碼如下圖所示

PS:這裡需要註意,如果使用了navController.navigate()來進行頁面跳轉,實際上就是和打開一個新的Activity類似,存在一個頁面堆棧

比如說上圖的效果,如果點返回鍵,則是回到上次的頁面,而不會立即退出APP

而且，每次調用navigate()會創建一個新的頁面對象

如果需要單一創建一個對象,可以這樣寫

navController.navigate("MainPage"){
    launchSingleTop = true
}

之後不過怎麼跳轉,都會用的同一個頁面對象

不過一般我們會是在頁面之間跳轉的,比如說要再MainPage頁面跳轉到SettingPage頁面,要怎麼寫呢?

向MainPage傳遞NavController的參數,之後頁面中的按鈕來可以使用此對象來完成頁面跳轉的功能

不過官方比較推薦我們傳遞一個函數參數,如下代碼所示:

//方法需要傳函數參數
@Composable
fun MainPage(toSettingPage:()->Unit) {
    Column() {
        Text(text = "主頁")
        Button(onClick = { toSettingPage.invoke() }) {
            Text("跳轉到設置頁面")
        }
    }
}

NavHost(navController = navController, startDestination = "MainPage") {
    composable("MainPage"){
        //這裡也要同步修改
        //下麵的是kotlin中的lambda的簡化寫法,不明白的可以先去瞭解下
        MainPage(){
            navController.navigate("SettingPage")
        }
    }
    composable("SettingPage"){
        SettingPage()
    }
}

如何傳參

上面的基本使用,例子也是比較簡單

一般情況下,我們可能跳轉到新頁面的時候需要傳遞數據,比如說從列表頁到詳情頁,需要傳遞點擊的item項的id,從而詳情頁可以拿到id去請求介面從而獲得詳情的數據並展示,這個時候該如何操作呢?

針對上面的代碼,我們假設進入Setting頁面,需要傳遞一個字元串的參數名為id,則有下麵的步驟:

1.修改NavHost定義路由

NavHost(navController = navController, startDestination = "MainPage") {
    composable("MainPage"){
        MainPage(){
            navController.navigate("SettingPage")
        }
    }
    composable("SettingPage/{id}"){
        //這裡獲取傳參過來數據
        val id = it.arguments?.getString("id")
        //可以傳入SettingPage中,然後在頁面中使用數據,這裡我就沒寫了
        SettingPage()
    }
}

這裡上面,可以看到加了個{id}(有點類似Spring Boot里的介面寫法),就是標明需要傳參的意思

這裡實際上還可以聲明類型,預設不寫的話,就是說id是String類型的

arguments這個變數實際上就是我們Intent中常用的Bundle,所以獲取數值的是調用了getString()方法

設置參數的類型

如果想要id是整數的話,應該怎麼做呢?

如下麵代碼所示:

composable("SettingPage/{id}", arguments = listOf(navArgument("id") {
    type = NavType.IntType
})) {
  //省略....
}

通過arguments參數來設置傳參對應配置,接收的是一個列表,也很好理解,因為會有多個參數嘛

而list里的元素的類型,則是NamedNavArgument,官方提供navArgument()方法方便我們快速構造NamedNavArgument類型

我們可以看看navArgument方法的參數

navArgument(
    name: String,
    builder: NavArgumentBuilder.() -> Unit
)

name則是需要與我們路由上定義的參數名一致,而builder則是一個函數,我們可以寫個函數來快速進行參數的配置,主要可以設置以下三個屬性:

  • type 類型
  • defaultValue 預設值
  • nullable 是否可空

PS:改了參數類型,對應的取值調用的getXX等方法也要修改哦!

可選參數

上面的例子,實際上是必傳的一個參數,如果需要可選參數,有以下規則:

  1. 可選參數必須使用查詢參數語法?argName={argName} 來添加
  2. 可選參數必須具有 defaultValue 或 nullable = true (將預設值設置為 null)

第二點就是上面提到過的兩個屬性,例如我們加多一個age的可選參數:

composable("SettingPage/{id}?age={age}", arguments = listOf(
    navArgument("id") {
        type = NavType.IntType
    }, navArgument("age") {
        type = NavType.IntType
        defaultValue = 0
    }
)) {
    //省略...
}

2.調用傳參

上面說了那麼多,那麼應該如何去調用呢?

NavHost(navController = navController, startDestination = "MainPage") {
    composable("MainPage") {
        MainPage() {
            //跳轉的時候傳參
            navController.navigate("SettingPage/11?age=18")
        }
    }

    composable("SettingPage/{id}?age={age}", arguments = listOf(
        navArgument("id") {
            type = NavType.IntType
            defaultValue = 0
            nullable = true
        }, navArgument("age") {
            type = NavType.IntType
            defaultValue = 0
        }
    )) {
        //這裡獲取傳參過來數據
        val id = it.arguments?.getInt("id")
        Log.d("starsone", "MyApp: $id")
        SettingPage()
    }
}

由於上面,我們是將跳轉封裝在了函數,所以只需要調整MainPage路由里的函數即可navController.navigate("SettingPage/11?age=18")

當然,這裡age是可以不傳的,預設則是0

關於寫法優化

在上面的例子的,我們涉及到的頁面也是比較少,但是,在APP更新迭代之後,頁面可以會成倍地增加

這個時候我們如果還是每個路由直接寫死的一個字元串變數,那麼萬一哪天不小心改了,就會導致路由無法跳轉了,針對這個問題,解決思路也比較簡單,使用枚舉或者常量來管理路由名就可

object Pages{
    const val MainPage = "mainPage"
    const val SettingPage = "settingPage"
}

NavHost(navController = navController, startDestination = Pages.MainPage) {
    composable(Pages.MainPage) {
        MainPage() {
            navController.navigate("${Pages.SettingPage}/11")
        }
    }

    composable("${Pages.SettingPage}/{id}?age={age}", arguments = listOf(
        navArgument("id") {
            type = NavType.IntType
            defaultValue = 0
            nullable = true
        }, navArgument("age") {
            type = NavType.IntType
            defaultValue = 0
        }
    )) {
        //這裡獲取傳參過來數據
        val id = it.arguments?.getString("id")
        Log.d("starsone", "MyApp: $id")
        SettingPage()
    }
}

除此之外,如果NavHost里的composable多了起來,也不好方便管理是吧,我們可以按照業務邏輯來進行一個嵌套導航(嵌套導航結構)

在NavHost里使用navigation()來實現嵌套導航結構:

NavHost(navController, startDestination = "home") {
    ...
    // 當導航到 login 路由時，自動找到 username 目標進行顯示
    navigation(startDestination = "username", route = "login") {
        composable("username") { ... }
        composable("password") { ... }
        composable("registration") { ... }
    }
    ...
}

為了更好的復用,我們還可以將其抽取成一個方法(這裡官方就是使用了擴展方法):

fun NavGraphBuilder.loginGraph(navController: NavController) {
    navigation(startDestination = "username", route = "login") {
        composable("username") { ... }
        composable("password") { ... }
        composable("registration") { ... }
    }
}

NavHost(navController, startDestination = "home") {
    ...
    // 當導航到 login 路由時，自動找到 username 目標進行顯示
    loginGraph()
    ...
}

與底部導航欄聯用

這裡以官方給出的示例,貼下代碼並講解

使用到了navController.currentBackStackEntryAsState()和navBackStackEntry?.destination

您可以利用 NavController.currentBackStackEntryAsState() 方法從 NavHost 函數中獲取 navController 狀態，並與 BottomNavigation 組件共用此狀態。這意味著 BottomNavigation 會自動擁有最新狀態。

不過官方使用的是密封類里構造底部菜單數據,我這裡則是使用了list直接構造,也差不了太多

可以看到只要在首頁的話,再次點擊即可退出APP,不會出現多餘的頁面堆棧的情況,動圖如下:

@Composable
fun MyApp() {
    var currentSelect by remember {
        mutableStateOf(0)
    }

    //導航
    val navController = rememberNavController()

    val menuData = listOf(
        BottomItemData(Pages.PAGE_MAIN,"首頁", Icons.Filled.Home),
        BottomItemData(Pages.PAGE_SETTING,"設置", Icons.Filled.Settings)
    )

    Scaffold(modifier = Modifier.fillMaxSize()
    , bottomBar = {
        NavigationBar() {
            val navBackStackEntry by navController.currentBackStackEntryAsState()
            val currentDestination = navBackStackEntry?.destination

            menuData.forEach { bottomItemData ->
                NavigationBarItem(
                    //設置當前項是否為選中
                    selected = currentDestination?.hierarchy?.any { it.route == bottomItemData.route } == true,
                    icon = {
                        Icon(
                            imageVector = bottomItemData.icon,
                            contentDescription = "點擊按鈕"
                        )
                    },
                    label = {
                        Text(
                            text = (bottomItemData.label)
                        )
                    },
                    onClick = {
                        navController.navigate(bottomItemData.route) {
                            //使用此方法,可以避免生成一個重覆的路由堆棧
                            popUpTo(navController.graph.findStartDestination().id) {
                                saveState = true
                            }
                            //避免重覆選擇會創建一個新的頁面副本
                            launchSingleTop = true
                            // Restore state when reselecting a previously selected item
                            //當重新選擇之前已選擇項目恢復頁面狀態
                            restoreState = true
                        }
                    },

                )
            }
        }
    }
    ) { innerPadding ->

        println(innerPadding)
        NavHost(navController = navController, startDestination = Pages.PAGE_MAIN) {
            composable(Pages.PAGE_MAIN) {
                MainPage()
            }
            composable(Pages.PAGE_SETTING) {
                SettingPage()
            }

        }
    }
}

//頁面的枚舉類
object Pages{
    const val PAGE_MAIN = "main"
    const val PAGE_SETTING = "setting"
}


//底部菜單的實體數據類,包含路由,文字和圖標
data class BottomItemData(val route:String,val label: String, val icon: ImageVector)

//兩個頁面

@Composable
fun MainPage() {
    Surface() {
        Text(text = "首頁")
    }
}
@Composable
fun SettingPage() {
    Surface() {
        Text(text = "設置")
    }
}

深層鏈接

深層鏈接實際就是Intent-Filter的用法,這裡還是比較少用,就不准備詳細說明瞭,具體使用可以參考導航 - Jetpack Compose Docs

參考

提問之前，請先看提問須知 點擊右側圖標發起提問 聯繫我 或者加入QQ群一起學習 Stars-One安卓學習交流群 TornadoFx學習交流群:1071184701
您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • ASP.NET Core - 依賴註入(二)
    .NET Core 依賴註入的基本用法 話接上篇，這一章介紹 .NET Core 框架自帶的輕量級 Ioc 容器下服務使用的一些知識點，大家可以先看看上一篇文章 [ASP.NET Core - 依賴註入(一)] 2.3 服務解析 通過 IServiceCollection 註冊了服務之後，可以通過以 ...
  • RestSharp —（個人胡說八道🤣）
    RestSharp RestSharp是一個輕量的，不依賴任何第三方的模擬Http的組件或者類庫。RestSharp具體以下特性；支持net4.0++，支持HTTP的GET, POST, PUT, HEAD, OPTIONS, DELETE等操作，支持oAuth 1, oAuth 2, Basic, ...
  • AIR32F103(九) CAN匯流排的通信和ID過濾機制及實例
    CAN 是一種典型的廣播式網路, 在實際應用中, 如果只希望接收到特定類型的數據, 就要藉助過濾器來實現. AIR32/STM32的CAN控制器包含14個過濾器, 可以設置為 屏蔽模式 或 列表模式 對CAN匯流排上的報文進行過濾. 當節點希望接收到一種報文時, 可以用屏蔽位模式進行過濾, ...
  • 《痞子衡嵌入式半月刊》 第 72 期
    痞子衡嵌入式半月刊： 第 72 期 這裡分享嵌入式領域有用有趣的項目/工具以及一些熱點新聞，農曆年分二十四節氣，希望在每個交節之日準時發佈一期。 本期刊是開源項目（GitHub: JayHeng/pzh-mcu-bi-weekly），歡迎提交 issue，投稿或推薦你知道的嵌入式那些事兒。 上期回顧 ...
  • Ubuntu安裝Zabbix6.0
    環境 系統：Ubuntu 20.04 虛擬平臺：Vmware Workstation 16 PRO 軟體版本：Zabbix 6.0 LTS 資料庫：PostgreSQL Web服務：Apache 新建虛擬機（物理機跳過） Ubuntu安裝優化 安裝Zabbix倉庫 wget https://repo ...
  • SQL語句中 left join 後用 on 還是 where，區別大了！
    前天寫SQL時本想通過 A left B join on and 後面的條件來使查出的兩條記錄變成一條，奈何發現還是有兩條。 後來發現 join on and 不會過濾結果記錄條數，只會根據and後的條件是否顯示 B表的記錄，A表的記錄一定會顯示。 不管and 後面的是A.id=1還是B.id=1, ...
  • NET6介面項目基礎框架項目
    1、項目結構 項目說明： 該項目是用NET6搭建的webapi介面項目，然後配一個asp.net mvc的管理系統，資料庫是用的mysql，在SiteApi項目下有資料庫sql文件，下麵是一些截圖 介面配置的swagger界面 配套的後臺管理系統 項目具體說明： SiteApi：NET6介面項目，具 ...
  • mysql增量備份腳本
    2、增量備份 2.1、添加備份腳本 [root@localhost]# vim /mnt/data/backup/mysql/mysql_m_bak_diff.sh #!/bin/bash #mysql 增量備份 time=`date +%Y%m%d` now=`date +%F' '%T` eti ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類