OnSharedPreferenceChangeListener详解及出现不触发解决办法

之前使用onsharedpreferencechangelistener，遇到了点小问题，就是有些时候onsharedpreferencechangelistener没有被触发。最近花了点时间研究了一下，小做整理。本文将会介绍监听器不被触发的原因，解决方法，以及其中隐含的一些技术细节。

问题再现

onsharedpreferencechangelistener是android中sharedpreference文件发生变化的监听器。通常我们想要进行监听，会实现如下的代码。

protected void oncreate(bundle savedinstancestate) {
 preferencemanager.getdefaultsharedpreferences(getapplicationcontext())
  .registeronsharedpreferencechangelistener(new onsharedpreferencechangelistener() {
  @override
  public void onsharedpreferencechanged(
   sharedpreferences sharedpreferences, string key) {
   log.i(logtag, "testonsharedpreferencechangedwrong key =" + key);
  }
 });
}

这种写法看上去没有什么问题，而且很多时候开始几次onsharedpreferencechanged方法也可以被调用。但是过一段时间（简单demo不容易出现，但是使用ddms中的gc会立刻导致接下来的问题），你会发现前面的方法突然不再被调用，进而影响到程序的处理。

原因剖析

简而言之，就是你注册的监听器被移除掉了。
首先我们先了解一下registeronsharedpreferencechangelistener注册的实现。

private final weakhashmap<onsharedpreferencechangelistener, object> mlisteners =
   new weakhashmap<onsharedpreferencechangelistener, object>();
//some code goes here
public void more ...registeronsharedpreferencechangelistener(onsharedpreferencechangelistener listener) {
 synchronized(this) {
  mlisteners.put(listener, mcontent);
 }
}

从上面的代码可以得知，一个onsharedpreferencechangelistener对象实际上是放到了一个weakhashmap的容器中，执行完示例中的oncreate方法，这个监听器对象很快就会成为垃圾回收的目标，由于放在weakhashmap中作为key不会阻止垃圾回收，所以当监听器对象被回收之后，这个监听器也会从mlisteners中移除。所以就造成了onsharedpreferencechanged不会被调用。

关于weakhashmap相关，请阅读译文：理解java中的弱引用进而更多了解。

如何解决

改为对象成员变量（推荐）

将监听器作为activity的一个成员变量，在activity的onresume进行注册，在onpause时进行注销。推荐在这两个activity生命周期中进行处理，尤其是当sharedpreference值发生变化后，对activity展示的ui进行处理操作的情况。这种方法是最推荐的解决方案。

private onsharedpreferencechangelistener mlistener = new onsharedpreferencechangelistener() {

 @override
 public void onsharedpreferencechanged(
  sharedpreferences sharedpreferences, string key) {
  log.i(logtag, "instance variable key=" + key);
 }
};

@override
protected void onresume() {
 preferencemanager.getdefaultsharedpreferences(getapplicationcontext()).registeronsharedpreferencechangelistener(mlistener);
 super.onresume();
}

@override
protected void onpause() {
 preferencemanager.getdefaultsharedpreferences(getapplicationcontext()).unregisteronsharedpreferencechangelistener(mlistener);
 super.onpause();
}

改为静态变量（不推荐）

如下，将一个指向匿名的内部类对象的变量slistener使用static修饰，这个内部类对象则不会持有外部类的引用。
但是这种做法并不推荐，因为一个静态变量和与外部实例不相关，我们很难和外部实例进行一些操作。

private static onsharedpreferencechangelistener slistener = new onsharedpreferencechangelistener() {
 @override
 public void onsharedpreferencechanged(
  sharedpreferences sharedpreferences, string key) {
  log.i(logtag, "static variable key=" + key);
 }
};

为什么这样设计

可能会有人认为这是系统设计的猫腻或者bug，其实不然，这正是android设计人员的高明之处。

正如我们示例的代码一样，将一个（隐式的）局部变量添加到监听器容器中，如果该容器只是一个普通的hashmap，这样会导致内存泄露，因为该容器还有局部变量指向的对象，该对象又隐式持有外部activity的对象，导致activity无法被销毁。关于非静态内部类持有隐式持有外部类引用，请参考细话java：”失效”的private修饰符

除此之外，因为局部变量无法在其所在方法外部访问，这样就导致了我们只可以使用方法中使用局部变量就行注册，在合适的时机却无法使用局部变量进行注销。

以上就是对 android onsharedpreferencechangelistener的介绍，以及出现问题解决办法，谢谢大家对本站的支持！