條件式導覽食譜
這份食譜示範如何實作條件式導覽,也就是只有在符合條件時 (在本例中,即使用者已登入),才能存取特定目的地。
運作方式
這個範例的Profile目的地需要使用者登入。如果使用者未登入並嘗試前往 Profile,系統會將他們重新導向至 Login 畫面。成功登入後,系統會自動將他們導向 Profile 畫面。
AppBackStack
這項食譜的核心是自訂 AppBackStack 類別,其中封裝了條件式導覽的邏輯。
-
RequiresLogin介面:標記介面RequiresLogin用於識別需要使用者登入的目的地。Profile目的地會實作這個介面。 -
重新導向至登入畫面:如果呼叫
add函式時,目的地實作了RequiresLogin,且使用者未登入,AppBackStack會儲存預期目的地,並將Login路由新增至返回堆疊。 -
處理登入:呼叫
login函式時,會將使用者狀態設為已登入。如果使用者嘗試存取已儲存的目的地,系統會將該目的地新增至返回堆疊,並移除Login畫面。 -
處理登出:呼叫
logout函式時,會將使用者狀態設為登出,並從返回堆疊中移除任何需要使用者登入的目的地。
這種做法可將邏輯集中在自訂返回堆疊實作中,以簡潔的方式處理條件式導覽。
/* * Copyright 2025 The Android Open Source Project * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.example.nav3recipes.conditional import android.os.Bundle import androidx.activity.ComponentActivity import androidx.activity.compose.setContent import androidx.compose.foundation.layout.Column import androidx.compose.material3.Button import androidx.compose.material3.Text import androidx.compose.runtime.Composable import androidx.compose.runtime.getValue import androidx.compose.runtime.mutableStateOf import androidx.compose.runtime.remember import androidx.compose.runtime.saveable.rememberSaveable import androidx.compose.runtime.saveable.rememberSerializable import androidx.compose.runtime.setValue import androidx.lifecycle.compose.dropUnlessResumed import androidx.navigation3.runtime.NavBackStack import androidx.navigation3.runtime.NavKey import androidx.navigation3.runtime.entryProvider import androidx.navigation3.runtime.serialization.NavBackStackSerializer import androidx.navigation3.runtime.serialization.NavKeySerializer import androidx.navigation3.ui.NavDisplay import com.example.nav3recipes.content.ContentBlue import com.example.nav3recipes.content.ContentGreen import com.example.nav3recipes.content.ContentYellow import com.example.nav3recipes.ui.setEdgeToEdgeConfig import kotlinx.serialization.Serializable /** * Class for representing navigation keys in the app. * * Note: We use a sealed class because KotlinX Serialization handles * polymorphic serialization of sealed classes automatically. * * @param requiresLogin - true if the navigation key requires that the user is logged in * to navigate to it */ @Serializable sealed class ConditionalNavKey(val requiresLogin: Boolean = false) : NavKey /** * Key representing home screen */ @Serializable private data object Home : ConditionalNavKey() /** * Key representing profile screen that is only accessible once the user has logged in */ @Serializable private data object Profile : ConditionalNavKey(requiresLogin = true) /** * Key representing login screen * * @param redirectToKey - navigation key to redirect to after successful login */ @Serializable private data class Login( val redirectToKey: ConditionalNavKey? = null ) : ConditionalNavKey() class ConditionalActivity : ComponentActivity() { override fun onCreate(savedInstanceState: Bundle?) { setEdgeToEdgeConfig() super.onCreate(savedInstanceState) setContent { val backStack = rememberNavBackStack<ConditionalNavKey>(Home) var isLoggedIn by rememberSaveable { mutableStateOf(false) } val navigator = remember { Navigator( backStack = backStack, onNavigateToRestrictedKey = { redirectToKey -> Login(redirectToKey) }, isLoggedIn = { isLoggedIn } ) } NavDisplay( backStack = backStack, onBack = { navigator.goBack() }, entryProvider = entryProvider { entry<Home> { ContentGreen("Welcome to Nav3. Logged in? ${isLoggedIn}") { Column { Button(onClick = dropUnlessResumed { navigator.navigate(Profile) }) { Text("Profile") } Button(onClick = dropUnlessResumed { navigator.navigate(Login()) }) { Text("Login") } } } } entry<Profile> { ContentBlue("Profile screen (only accessible once logged in)") { Button(onClick = dropUnlessResumed { isLoggedIn = false navigator.navigate(Home) }) { Text("Logout") } } } entry<Login> { key -> ContentYellow("Login screen. Logged in? $isLoggedIn") { Button(onClick = dropUnlessResumed { isLoggedIn = true key.redirectToKey?.let { targetKey -> backStack.remove(key) navigator.navigate(targetKey) } }) { Text("Login") } } } } ) } } } // An overload of `rememberNavBackStack` that returns a subtype of `NavKey`. // See https://issuetracker.google.com/issues/463382671 for a discussion of this function @Composable fun <T : NavKey> rememberNavBackStack(vararg elements: T): NavBackStack<T> { return rememberSerializable( serializer = NavBackStackSerializer(elementSerializer = NavKeySerializer()) ) { NavBackStack(*elements) } }
/* * Copyright 2025 The Android Open Source Project * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.example.nav3recipes.conditional import androidx.navigation3.runtime.NavBackStack /** * Provides navigation events with built-in support for conditional access. If the user attempts to * navigate to a [ConditionalNavKey] that requires login ([ConditionalNavKey.requiresLogin] is true) * but is not currently logged in, the Navigator will redirect the user to a login key. * * @property backStack The back stack that is modified by this class * @property onNavigateToRestrictedKey A lambda that is called when the user attempts to navigate * to a key that requires login. This should return the key that represents the login screen. The * user's target key is supplied as a parameter so that after successful login the user can be * redirected to their target destination. * @property isLoggedIn A lambda that returns whether the user is logged in. */ class Navigator( private val backStack: NavBackStack<ConditionalNavKey>, private val onNavigateToRestrictedKey: (targetKey: ConditionalNavKey?) -> ConditionalNavKey, private val isLoggedIn: () -> Boolean, ) { fun navigate(key: ConditionalNavKey) { if (key.requiresLogin && !isLoggedIn()) { val loginKey = onNavigateToRestrictedKey(key) backStack.add(loginKey) } else { backStack.add(key) } } fun goBack() = backStack.removeLastOrNull() }