android - 从 SharedPreferences 中删除条目后未通知 OnSharedPreferenceChangeListener

Question

我一直在组装一个简单的 Android ListView 应用程序来自学 LoaderManagers 和 Loaders。该应用仅提供一个加载器，当共享首选项发生变化时，该加载器会通过 OnSharedPreferenceChangeListener 收到通知。

它有一个带有 ListView 和两个按钮的简单 UI，一个用于添加首选项，一个用于删除所有共享首选项。

我的 Activity 是 ListActivity 的子类并实现了 LoaderManager.LoaderCallbacks>。

My Loader 仅在共享首选项发生更改时通知 Activity。

我的问题是，当单击删除所有首选项按钮时，不会通知 OnSharedPreferenceChangeListener，而添加首选项会通知它。即使没有通知收听者，偏好也会被删除，因为随后单击添加偏好按钮会更新列表以显示单个列表条目。

这是代码(为简洁起见省略了一些位):

主 Activity .java

public class MainActivity extends ListActivity implements LoaderManager.LoaderCallbacks<List<String>>
{

private ListView listView;
private static final int LOADER_ID = 1;
private LoaderManager.LoaderCallbacks<List<String>> mCallbacks;
private ArrayAdapter<String> adapter;

@Override
protected void onCreate(Bundle savedInstanceState)
{
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);
    setUpLoaderManager();

    ArrayList<String> values = new ArrayList<String>();
    adapter = new ArrayAdapter<String>(this, android.R.layout.simple_list_item_1, android.R.id.text1, values);

    listView = (ListView) findViewById(android.R.id.list);
    listView.setAdapter(adapter);
}

private void setUpLoaderManager()
{
    mCallbacks = this;
    LoaderManager lm = getLoaderManager();
    lm.initLoader(LOADER_ID, null, mCallbacks);
}

@Override
public void onLoadFinished(Loader<List<String>> loader, List<String> data)
{
    switch (loader.getId())
    {
        case LOADER_ID:
            adapter.clear();
            adapter.addAll(data);
            break;
    }
}

@Override
public Loader<List<String>> onCreateLoader(int id, Bundle args)
{
    return new SampleLoader(this);
}

public void addSharedPreference(View v)
{
    getSharedPreferences("someData", Context.MODE_PRIVATE).edit().putString(new Date().toString(), "hi").commit();
}

public void deleteSharedPreference(View v)
{
    SharedPreferences sharedPreferences = getSharedPreferences("someData", Context.MODE_PRIVATE);
    sharedPreferences.edit().clear().commit();
}

示例加载器.java

public class SampleLoader extends AsyncTaskLoader<List<String>>

{
    private List<String> mData;

public SampleLoader(Context ctx)
{
    super(ctx);
}

@Override
public List<String> loadInBackground()
{
    List<String> data = new ArrayList<String>();

    SharedPreferences prefs = getContext().getSharedPreferences("someData", Context.MODE_PRIVATE);
    Map<String, String> currentPref = (Map<String, String>) prefs.getAll();

    if (currentPref.size() > 0)
    {
        for (Map.Entry<String, String> entry : currentPref.entrySet())
        {
            data.add(entry.getKey());
        }
    }
    return data;
}

@Override
public void deliverResult(List<String> data)
{
    if (isReset())
    {
        releaseResources(data);
        return;
    }

    List<String> oldData = mData;
    mData = data;

    if (isStarted())
    {
        super.deliverResult(data);
    }

    if (oldData != null && oldData != data)
    {
        releaseResources(oldData);
    }
}

@Override
protected void onStartLoading()
{
    if (mData != null)
    {
        deliverResult(mData);
    }

    if (mObserver == null)
    {
        mObserver = new SharedPrefsObserver(this, getContext());
    }

    if (takeContentChanged() || mData == null)
    {
        forceLoad();
    }
}

@Override
protected void onStopLoading()
{
    cancelLoad();
}

@Override
protected void onReset()
{
    onStopLoading();

    if (mData != null)
    {
        releaseResources(mData);
        mData = null;
    }

    if (mObserver != null)
    {
        mObserver = null;
    }
}

@Override
public void onCanceled(List<String> data)
{
    super.onCanceled(data);

    releaseResources(data);
}

private void releaseResources(List<String> data)
{
}

private SharedPrefsObserver mObserver;
}

SharedPrefsObserver.java

public class SharedPrefsObserver
{
    public static OnSharedPreferenceChangeListener listener;

    public SharedPrefsObserver(final SampleLoader sampleLoader, Context context)
    {
        final SharedPreferences prefs = context.getSharedPreferences("someData", Context.MODE_PRIVATE);

        listener = new OnSharedPreferenceChangeListener()
        {

            @Override
            public void onSharedPreferenceChanged(SharedPreferences sharedPreferences, String key)
            {
                sampleLoader.onContentChanged();
            }
        };
        prefs.registerOnSharedPreferenceChangeListener(listener);
    }
}

activity_main.xml

<LinearLayout
    android:id="@+id/button_layout"
    android:layout_width="fill_parent"
    android:layout_height="wrap_content"
    android:orientation="horizontal"
    android:layout_alignParentBottom="true"
    android:weightSum="2">

    <Button
        android:id="@+id/button_delete"
        android:layout_width="0dp"
        android:layout_weight="1"
        android:layout_height="wrap_content"
        android:onClick="deleteSharedPreference"
        android:text="Delete all preferences" >
    </Button>

    <Button
        android:id="@+id/button_add"
        android:layout_width="0dp"
        android:layout_weight="1"
        android:layout_height="wrap_content"
        android:onClick="addSharedPreference"
        android:text="Add new preference" >
    </Button>
</LinearLayout>

<ListView
    android:id="@android:id/list"
    android:layout_width="match_parent"
    android:layout_height="wrap_content"
    android:layout_alignParentTop="true"
    android:layout_above="@id/button_layout"
    android:layout_alignParentLeft="true">
</ListView>

这是我不得不用来强制加载器在删除首选项后刷新数据的解决方法:

    public void deleteSharedPreference(View v)
{
    SharedPreferences sharedPreferences = getSharedPreferences("someData", Context.MODE_PRIVATE);
    sharedPreferences.edit().clear().commit();
    //dirty hack - sharedPreferences observer is not notified when preferences are removed so had to bypass it and call the loader manually
    getLoaderManager().getLoader(LOADER_ID).forceLoad();
}

那么，关于为什么删除首选项没有通知我的听众有什么想法吗？

Answer 1

sharedPreferences.edit().clear().commit() 按照设计不会通知监听器。如果您希望收到删除共享首选项的通知，则需要使用 remove(key) 而不是 clear()。

查看 Android source ，你可以看到 clear() 和 remove(key) 的实现略有不同。当 remove(key) 将键添加到由编辑器创建的私有(private) HashMap 对象以跟踪更改时，clear() 只是设置一个标志并且不进行任何更改到 HashMap 对象。 SharedPreferences 私有(private)方法 NotifyListeners()不尊重这个标志，它只看 HashMap 对象。所以调用clear()不会被监听器报告。

[编辑]:删除 key 时，您也必须使用相同的 editor 实例来提交它:

SharedPreferences settings = getSharedPreferences("someData", MODE_PRIVATE);
SharedPreferences.Editor editor = settings.edit();
editor.remove(myKey1);
editor.remove(myKey2);
...
editor.commit();