問題再現
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(); }
(后略)