SharedPreferences。onSharedPreferenceChangeListener没有被一致调用

我正在像这样注册一个首选项更改侦听器(在我的主活动的onCreate()中):

SharedPreferences prefs = PreferenceManager.getDefaultSharedPreferences(this);


prefs.registerOnSharedPreferenceChangeListener(
new SharedPreferences.OnSharedPreferenceChangeListener() {
public void onSharedPreferenceChanged(
SharedPreferences prefs, String key) {


System.out.println(key);
}
});

问题是，侦听器并不总是被调用。在首选项改变的前几次，它是有效的，然后它不再被调用，直到我卸载并重新安装应用程序。重新启动应用程序似乎无法修复它。

我发现一个邮件列表线程报告了同样的问题，但没有人真正回答他。我做错了什么?

99253 次浏览
小开
最佳答案

这是一个狡猾的例子。SharedPreferences将监听器保存在WeakHashMap中。这意味着您不能使用匿名内部类作为侦听器，因为一旦您离开当前范围，它就会成为垃圾收集的目标。它一开始会工作，但最终会被垃圾收集，从WeakHashMap中删除并停止工作。

在类的字段中保留对侦听器的引用，只要没有销毁类实例，就没问题。

例如:

prefs.registerOnSharedPreferenceChangeListener(
new SharedPreferences.OnSharedPreferenceChangeListener() {
public void onSharedPreferenceChanged(SharedPreferences prefs, String key) {
// Implementation
}
});

这样做:

// Use instance field for listener
// It will not be gc'd as long as this instance is kept referenced
listener = new SharedPreferences.OnSharedPreferenceChangeListener() {
public void onSharedPreferenceChanged(SharedPreferences prefs, String key) {
// Implementation
}
};


prefs.registerOnSharedPreferenceChangeListener(listener);

在onDestroy方法中取消注册的原因解决了这个问题，因为要做到这一点，您必须在字段中保存侦听器，因此防止了这个问题。在字段中保存监听器可以修复问题，而不是在onDestroy中取消注册。

更新:关于此行为，Android文档已经更新和警告。所以，奇怪的行为仍然存在。但现在它被记录下来了。

小开

这个被接受的答案是可以的，对于我来说，它是在每次活动恢复时创建新实例

那么如何在活动中保持对侦听器的引用呢

OnSharedPreferenceChangeListener listener = new OnSharedPreferenceChangeListener(){
public void onSharedPreferenceChanged(SharedPreferences prefs, String key) {
// your stuff
}
};

在onResume和onPause中

@Override
public void onResume() {
super.onResume();
getPreferenceScreen().getSharedPreferences().registerOnSharedPreferenceChangeListener(listener);
}


@Override
public void onPause() {
super.onPause();
getPreferenceScreen().getSharedPreferences().unregisterOnSharedPreferenceChangeListener(listener);


}

这将非常类似于你所做的，除了我们保持一个硬参考。

小开

由于这是主题最详细的页面，我想添加我的50ct。

我有一个问题，OnSharedPreferenceChangeListener没有被调用。我的SharedPreferences在主活动的开始被检索:

prefs = PreferenceManager.getDefaultSharedPreferences(this);

My PreferenceActivity代码很短，除了显示首选项外什么都不做:

public class Preferences extends PreferenceActivity {
@Override
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
// load the XML preferences file
addPreferencesFromResource(R.xml.preferences);
}
}

每次按下菜单按钮，我都会从主Activity中创建PreferenceActivity:

@Override
public boolean onPrepareOptionsMenu(Menu menu) {
super.onCreateOptionsMenu(menu);
//start Preference activity to show preferences on screen
startActivity(new Intent(this, Preferences.class));
//hook into sharedPreferences. THIS NEEDS TO BE DONE AFTER CREATING THE ACTIVITY!!!
prefs.registerOnSharedPreferenceChangeListener(this);
return false;
}

