Android Kotlin DataStore数据更新异常：元素位置变更不生效

问题背景 #

我在Android中实现了一个将字符串列表存储到DataStore的函数，需求是：

• 调用saveLang()时，若数据不存在于DataStore中，移除列表首个元素并将新数据添加到末尾
• 若数据已存在，则将其移至列表末尾

原代码如下，但无法生效——当列表元素相同仅位置变化时，DataStore会忽略更新：

suspend fun saveLang(context: Context, data: String, langKey: String) {
    val dataStoreKey = stringSetPreferencesKey(langKey)
    val lastValue = readLang(context, langKey)
    if (!lastValue.contains(data)) {
        if (lastValue.size == 3) {
            lastValue.removeAt(0)
        }
        lastValue.add(lastValue.size, data)
        context.dataStore.edit { settings ->
            settings[dataStoreKey] = lastValue.toSet()
        }
    } else {
        lastValue.removeAt(lastValue.indexOf(data))
        lastValue.add(lastValue.size, data)
        context.dataStore.edit { settings ->
            settings[dataStoreKey] = lastValue.toSet()
        }
    }
}

后来我改成两次存储的方式实现了需求，但需要调用两次edit，希望找到更优方案：

suspend fun saveLang(context: Context, data: String, langKey: String) {
    val dataStoreKey = stringSetPreferencesKey(langKey)
    val lastValue = readLang(context, langKey)
    if (!lastValue.contains(data)) {
        if (lastValue.size == 3) {
            lastValue.removeAt(0)
        }
        lastValue.add(lastValue.size, data)
        context.dataStore.edit { settings ->
            settings[dataStoreKey] = lastValue.toSet()
        }
    } else {
        lastValue.removeAt(lastValue.indexOf(data))
        context.dataStore.edit { settings ->
            settings[dataStoreKey] = lastValue.toSet()
        }
        lastValue.add(lastValue.size, data)
        context.dataStore.edit { settings ->
            settings[dataStoreKey] = lastValue.toSet()
        }
    }
}

问题原因 #

DataStore的Preferences API中，StringSet的更新判断是基于集合的内容相等性——因为Set本身是无序容器，只要集合内的元素完全一致（不管顺序），DataStore就会认为数据没有变化，从而跳过更新操作。这就是原代码中调整元素顺序后无法触发更新的根本原因。

优化方案 #

方案1：将列表序列化为JSON字符串存储（推荐） #

既然需要保留元素顺序，使用StringSet本身就不符合需求，更合理的方式是将列表序列化为JSON字符串，存储为DataStore的普通String类型。这样只要列表顺序或内容变化，JSON字符串就会变化，DataStore会正常触发更新。

实现步骤：

1. 添加JSON序列化依赖（以Gson为例）：

implementation 'com.google.code.gson:gson:2.10.1'

2. 修改存储和读取逻辑：

// 定义String类型的DataStore Key
private fun langListPreferencesKey(langKey: String) = stringPreferencesKey(langKey)

// 读取列表
suspend fun readLang(context: Context, langKey: String): MutableList<String> {
    val gson = Gson()
    val json = context.dataStore.data.first()[langListPreferencesKey(langKey)] ?: "[]"
    return gson.fromJson(json, object : TypeToken<MutableList<String>>() {}.type)
}

// 保存列表（优化后的版本）
suspend fun saveLang(context: Context, data: String, langKey: String) {
    val dataStoreKey = langListPreferencesKey(langKey)
    val lastValue = readLang(context, langKey)

    if (!lastValue.contains(data)) {
        // 数据不存在，移除首个元素（如果已满3个）并添加到末尾
        if (lastValue.size == 3) {
            lastValue.removeAt(0)
        }
        lastValue.add(data)
    } else {
        // 数据已存在，移到末尾
        lastValue.remove(data)
        lastValue.add(data)
    }

    // 序列化为JSON后存储
    val gson = Gson()
    val json = gson.toJson(lastValue)
    context.dataStore.edit { settings ->
        settings[dataStoreKey] = json
    }
}

方案2：基于StringSet的单次Edit优化（仅作兼容） #

如果必须使用StringSet，可以通过“先添加临时元素触发集合变化，再调整目标元素顺序”的方式，让DataStore感知到更新，且仅需一次edit操作：

suspend fun saveLang(context: Context, data: String, langKey: String) {
    val dataStoreKey = stringSetPreferencesKey(langKey)
    val lastValue = readLang(context, langKey).toMutableList()

    context.dataStore.edit { settings ->
        if (!lastValue.contains(data)) {
            if (lastValue.size == 3) {
                lastValue.removeAt(0)
            }
            lastValue.add(data)
            settings[dataStoreKey] = lastValue.toSet()
        } else {
            // 添加临时元素触发集合变化
            val tempElement = UUID.randomUUID().toString()
            settings[dataStoreKey] = lastValue.toMutableSet().apply { add(tempElement) }

            // 调整目标元素到末尾并移除临时元素
            lastValue.remove(data)
            lastValue.add(data)
            settings[dataStoreKey] = lastValue.toSet()
        }
    }
}

注：此方案属于hack手段，仅适合必须兼容原有StringSet存储的场景，稳定性和可维护性不如JSON序列化方案。

方案对比 #

• JSON序列化方案：完全适配有序列表需求，逻辑清晰无hack，是长期维护的最优选择。
• StringSet hack方案：仅适合兼容旧存储的临时场景，逻辑复杂，存在潜在风险。

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