MultiSelectListPreference保留旧值是否为Bug？求解决方案

问题描述 #

当MultiSelectListPreference的选项数组动态变更（实际场景为从手机联系人生成，随联系人变化而更新）时，用户无法移除偏好设置中之前存储的旧选中值，具体复现步骤与现象如下：

复现步骤与现象 #

1. 初始配置
   XML中的Preference定义：

   <PreferenceCategory app:title="experiment">
       <MultiSelectListPreference
           app:key="experiment"
           app:entries="@array/abc"
           app:entryValues="@array/abc"
           app:title="my values test"
           />
   </PreferenceCategory>
   

   对应的数组资源：

   <array name="abc">
       <item>a</item>
       <item>b</item>
       <item>c</item>
   </array>
   

2. 首次操作
   在UI中选中所有选项后，偏好文件存储结果：

   <set name="experiment">
       <string>a</string>
       <string>b</string>
       <string>c</string>
   </set>
   

3. 修改选项数组
   将数组更新为：

   <array name="abc">
       <item>A</item>
       <item>B</item>
       <item>C</item>
   </array>
   

4. 再次操作后的异常现象

   • 进入偏好UI选中所有新选项，偏好文件同时保留新旧值：

     <set name="experiment">
         <string>a</string>
         <string>A</string>
         <string>b</string>
         <string>B</string>
         <string>c</string>
         <string>C</string>
     </set>
     

   • 取消所有选项选中后，偏好文件仅保留旧选中值，无法清除：

     <set name="experiment">
         <string>a</string>
         <string>b</string>
         <string>c</string>
     </set>
     

用户预期：修改选择后，保存的偏好应仅包含当前可见选项。请问这是否为Bug？有何解决办法？

回答 #

这不是官方认定的Bug，而是MultiSelectListPreference的设计逻辑：组件仅会处理当前选项列表内的值的选中/取消操作，不会自动清理不在当前选项中的旧值——因为它无法区分“旧选项被永久移除”和“选项只是暂时未加载”两种场景。

针对动态选项的场景，可通过以下几种方式解决：

1. 动态更新选项时主动清理无效值 #

在更新MultiSelectListPreference的entries和entryValues之前，先过滤掉当前存储值中不在新选项列表内的元素，再重新保存有效值：

// 假设newEntries是新的显示文本数组，newEntryValues是新的选项值数组
val pref = findPreference<MultiSelectListPreference>("experiment") ?: return
val currentSelected = pref.values ?: emptySet()
// 过滤出仅存在于新选项中的值
val validSelected = currentSelected.filter { newEntryValues.contains(it) }.toSet()
// 更新选项配置
pref.entries = newEntries
pref.entryValues = newEntryValues
// 保存过滤后的有效值
pref.values = validSelected

2. 自定义Preference重写保存逻辑 #

如果需要长期适配动态选项场景，可以自定义MultiSelectListPreference，在保存选中值时自动过滤无效值：

class DynamicMultiSelectListPreference(context: Context, attrs: AttributeSet) :
    MultiSelectListPreference(context, attrs) {

    override fun setValues(values: Set<String>?) {
        // 仅保留当前entryValues中存在的值
        val validValues = values?.filter { entryValues.contains(it) }.orEmpty().toSet()
        super.setValues(validValues)
    }
}

在XML中替换为自定义组件：

<PreferenceCategory app:title="experiment">
    <com.yourpackage.DynamicMultiSelectListPreference
        app:key="experiment"
        app:entries="@array/abc"
        app:entryValues="@array/abc"
        app:title="my values test"
        />
</PreferenceCategory>

3. 在Fragment生命周期中定期清理 #

如果选项在Fragment生命周期内动态加载，可在onResume中执行一次无效值清理，确保每次进入偏好页面时存储值都是有效的：

override fun onResume() {
    super.onResume()
    val pref = findPreference<MultiSelectListPreference>("experiment") ?: return
    val entryValues = pref.entryValues ?: return
    val currentSelected = pref.values ?: emptySet()
    val validSelected = currentSelected.intersect(entryValues.toSet())
    // 仅当有效值与当前存储值不同时才更新，避免不必要的偏好写入
    if (validSelected != currentSelected) {
        pref.values = validSelected
    }
}

内容的提问来源于stack exchange，提问作者Doron Ben-Ari