深層連結合成 BackStack 配方

本食譜示範如何管理合成 backStack 和 Task 堆疊,在深層連結的脈絡中套用導覽原則。

食譜結構

這項配方模擬的實際情境是「應用程式 A」深層連結至「應用程式 B」。

模組 syntheticbackstack 會模擬「應用程式 A」,其中包含 SyntheticBackStackDeepLinkActivity,可讓您建立深層連結 Intent,並在現有工作或新工作中觸發該 Intent。

「應用程式 B」是由 syntheticbackstackapp 模組模擬,其中包含您要深層連結的 SyntheticBackStackAppActivity。該模組說明如何建構合成返回堆疊,以及如何正確管理工作堆疊,以同時支援「返回」和「向上」按鈕。

使用方式

請確認模擬器或連結裝置上已安裝主要 appsyntheticbackstackapp。確認已安裝的 syntheticbackstackapp 支援 "www.nav3deeplink.com" 連結。

在食譜的到達網頁上選擇篩選條件,然後按一下按鈕即可深層連結。系統應會將您帶往 syntheticbackstackapp 的活動記錄。

運作方式

食譜遵循這裡歸納的深層連結規範。

如要查看 Existing Task 的行為,請按照下列步驟操作:

  1. 使用目前工作開啟深層連結
  2. 在裝置上向上滑動,即可查看所有最近使用的應用程式
  3. 請注意,新的 Activity 會在 Nav3Recipes 應用程式中開啟
  4. 按一下返回按鈕,返回原始活動
  5. 重複步驟 1
  6. 按一下向上按鈕即可前往上層畫面
  7. 在裝置上向上滑動,即可查看所有最近使用的應用程式
  8. 請注意,新的 Activity 現在已在 Nav3SyntheticBackStack 應用程式中開啟

如要查看 New Task 的行為,請按照下列步驟操作:

  1. 使用新工作開啟深層連結
  2. 在裝置上向上滑動,即可查看所有最近使用的應用程式
  3. 請注意,新的 Activity 會在 Nav3SyntheticBackStack 應用程式中開啟
  4. 按一下「向上」或「返回」按鈕,前往上層畫面

核心實作

如要瞭解 navigateUp 和建構合成 backStack 的核心輔助函式,請參閱這篇文章

延伸閱讀

請參閱深層連結指南,取得深層連結原則的完整指南,以及瞭解如何在 Navigation 3 中套用這些原則。

package com.example.nav3recipes.deeplink.handlerequests.syntheticbackstack

import android.content.Intent
import android.os.Bundle
import androidx.activity.ComponentActivity
import androidx.activity.compose.setContent
import androidx.compose.runtime.getValue
import androidx.compose.runtime.mutableStateOf
import androidx.compose.runtime.remember
import androidx.compose.runtime.setValue
import androidx.core.net.toUri
import androidx.lifecycle.compose.dropUnlessResumed
import com.example.nav3recipes.common.deeplink.EntryScreen
import com.example.nav3recipes.common.deeplink.LIST_FIRST_NAMES
import com.example.nav3recipes.common.deeplink.LIST_LOCATIONS
import com.example.nav3recipes.common.deeplink.MenuDropDown
import com.example.nav3recipes.common.deeplink.PaddedButton
import com.example.nav3recipes.common.deeplink.TextContent
import com.example.nav3recipes.ui.setEdgeToEdgeConfig

internal const val ADVANCED_PATH_BASE = "https://www.nav3deeplink.com"

/**
 * The recipe entry point that allows users to create a deep link and make a request with it.
 *
 * **HOW THIS RECIPE WORKS** This recipe simulates a real-world scenario where "App A" deep links
 * into "App B".
 *
 * "App A" is simulated by this current module `syntheticbackstack`, which
 * contains the [SyntheticBackStackDeepLinkActivity] that allows you to create a deeplink intent and
 * trigger that in either the existing Task, or in a new Task.
 *
 * "App B" is simulated by the module `syntheticbackstackapp`, which contains
 * the SyntheticBackStackAppActivity that you deeplink into. That module shows you how to build a synthetic backStack
 * and how to manage the Task stack properly in order to support both Back and Up buttons.
 *
 * See the [README](README.md) file of current module for more info on advanced deep linking.
 */
class SyntheticBackStackDeepLinkActivity: ComponentActivity() {

    override fun onCreate(savedInstanceState: Bundle?) {
        setEdgeToEdgeConfig()
        super.onCreate(savedInstanceState)

        setContent {
            EntryScreen("Sandbox - Build Your Deeplink Intent") {
                val initFirstName = MENU_OPTIONS_FIRST_NAME.values.first().first()
                val initLocation = MENU_OPTIONS_LOCATION.values.last().first()
                val initTaskStack = MENU_OPTIONS_TASK_STACK.values.first().first()
                var firstName by remember { mutableStateOf(initFirstName) }
                var location by remember { mutableStateOf(initLocation) }
                var taskStack by remember { mutableStateOf(initTaskStack) }

                // select first name
                MenuDropDown(
                    menuOptions = MENU_OPTIONS_FIRST_NAME,
                ) { _, selected ->
                    firstName = selected
                }

                // select first name
                MenuDropDown(
                    menuOptions = MENU_OPTIONS_LOCATION,
                ) { _, selected ->
                    location = selected
                }

                // select current task stack or build new task stack
                MenuDropDown(
                    menuOptions = MENU_OPTIONS_TASK_STACK,
                ) { _, selected ->
                    taskStack = selected
                }

                // build final deeplink URL and Intent
                val finalUrl = "${ADVANCED_PATH_BASE}/user/$firstName/$location"

                // display Intent info
                val flagString = if (taskStack == TAG_NEW_TASK) {
                    "Intent.FLAG_ACTIVITY_NEW_TASK or Intent.FLAG_ACTIVITY_CLEAR_TASK"
                } else "<none>"
                val intentString = """
                    | Final Intent:
                    | data = "$finalUrl"
                    | action = Intent.ACTION_VIEW
                    | flags = $flagString
                """.trimMargin()

                TextContent(intentString)

                // deeplink to target
                PaddedButton("Deeplink Away!", onClick = dropUnlessResumed {
                    val intent = Intent().apply {
                        data = finalUrl.toUri()
                        action = Intent.ACTION_VIEW
                        if (taskStack == TAG_NEW_TASK) {
                            flags = Intent.FLAG_ACTIVITY_NEW_TASK or Intent.FLAG_ACTIVITY_CLEAR_TASK
                        }
                    }

                    startActivity(intent)
                })
            }
        }
    }
}

private const val TAG_FIRST_NAME = "firstName"
private const val TAG_LOCATION = "location"
private const val TAG_TASK_STACK = "Task stack"
private const val TAG_CURRENT_TASK = "Use Current Task Stack"
private const val TAG_NEW_TASK = "Start New Task Stack"

private val MENU_OPTIONS_FIRST_NAME = mapOf(
    TAG_FIRST_NAME to LIST_FIRST_NAMES
)

private val MENU_OPTIONS_LOCATION = mapOf(
    TAG_LOCATION to LIST_LOCATIONS
)

private val MENU_OPTIONS_TASK_STACK = mapOf(
    TAG_TASK_STACK to listOf(TAG_CURRENT_TASK, TAG_NEW_TASK),
)