存储数据之SharedPreference-优快云博客

本文详细介绍了SharedPreferences类的功能和使用方法，包括如何保存和检索原始数据类型的永久性键值对，提供了具体的示例代码，以及一些实用的建议。

官方文档

SharePreferences类提供了一个通用框架，以便能够保存和检索原始数据类型的永久性键值对。你可以使用SharedPreferences来保存任何原始数据类型：boolean，float，int，long，char和String，这些数据将会永久保存。

要获取应用的应用的SharedPreferences对象，请使用一下两个方法：

getSharedPreferences()

如果您需要多个按名称（使用第一个参数指定）识别的首选项文件，请使用此方法。

getPreferences()

如果您只需要一个用于 Activity 的首选项文件，请使用此方法。由于这将是用于 Activity 的唯一首选项文件，因此无需提供名称。

写入值的话请按照以下步骤来：

调用 edit() 以获取 SharedPreferences.Editor。
使用 putBoolean() 和 putString() 等方法添加值。
使用 commit() 提交新值

要读取值，请使用 getBoolean() 和 getString() 等 SharedPreferences 方法。

以下是在计算器中保存静音按键模式首选项的示例：

public class Calc extends Activity {
    public static final String PREFS_NAME = "MyPrefsFile";

    @Override
    protected void onCreate(Bundle state){
       super.onCreate(state);
       . . .

       // Restore preferences
       SharedPreferences settings = getSharedPreferences(PREFS_NAME, 0);
       boolean silent = settings.getBoolean("silentMode", false);
       setSilent(silent);
    }

    @Override
    protected void onStop(){
       super.onStop();

      // We need an Editor object to make preference changes.
      // All objects are from android.context.Context
      SharedPreferences settings = getSharedPreferences(PREFS_NAME, 0);
      SharedPreferences.Editor editor = settings.edit();
      editor.putBoolean("silentMode", mSilentMode);

      // Commit the edits!
      editor.commit();
    }
}复制代码

SharedPreferences getPreferences (int mode)这个方法实际是对getSharedPreferences(String, int)方法的一个简单包装，传如参数默认为activity的类名。

SharedPreferences的使用方法

SharedPreferences是一个用于访问和修改用于访问和修改getSharedPreferences（String，int）返回的首选项数据的接口。对于任何特定的首选项集合，所有客户端共享此类的单个实例。对首选项的修改必须通过SharedPreferences.Editor对象进行，以确保首选项值保持在一致状态并在提交到存储时进行控制。从各种get方法返回的对象必须被应用程序视为不可变的。

注意：此类不支持在多个进程中使用。

boolean contains (String key)
返回在SharedPreferences中是否包含传入key的值。包含返回true，不包含返回false。

例如sp.contains("foo")，将会检查是否包含key值为foo的存储键值对是否存在。

2.SharedPreferences.Editor edit ()

获取SharedPreferences的编辑工具，获取方法为
SharedPreferences.Editor edit=sp.edit()

注意：你必须调用commit()方法才能将你的改变的值真正存入到sp中。

3.Map getAll ()
返回一个map类型的所有的键值对。

注意：你不能直接编辑这个map。

4.Set getStringSet (String key,
Set defValues)

这个方法将会返回一个set集合，同样你也不能直接编辑这个集合。

SharedPreferences.Editor的使用方法

1.void apply ()

将编辑器中的SharedPreferences更改提交给正在编辑的SharedPreferences对象。这将原子地执行所请求的修改，替换当前在SharedPreferences中的任何内容。

当使用两个editor同时编辑时，最后一个调用的editoer将会覆盖前边调用的editor结果。

此方法与commit不同，apply是将更改的内容立即提交到内存中的SharePreferences中，然后在异步任务中提交到磁盘存储，并且不会通知你是否成功或者失败。

假如此时一个编辑器执行常规的commit方法，而apply仍然未完成，则commit将会阻塞，等到apply完全完成才会执行commit。

由于SharedPreferences实例是进程内的单例，如果你不关心返回值，那么可以使用apply（）替换任何commit（）实例。

你不需要担心Android组件生命周期及其与apply（）写入磁盘的交互。该框架确保来自apply（）的在线磁盘写入在切换状态之前完成。

不建议直接实现SharedPreferences.Editor接口。然而，如果你以前实现它，并且现在得到关于缺少apply（）的错误，你可以简单地调用apply（）from commit（）。

SharedPreferences.Editor clear ()

在编辑器中标记以从首选项中删除所有值。一旦commit 被调用，唯一剩余的SharedPreferences将是您在此编辑器中定义的东西何。

注意，当提交SharedPreferences项时，无论是在此编辑器上放置方法之前还是之后调用clear，都会先清除。

3.boolean commit ()

将编辑器中的首选项更改提交回正在编辑的SharedPreferences对象。这将原子地执行所请求的修改，替换当前在SharedPreferences中的任何内容。

注意，当两个编辑器同时修改首选项时，最后一个editor会覆盖前一个editor的commit。

如果你不关心返回值，并且你从应用程序的主线程使用它，请考虑使用apply（）。

4.SharedPreferences.Editor remove (String key)

在editor中标记这个key的键值对将被删除，在commit中实际完成。

当提交给SharePreferences的时候，无论你在put之前还是之后调用，remvove都会先执行。

关于我自己的几点建议：

现在网上大部分教程或者utils中，将SharedPreferences写成一个单利模式，其实我个人不建议这样做，完全没有必要，editor的提交方法（apply和commit）都是原子操作，不会存在静态条件，同时官方文档也说明禁止在多线程中使用SharedPreferences。
有很多将Objec对象类存入SharedPreferences中的教程，我认为也没有必要，存入的本身就是键值对，要在一个值中存入一个对象有点不和厂里，也不建议这么做。