解决 Android 上的 KMP 分解导航错误：“Multiple RetainedComponents”

使用 Decompose 库处理 KMP 中的导航键重复

将 Kotlin 与 Android Decompose 库结合使用用于 KMP 项目

// Solution 1: Use Unique Keys for retainedComponent in Android MainActivity
// This approach involves assigning unique keys to the retained components
// within the MainActivity to prevent SavedStateProvider errors.

class MainActivity : ComponentActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        // Assign unique keys to avoid registration conflict
        val rootF = retainedComponentWithKey("RootComponent_mainRoot") { RootComponent(it) }
        val dashF = retainedComponentWithKey("DashBoardRootComponent_dashBoardRoot") { DashBoardRootComponent(it) }
        setContent {
            App(rootF.first, dashF.first)
        }
    }

    private fun <T : Any> retainedComponentWithKey(key: String, factory: (ComponentContext) -> T): Pair<T, String> {
        val component = retainedComponent(key = key, handleBackButton = true, factory = factory)
        return component to key
    }
}

状态注册错误处理的替代解决方案

在 Kotlin 中利用错误处理和状态验证

// Solution 2: Implementing Conditional Registration to Prevent Key Duplication
// This code conditionally registers a SavedStateProvider only if it hasn't been registered.

class MainActivity : ComponentActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        try {
            val root = retainedComponentWithConditionalKey("RootComponent_mainRoot") { RootComponent(it) }
            val dashBoardRoot = retainedComponentWithConditionalKey("DashBoardRootComponent_dashBoardRoot") {
                DashBoardRootComponent(it)
            }
            setContent {
                App(root.first, dashBoardRoot.first)
            }
        } catch (e: IllegalArgumentException) {
            // Handle duplicate key error by logging or other appropriate action
            Log.e("MainActivity", "Duplicate key error: ${e.message}")
        }
    }

    private fun <T : Any> retainedComponentWithConditionalKey(
        key: String,
        factory: (ComponentContext) -> T
    ): Pair<T, String> {
        return try {
            retainedComponent(key = key, factory = factory) to key
        } catch (e: IllegalArgumentException) {
            // Already registered; handle as needed
            throw e
        }
    }
}

适用于 Android 和桌面的测试和验证代码

为 Android 和桌面 KMP 设置添加单元测试

// Solution 3: Creating Unit Tests for Different Environment Compatibility
// These tests validate if the retained components work across Android and Desktop.

@Test
fun testRootComponentCreation() {
    val context = mockk<ComponentContext>()
    val rootComponent = RootComponent(context)
    assertNotNull(rootComponent)
}

@Test
fun testDashBoardRootComponentCreation() {
    val context = mockk<ComponentContext>()
    val dashBoardRootComponent = DashBoardRootComponent(context)
    assertNotNull(dashBoardRootComponent)
}

@Test(expected = IllegalArgumentException::class)
fun testDuplicateKeyErrorHandling() {
    retainedComponentWithKey("duplicateKey") { RootComponent(mockk()) }
    retainedComponentWithKey("duplicateKey") { RootComponent(mockk()) }
}

有关 KMP 分解导航的常见问题

1. 什么是 retainedComponent 在KMP中做什么？
2. retainedComponent 用于在配置更改期间保留组件状态，尤其是在 Android 上，它可以防止活动重新启动期间丢失数据。
3. 如何防止 Decompose 中出现重复键错误？
4. 使用自定义函数，例如 retainedComponentWithKey 为每个组件分配唯一的键。这会阻止相同的密钥在 SavedStateProvider。
5. 为什么是 SavedStateProvider Android 特有的错误？
6. 安卓使用 SavedStateProvider 跟踪 Activity 重新启动期间的 UI 状态。如果存在重复的键，Android 的状态注册表会抛出错误，从而停止应用程序。
7. 我可以在桌面上测试这些导航设置吗？
8. 是的，使用 LifecycleRegistry 在桌面环境中管理组件生命周期状态。这有助于在桌面应用程序中模拟类似 Android 的生命周期行为。
9. 目的是什么 LifecycleRegistry 在桌面上？
10. LifecycleRegistry 提供自定义生命周期管理选项，允许 KMP 应用程序处理 Android 之外的组件状态，使其适用于桌面环境。
11. 做 retainedComponent Android 和桌面上的工作方式相同吗？
12. 不，在桌面上，您可能需要 LifecycleRegistry 定义自定义生命周期，而 Android 本质上通过以下方式处理组件状态 SavedStateProvider。
13. 使用有什么好处 retainedComponentWithKey？
14. 它通过确保每个组件都是唯一标识来防止状态冲突，从而避免在 Android 上的屏幕之间切换时发生崩溃。
15. 怎么样 17 号 影响导航？
16. 17 号 向导航堆栈添加新的屏幕配置。这对于管理从一个屏幕到另一个屏幕的顺利过渡至关重要。
17. 我可以在 Decompose 中处理后退导航堆栈吗？
18. 是的，使用 pop 命令用于从导航堆栈中删除最后一个屏幕，从而实现屏幕之间受控的后退导航。
19. 嘲笑的目的是什么 ComponentContext 在测试中？
20. 嘲笑 ComponentContext 允许您在单元测试中模拟组件依赖关系，而无需完整的应用程序环境。

解决 KMP 导航中的键重复问题

使用 Decompose 处理 KMP 中的导航可能很复杂，尤其是在处理 Android 的生命周期怪癖时。 “具有给定密钥的 SavedStateProvider 已注册”错误凸显了 Android 中需要精确的密钥管理以防止重复冲突。当应用程序重新启动活动（例如在屏幕旋转期间）并尝试在 SavedStateProvider 中注册相同的密钥两次时，通常会发生此错误。

为每个保留组件设置唯一的密钥可以解决这些问题并确保稳定的用户体验。通过分配不同的键、使用 try-catch 块进行错误处理以及为桌面实现 LifecycleRegistry，KMP 开发人员可以避免这些错误并跨多个平台构建一致、可靠的导航流程。 🎉