java - Android SharedPreferences 最佳实践

Question

在我一直在构建的应用程序中，我们相当依赖 SharedPreferences，这让我思考在访问 SharedPreferences 时什么是最佳实践。例如，许多人说访问它的适当方式是通过以下调用:

PreferenceManager.getDefaultSharedPreferences(Context context)

但是，这似乎很危险。如果您有一个依赖 SharedPreferences 的大型应用程序，则可能会出现 key 重复，尤其是在使用一些也依赖 SharedPreferences 的第三方库的情况下。在我看来，更好的使用方法是:

Context.getSharedPreferences(String name, int mode)

这样，如果您有一个严重依赖 SharedPreferences 的类，您可以创建一个仅由您的类使用的首选项文件。您可以使用类的完全限定名称来确保该文件很可能不会被其他人复制。

也基于这个 SO 问题:Should accessing SharedPreferences be done off the UI Thread? ，似乎访问 SharedPreferences 应该在 UI 线程之外完成，这是有道理的。

在 Android 开发人员的应用程序中使用 SharedPreferences 时，是否还有其他最佳做法应该注意？

Answer 1

我写了一篇小文章，也可以找到here .它描述了 SharedPreferences 是什么:

最佳实践:SharedPreferences

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

所有逻辑都只基于三个简单的类:

• SharedPreferences
• SharedPreferences.Editor
• SharedPreferences.OnSharedPreferenceChangeListener

共享首选项

SharedPreferences 是其中的主要部分。它负责获取(解析)存储的数据，提供获取Editor对象的接口(interface)和添加和删除OnSharedPreferenceChangeListener

的接口(interface)

• 要创建 SharedPreferences，您需要 Context 对象(可以是应用程序 Context)
• getSharedPreferences 方法解析 Preference 文件并为其创建 Map 对象

• 您可以在 Context 提供的几种模式下创建它。您应该始终使用 MODE_PRIVATE，因为所有其他模式自 API 级别 17 起都已弃用。

  // 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 是一个接口(interface)，用于修改 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();
  

性能与提示

• 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
  

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

• 您的偏好设置在应用程序更新后不会被删除。因此，在某些情况下，您需要创建一些迁移方案。例如，您有在应用程序启动时解析本地 JSON 的应用程序，要在第一次启动后执行此操作，您决定保存 boolean 标志 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();
    }
}