在这种情况下，注册OnSharedPreferenceChangeListener需要在创建PreferenceActivity之后完成，否则主活动中的处理程序将不会被调用!!我花了很长时间才意识到……

小开

在阅读由第一个应用程序共享的Word可读数据时，我们应该

取代

getSharedPreferences("PREF_NAME", Context.MODE_PRIVATE);

与

getSharedPreferences("PREF_NAME", Context.MODE_MULTI_PROCESS);

在第二个应用程序中获得更新的值。

但还是不管用…

小开

监听器保存在WeakHashMap中是有意义的。因为大多数时候，开发人员更喜欢这样编写代码。

PreferenceManager.getDefaultSharedPreferences(getApplicationContext()).registerOnSharedPreferenceChangeListener(
new OnSharedPreferenceChangeListener() {
@Override
public void onSharedPreferenceChanged(
SharedPreferences sharedPreferences, String key) {
Log.i(LOGTAG, "testOnSharedPreferenceChangedWrong key =" + key);
}
});

这似乎并不坏。但是如果onsharedpreferencechangelistener的容器不是WeakHashMap，那就很糟糕了。如果上面的代码是在活动中编写的。由于您使用的是非静态(匿名)内部类，它将隐式地保存封闭实例的引用。这将导致内存泄漏。

更重要的是，如果你保持监听器作为一个字段，你可以在开始时使用registerOnSharedPreferenceChangeListener，在结束时调用unregisterOnSharedPreferenceChangeListener。但是您不能在方法的作用域之外访问局部变量。所以你只有注册的机会，没有取消注册的机会。因此，使用WeakHashMap将解决这个问题。这是我推荐的方法。

如果将侦听器实例设置为静态字段，则可以避免非静态内部类造成的内存泄漏。但是由于侦听器可以是多个，所以它应该是与实例相关的。这将减少处理onSharedPreferenceChanged回调的成本。

小开

每次调用onResume时，接受的答案都会创建一个SharedPreferenceChangeListener。@Samuel通过将SharedPreferenceListener作为Activity类的成员来解决这个问题。但是还有第三个更直接的解决方案，谷歌也在this codelab中使用。让你的activity类实现OnSharedPreferenceChangeListener接口，并在activity中覆盖onSharedPreferenceChanged，有效地使activity本身成为SharedPreferenceListener。

public class MainActivity extends Activity implements SharedPreferences.OnSharedPreferenceChangeListener {


@Override
public void onSharedPreferenceChanged(SharedPreferences sharedPreferences, String s) {


}


@Override
protected void onStart() {
super.onStart();
PreferenceManager.getDefaultSharedPreferences(this)
.registerOnSharedPreferenceChangeListener(this);
}


@Override
protected void onStop() {
super.onStop();
PreferenceManager.getDefaultSharedPreferences(this)
.unregisterOnSharedPreferenceChangeListener(this);
}
}
小开
所以，我不知道这是否真的能帮助到任何人，但它解决了我的问题。 尽管我已经实现了OnSharedPreferenceChangeListener，如接受的答案所述。仍然，我有一个不一致的监听器被调用 我来这里是为了了解Android只是在一段时间后将其发送给垃圾收集。所以，我检查了一下我的代码。 遗憾的是，我没有声明监听器在全球范围内，而是在onCreateView中声明。这是因为我听了Android Studio告诉我将监听器转换为本地变量
小开

Kotlin代码，用于注册SharedPreferenceChangeListener，它检测何时将发生在保存的键上的变化:

  PreferenceManager.getDefaultSharedPreferences(this)
.registerOnSharedPreferenceChangeListener { sharedPreferences, key ->
if(key=="language") {
//Do Something
}
}

你可以把这个代码放在onStart()，或其他地方.. *考虑你必须使用

 if(key=="YourKey")

或者你的代码在“//Do Something”块将错误地运行每一个变化，将发生在任何其他键在sharedPreferences


提交答案