Android Compose中SharedPreference保存后界面不重组的问题排查

初始界面的firstName和lastName显示为空，调用API获取数据后将其保存至SharedPreference，期望保存完成后界面能自动展示这些数据，但当前使用mutableStateOf的代码未生效，请问为何保存SharedPreference后没有触发界面重组？

相关代码如下：

Compose状态初始化与界面代码：

val preferencesManager = remember { MyPreferenceManager(context) }
val userFirstName = remember { mutableStateOf(preferencesManager.getPreferenceData(AppPreferencesConstant.USER_FIRST_NAME, AppConstant.BLANK_STRING)) }
val userLastName = remember { mutableStateOf(preferencesManager.getPreferenceData(AppPreferencesConstant.USER_LAST_NAME, AppConstant.BLANK_STRING)) }

if (userFirstName.value.isEmpty().not) {
    Text(text = userFirstName.value)
}

API调用成功后更新SharedPreference的代码：

preferencesManager.savePreferenceData(
    AppPreferencesConstant.USER_FIRST_NAME,
    "firstname from api"
)
preferencesManager.savePreferenceData(
    AppPreferencesConstant.USER_LAST_NAME,
    "lastname from api"
)

问题原因 #

你当前的mutableStateOf仅在Compose组件初始化时，从SharedPreference读取了一次初始值。后续调用savePreferenceData更新SharedPreference时，并没有同步更新userFirstName和userLastName的value属性——Compose只会监听mutableStateOf的value变化，SharedPreference本身的更新不会自动触发Compose状态变更，因此界面不会重组。

解决方法 #

有两种常用的处理方式：

方式一：手动同步状态值

在保存SharedPreference后，直接手动更新mutableStateOf的value，触发Compose重组：

val newFirstName = "firstname from api"
preferencesManager.savePreferenceData(
    AppPreferencesConstant.USER_FIRST_NAME,
    newFirstName
)
// 手动更新状态
userFirstName.value = newFirstName

val newLastName = "lastname from api"
preferencesManager.savePreferenceData(
    AppPreferencesConstant.USER_LAST_NAME,
    newLastName
)
userLastName.value = newLastName

方式二：自动监听SharedPreference变化

通过Flow监听SharedPreference的变更，结合collectAsState让Compose自动感知状态变化：

1. 先修改MyPreferenceManager，添加监听方法：

class MyPreferenceManager(private val context: Context) {
    private val sharedPreferences = context.getSharedPreferences("your_preference_name", Context.MODE_PRIVATE)

    fun savePreferenceData(key: String, value: String) {
        sharedPreferences.edit().putString(key, value).apply()
    }

    fun getPreferenceData(key: String, defaultValue: String): String {
        return sharedPreferences.getString(key, defaultValue) ?: defaultValue
    }

    // 新增：返回监听指定key的Flow
    fun getPreferenceFlow(key: String, defaultValue: String): Flow<String> {
        return callbackFlow {
            val listener = SharedPreferences.OnSharedPreferenceChangeListener { _, changedKey ->
                if (changedKey == key) {
                    trySend(getPreferenceData(key, defaultValue))
                }
            }
            sharedPreferences.registerOnSharedPreferenceChangeListener(listener)
            // 发送初始值
            trySend(getPreferenceData(key, defaultValue))
            // 组件销毁时取消监听
            awaitClose {
                sharedPreferences.unregisterOnSharedPreferenceChangeListener(listener)
            }
        }.distinctUntilChanged()
    }
}

2. 在Compose中使用collectAsState获取状态：

val preferencesManager = remember { MyPreferenceManager(context) }
// 自动监听SharedPreference变化，状态更新时触发重组
val userFirstName by preferencesManager.getPreferenceFlow(
    AppPreferencesConstant.USER_FIRST_NAME, 
    AppConstant.BLANK_STRING
).collectAsState(initial = AppConstant.BLANK_STRING)

val userLastName by preferencesManager.getPreferenceFlow(
    AppPreferencesConstant.USER_LAST_NAME, 
    AppConstant.BLANK_STRING
).collectAsState(initial = AppConstant.BLANK_STRING)

// 界面逻辑不变
if (userFirstName.isNotEmpty()) {
    Text(text = userFirstName)
}

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