How to resolve SharedPreference error in android?

Question

I have an app in which I am storing some values in shared preference but when I inspect code then it give

SharedPreferences.edit() without a corresponding commit() or apply() call.

How to resolve this warning.

For Shared preference I am using code mentioned below:-

private SharedPreferences m_Preference;
private SharedPreferences.Editor m_Editor;

m_Preference = context.getSharedPreferences(CStaticVar.DEAL_DOWNLOADED,Context.MODE_PRIVATE);
m_Editor = m_Preference.edit();
                    m_Editor.putInt("dealDonloadedcount",0);
                    m_Editor.apply();

which android version are you using? the alert you posted is an error or an alert? — Pier Giorgio Misley, Sep 30 '16 at 09:25
@Rakesh looks like chaining stopped working. You can split it to declaration of editor; adding values; applying the changes - 3 lines. — deadfish, Nov 07 '21 at 09:48

score 0 · Answer 1 · answered Sep 30 '16 at 09:13

0

In order to make changes to shared preferences you need to call

commit()

method.

Example(from Android official documentation)

SharedPreferences sharedPref = getActivity().getPreferences(Context.MODE_PRIVATE);
SharedPreferences.Editor editor = sharedPref.edit();
editor.putInt(getString(R.string.saved_high_score), newHighScore);
editor.commit();

More in Android official documentation: https://developer.android.com/training/basics/data-storage/shared-preferences.html

answered Sep 30 '16 at 09:13

Rafal

292
2
10

but I am using apply() – Rakesh Sep 30 '16 at 09:16
@Rakesh mybe this is only warning from Lint ? Did you tried to refresh project and clean Lint errors and build it again ? – Rafal Sep 30 '16 at 09:18
as `commit()` method takes time to make changes, you can use `apply()` for making an instant save for **Shared Preferences**. – Sarbjit Singh Sep 30 '16 at 09:18
just for a note, apply more than instant is in background. it immediatly saves and it commit to disk in background – Pier Giorgio Misley Sep 30 '16 at 09:20

score 0 · Answer 2 · answered Sep 30 '16 at 09:21

Create a class PreferencesHelper.java

public class PreferencesHelper {

    private SharedPreferences sharedPreferences;
    private SharedPreferences.Editor editor;

    public PreferencesHelper(Context context) {
        this.sharedPreferences = context.getSharedPreferences("MyPreference", 0);
        this.editor = sharedPreferences.edit();
    }

    public String GetPreferences(String key) {
        return sharedPreferences.getString(key, "");
    }

    public void SavePreferences(String key, String value) {
        editor.putString(key, value);
        editor.commit();
    }
}

Then you can use the below code in your activity

PreferencesHelper pref = new PreferencesHelper(YourActivity.this);
//To Save Preferences
pref.SavePreferences("key",value);
//To Get Preferences
pref.GetPreferences("key");

@Rakesh pref.SavePreferences("key", String.valueOf(int value)); — Mridul S Kumar, Sep 30 '16 at 09:37

score 0 · Answer 3 · answered Nov 07 '18 at 22:26

I created the PreferencesHelper class proposed by Mridul S Kumar here but, for some reason, the warning was still showing up. To ignore the message with @SuppressLint("CommitPrefEdits") was my last resort. That's why I dug a little deeper and I tried the approach mentioned in this post and found out that the message was gone.

So I realized that the solution is to call the apply() method inside the method where the editor instance variable is initialized, without using "this" (I don't recommend you use commit() because then Android will advise you, with another warning, to consider using apply() instead, on the grounds that "commit writes its data to persistent storage, whereas apply will handle it in the background").

I'm not sure why, but what I do know is that there is no need to use it in this case, according to this post. The variable editor is not a reference to be disambiguated.

Therefore, the following code should solve your problem:

public class PreferencesHelper {
      private SharedPreferences sharedPreferences;
      private SharedPreferences.Editor editor;

      public PreferencesHelper(Context context) {
           this.sharedPreferences = context.getSharedPreferences("MyPreference", 0);
           this.editor = sharedPreferences.edit();

           boolean firstTime = sharedPreferences.getBoolean("first", true);
           if (firstTime) {
               editor.putBoolean("first", false);
               editor.apply();
           }
      }

      public String GetPreferences(String key) {
           return sharedPreferences.getString(key, "");
      }

      public void SavePreferences(String key, String value) {
           editor.putString(key, value);
           editor.commit();
      }
   }
}

I'm using Android 3.1.4, by the way.

score -1 · Answer 4 · answered Sep 30 '16 at 09:14

-1

because if you change in Shared Preference the You should commit() or apply(). otherwise no meaning of this. for removing warning click on yellow mark on that particular line and disable inspection.

answered Sep 30 '16 at 09:14

D.J

1,439
1
12
23

I didn't understand what you are trying to explain – Rakesh Sep 30 '16 at 09:16
it looks like accidently – Rakesh Sep 30 '16 at 09:25

score -1 · Answer 5 · answered Sep 30 '16 at 09:19

-1

use

editor.commit();

in place of

 editor.apply();

answered Sep 30 '16 at 09:19

Mahesh Gawhane

348
3
20

How to resolve SharedPreference error in android?

5 Answers5