Jetpack Compose中Preferences Datastore保存深色模式状态失效问题排查

核心问题分析 #

• 初始状态未从Datastore读取值：isBackgroundColorDark硬编码初始值为false，且未监听Datastore的状态变化来同步UI状态
• 无效的LaunchedEffect：当前代码中的LaunchedEffect仅读取backgroundColorPreference.value但未赋值给isBackgroundColorDark，无法完成状态同步
• 协程使用不规范：按钮点击时在IO线程直接修改UI状态，且手动创建CoroutineScope容易导致内存泄漏

修复后的代码 #

MainActivity修正版 #

class MainActivity : ComponentActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContent {
            // 用remember保存Datastore实例，避免每次重组新建
            val backgroundColorDatastore = remember { BackgroundColorDatastore(this) }
            
            // 从Datastore加载偏好，转为State
            val backgroundColorPreference = backgroundColorDatastore.loadBackgroundColorPreference(
                key = backgroundColorDatastore.backgroundColorKey
            ).collectAsState(initial = false)

            // 用Datastore的初始值初始化UI状态
            var isBackgroundColorDark by remember { 
                mutableStateOf(backgroundColorPreference.value) 
            }
            
            // 监听Datastore的偏好变化，同步到UI状态
            LaunchedEffect(backgroundColorPreference) {
                isBackgroundColorDark = backgroundColorPreference.value
            }

            // 获取Composable绑定的协程作用域
            val coroutineScope = rememberCoroutineScope()

            Column(
                modifier = Modifier
                    .background(color = if (isBackgroundColorDark) Color.DarkGray else Color.White)
                    .fillMaxSize()
            ) {
                Button(onClick = {
                    coroutineScope.launch {
                        // 先更新UI状态（Main线程）
                        isBackgroundColorDark = !isBackgroundColorDark
                        // 再保存到Datastore（suspend函数自动切换线程）
                        backgroundColorDatastore.saveBackgroundColorPreference(
                            key = backgroundColorDatastore.backgroundColorKey,
                            data = isBackgroundColorDark
                        )
                    }
                }) {
                    Text(text = "Change Background Color")
                }
            }
        }
    }
}

Datastore类（优化命名，功能不变） #

// 规范命名，避免空格
private val Context.dataStore by preferencesDataStore("background_color_datastore")

class BackgroundColorDatastore(private val context: Context) {
    // 规范键名，避免空格
    val backgroundColorKey = booleanPreferencesKey("background_color")

    fun loadBackgroundColorPreference(key: Preferences.Key<Boolean>): Flow<Boolean> =      
        context.dataStore.data.map { preferences ->
            preferences[key] ?: false
        }

    suspend fun saveBackgroundColorPreference(key: Preferences.Key<Boolean>, data: Boolean) {
        context.dataStore.edit { preferences ->
            preferences[key] = data
        }
    }
}

关键修复点说明 #

1. 同步Datastore状态到UI：

   • 用backgroundColorPreference.value初始化isBackgroundColorDark，确保应用启动时加载之前保存的偏好
   • 添加LaunchedEffect监听backgroundColorPreference的变化，当Datastore的值被修改时自动同步UI状态

2. 协程优化：

   • 使用rememberCoroutineScope()获取与Composable生命周期绑定的协程作用域，避免手动创建CoroutineScope引发的内存泄漏
   • 无需手动指定Dispatchers.IO，Datastore的suspend函数会自动切换到合适的线程执行IO操作

3. 命名规范：

   • Datastore文件名和键名避免使用空格，符合Android开发的命名规范，减少潜在的异常风险

内容的提问来源于stack exchange，提问作者Bob Rasner