SharedPreferences.onSharedPreferenceChangeListener n'est pas appelé de manière cohérente

Question

J'enregistre un écouteur de changement de préférence comme ceci (dans le fichier onCreate() de mon activité principale) :

SharedPreferences prefs = PreferenceManager.getDefaultSharedPreferences(this);

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

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

Le problème est que l'écouteur n'est pas toujours appelé. Il fonctionne les premières fois qu'une préférence est modifiée, puis il n'est plus appelé jusqu'à ce que je désinstalle et réinstalle l'application. Le redémarrage de l'application ne semble pas résoudre le problème.

J'ai trouvé une liste de diffusion filetage rapportant le même problème, mais personne ne lui a vraiment répondu. Qu'est-ce que je fais de mal ?

Answer 1

Il est sournois. SharedPreferences conserve les écouteurs dans une WeakHashMap. Cela signifie que vous ne pouvez pas utiliser une classe interne anonyme comme écouteur, car elle deviendra la cible de la collecte des déchets dès que vous quitterez la portée actuelle. Elle fonctionnera au début, mais finira par faire l'objet d'un ramassage, sera supprimée de la WeakHashMap et cessera de fonctionner.

Gardez une référence à l'écouteur dans un champ de votre classe et tout ira bien, à condition que l'instance de votre classe ne soit pas détruite.

c'est-à-dire au lieu de :

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

faites-le :

// 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);

La raison pour laquelle le désenregistrement dans la méthode onDestroy résout le problème est que pour ce faire, vous avez dû enregistrer l'écouteur dans un champ, ce qui a empêché le problème. C'est l'enregistrement de l'écouteur dans un champ qui résout le problème, pas le désenregistrement dans la méthode onDestroy.

UPDATE : La documentation Android a été actualisé con avertissements sur ce comportement. Donc, le comportement bizarre demeure. Mais maintenant c'est documenté.

Answer 2

Cette réponse acceptée est correcte, car pour moi, elle est en train de créer nouvelle instance chaque fois que l'activité reprend

alors comment conserver la référence à l'écouteur dans l'activité ?

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

et dans vos onResume et onPause

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

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

}

Ceci est très similaire à ce que vous faites, sauf que nous maintenons une référence dure.

Answer 3

Comme il s'agit de la page la plus détaillée sur le sujet, je souhaite ajouter mes 50ct.

J'ai eu le problème que le OnSharedPreferenceChangeListener n'était pas appelé. Mes SharedPreference sont récupérées au début de l'activité principale par :

prefs = PreferenceManager.getDefaultSharedPreferences(this);

Mon code PreferenceActivity est court et ne fait rien d'autre que d'afficher les préférences :

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

Chaque fois que l'on appuie sur le bouton de menu, je crée la PreferenceActivity à partir de l'activité principale :

@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;
}

Note que l'enregistrement du OnSharedPreferenceChangeListener doit être fait APRES la création de la PreferenceActivity dans ce cas, sinon le Handler dans l'activité principale ne sera pas appelé !!! Il m'a fallu un certain temps pour réaliser cela...

Answer 4

Assurez-vous que vous désenregistrez le listener (par exemple, dans la section onDestroy() ).

De plus, vous pourriez vouloir passer à l'utilisation de android.util.Log au lieu de System.out pour votre enregistrement.

En dehors de cela, je ne vois rien de mal à ce que vous avez.

Answer 5

En lisant les données lisibles par le mot partagées par la première application, nous devons

Remplacer

getSharedPreferences("PREF_NAME", Context.MODE_PRIVATE);

con

getSharedPreferences("PREF_NAME", Context.MODE_MULTI_PROCESS);

dans la deuxième application pour obtenir la valeur mise à jour dans la deuxième application.

Mais cela ne fonctionne toujours pas...