最佳实践：SharedPreferences

Android提供了许多存储应用程序数据的方法。其中一种方法将我们引向 SharedPreferences 对象，该对象用于将私有原始数据存储在键值对中。

所有逻辑仅基于三个简单的类：

SharedPreferences

SharedPreferences是其中的主要内容。它负责获取（解析）存储的数据，提供用于获取Editor对象和接口的接口，用于添加和删除OnSharedPreferenceChangeListener

要创建SharedPreferences，您需要Context个对象（可以是应用Context）
getSharedPreferences方法解析首选项文件并为其创建Map对象

您可以在Context提供的几种模式下创建它，强烈建议使用MODE_PRIVATE，因为创建世界可读/可写文件非常危险，并且可能会在应用程序中造成安全漏洞

// parse Preference file
SharedPreferences preferences = context.getSharedPreferences("com.example.app", Context.MODE_PRIVATE);

// get values from Map
preferences.getBoolean("key", defaultValue)
preferences.get..("key", defaultValue)

// you can get all Map but be careful you must not modify the collection returned by this
// method, or alter any of its contents.
Map<String, ?> all = preferences.getAll();

// get Editor object
SharedPreferences.Editor editor = preferences.edit();

//add on Change Listener
preferences.registerOnSharedPreferenceChangeListener(mListener);

//remove on Change Listener
preferences.unregisterOnSharedPreferenceChangeListener(mListener);

// listener example
SharedPreferences.OnSharedPreferenceChangeListener mOnSharedPreferenceChangeListener
    = new SharedPreferences.OnSharedPreferenceChangeListener() {
  @Override
  public void onSharedPreferenceChanged(SharedPreferences sharedPreferences, String key) {
  }
};

编辑

SharedPreferences.Editor是用于修改SharedPreferences对象中的值的接口。您在编辑器中进行的所有更改都是批处理的，在您调用commit（）或apply（）之前不会复制回原始SharedPreferences

使用简单的界面将值放入Editor
保存与commit()同步或与apply同步的值，这更快。实际上使用commit()使用不同的线程更安全。这就是为什么我更喜欢使用 commit() 。

使用remove()删除单个值或使用clear()

清除所有值

// get Editor object
SharedPreferences.Editor editor = preferences.edit();

// put values in editor
editor.putBoolean("key", value);
editor.put..("key", value);

// remove single value by key
editor.remove("key");

// remove all values
editor.clear();

// commit your putted values to the SharedPreferences object synchronously
// returns true if success
boolean result = editor.commit();

// do the same as commit() but asynchronously (faster but not safely)
// returns nothing
editor.apply();

表演＆amp;提示

SharedPreferences是一个Singleton对象，因此您可以轻松获取所需数量的引用，只有在您第一次调用getSharedPreferences时才打开文件，或者只创建一个它的参考。

// There are 1000 String values in preferences

SharedPreferences first = context.getSharedPreferences("com.example.app", Context.MODE_PRIVATE);
// call time = 4 milliseconds

SharedPreferences second = context.getSharedPreferences("com.example.app", Context.MODE_PRIVATE);
// call time = 0 milliseconds

SharedPreferences third = context.getSharedPreferences("com.example.app", Context.MODE_PRIVATE);
// call time = 0 milliseconds

由于SharedPreferences是一个Singleton对象，您可以更改其中的任何实例，而不必担心其数据会有所不同

first.edit().putInt("key",15).commit();

int firstValue = first.getInt("key",0)); // firstValue is 15
int secondValue = second.getInt("key",0)); // secondValue is also 15

第一次调用get方法时，它会按键解析值并将此值添加到地图中。因此，对于第二次调用，它只是从地图中获取它，而不进行解析。

first.getString("key", null)
// call time = 147 milliseconds

first.getString("key", null)
// call time = 0 milliseconds

second.getString("key", null)
// call time = 0 milliseconds

third.getString("key", null)
// call time = 0 milliseconds

请记住，Preference对象越大，get，commit，apply，remove和clear操作就越长。因此，强烈建议您将数据分成不同的小对象。

应用程序更新后，您的偏好设置将不会被删除。因此，有些情况下您需要创建一些迁移方案。例如，你有Application在应用程序启动时解析本地JSON，只有在第一次启动后才决定保存boolean flag wasLocalDataLoaded。一段时间后，您更新了JSON并发布了新的应用程序版本。用户将更新他们的应用程序但他们不会加载新的JSON，因为他们已经在第一个应用程序版本中完成了它。

public class MigrationManager {
 private final static String KEY_PREFERENCES_VERSION = "key_preferences_version";
 private final static int PREFERENCES_VERSION = 2;

 public static void migrate(Context context) {
     SharedPreferences preferences = context.getSharedPreferences("pref", Context.MODE_PRIVATE);
     checkPreferences(preferences);
 }

 private static void checkPreferences(SharedPreferences thePreferences) {
     final double oldVersion = thePreferences.getInt(KEY_PREFERENCES_VERSION, 1);

     if (oldVersion < PREFERENCES_VERSION) {
         final SharedPreferences.Editor edit = thePreferences.edit();
         edit.clear();
         edit.putInt(KEY_PREFERENCES_VERSION, currentVersion);
         edit.commit();
     }
 }
}

SharedPreferences存储在应用数据文件夹

中的xml文件中

// yours preferences
/data/data/YOUR_PACKAGE_NAME/shared_prefs/YOUR_PREFS_NAME.xml

// default preferences
/data/data/YOUR_PACKAGE_NAME/shared_prefs/YOUR_PACKAGE_NAME_preferences.xml

Android guide.

示例代码

public class PreferencesManager {

    private static final String PREF_NAME = "com.example.app.PREF_NAME";
    private static final String KEY_VALUE = "com.example.app.KEY_VALUE";

    private static PreferencesManager sInstance;
    private final SharedPreferences mPref;

    private PreferencesManager(Context context) {
        mPref = context.getSharedPreferences(PREF_NAME, Context.MODE_PRIVATE);
    }

    public static synchronized void initializeInstance(Context context) {
        if (sInstance == null) {
            sInstance = new PreferencesManager(context);
        }
    }

    public static synchronized PreferencesManager getInstance() {
        if (sInstance == null) {
            throw new IllegalStateException(PreferencesManager.class.getSimpleName() +
                    " is not initialized, call initializeInstance(..) method first.");
        }
        return sInstance;
    }

    public void setValue(long value) {
        mPref.edit()
                .putLong(KEY_VALUE, value)
                .commit();
    }

    public long getValue() {
        return mPref.getLong(KEY_VALUE, 0);
    }

    public void remove(String key) {
        mPref.edit()
                .remove(key)
                .commit();
    }

    public boolean clear() {
        return mPref.edit()
                .clear()
                .commit();
    }
}

Answer 2

Yakiv已经非常清楚地提到了关于偏好的一切。我只想补充一点。在共享首选项中编辑数据时，我们通常会这样做

mPref.edit()

每次都会创建一个SharedPreferences.Editor类型的新对象，这会导致内存中出现不必要的对象。因此，您也可以维护对编辑器对象的引用，并节省内存和对象创建时间以及相应的垃圾收集时间。

SharedPreferences的最佳实践

2 个答案:

最佳实践：SharedPreferences

SharedPreferences

编辑

表演＆amp;提示

示例代码