Android 浅析 SharedPreferences (一) 使用

发表于   |  

前言

Linus Benedict Torvalds : RTFSC – Read The Funning Source Code

概括

The SharedPreferences class provides a general framework that allows you to save and retrieve persistent key-value pairs of primitive data types. You can use SharedPreferences to save any primitive data: booleans, floats, ints, longs, and strings. This data will persist across user sessions (even if your application is killed).

翻译：
SharedPreferences类提供了一个通用的框架，允许你保存和检索原始数据类型的持久的键-值对。你可以使用SharedPreferences保存任何原始数据：布尔型，整型，漂浮，渴望，和字符串。此数据将持续整个用户周期（即使您的应用程序被杀害）。

使用

去使用SharedPreference有两个方法：

  • getSharedPreferences()：使用这个函数如果你需要多个preferences文件需在第一个参数指定的名称来区分。
  • getPreferences()：如果你只需要一个preferences文件，请使用此函数。因为这将是您的活动的唯一首选文件，您不需要提供名称。

写入SharedPreference

1
2
3
4
5
6
7
SharedPreferences preference = null;
preference = context.getSharedPreferences("text", 0);
SharedPreferences.Editor editor = preference.edit();
editor.putBoolean("silentMode", false);
editor.commit();

写入SharedPreferecen非常简单，首先是获取一个preference的实例对象，通过这个实例对象拿到Editor的引用，然后就可以传入想要传入的值，最后，再调用commit来完成。

获取SharedPreference

1
2
3
4
SharedPreferences preference = null;
preference = context.getSharedPreferences("text", 0);
boolean silent =  preference.getBoolean("silentMode", false);

获取SharedPreferecen也很容易，同样首先获取一个preference的实例对象，之后便可通过key直接获取想要获取的值了。

主要类

SharedPreferences

Interface for accessing and modifying preference data returned by getSharedPreferences(String, int). For any particular set of preferences, there is a single instance of this class that all clients share. Modifications to the preferences must go through an SharedPreferences.Editor object to ensure the preference values remain in a consistent state and control when they are committed to storage. Objects that are returned from the various get methods must be treated as immutable by the application.
翻译：
这是个接口类，给予从getSharedPreferences(String, int)函数访问和修改preference数据的功能。每个独立的preferences，这里都有一个唯一的接口类给所有客户端使用。修改preferences数据必须通过SharedPreferences接口。Editor对象保证preference值保持一致的状态和控制他们提交到存储里。从各种各样的get方法返回的对象必须由应用程序被视为不可变的。

注意：现在还不支持多进程安全，以后会添加。

内部类

Editor

Interface used for modifying values in a SharedPreferences object. All changes you make in an editor are batched, and not copied back to the original SharedPreferences until you call commit() or apply()
翻译：接口类用来在SharedPreferences对象里修改参数。所有的你做的修改都是批处理，并且不会复制回原来的SharedPreferences对象直到你调用commit() 或 apply()函数。

OnSharedPreferenceChangeListener

Interface definition for a callback to be invoked when a shared preference is changed.
翻译：接口类用来作为一个回调在一个preference被修改是调用。

内部主要方法：

SharedPreferences.edit()

创建一个新的Editor类型给这个preferences，通过这个你可以修改preferences的数据和自动提交这些修改到这个SharedPreferences对象。

注意：需要调用commit()在你每次通过Editor对SharedPreferences进行修改后。

SharedPreferences.Editor.commit()

提交你对于preferences的修改给SharedPreferences的对象。这会自动执行所要求的修改或者替换所有存在的SharedPreferences。

注意：如果同时提交，最后的提交动作会被执行。

SharedPreferences.Editor.apply()

功能跟commit() 函数一样。

不同：apply()会将它的preferences同步写出到持久存储，apply()会马上提交它的修改到内存中的SharedPreferences但会异步提交到硬盘并且你不会收到任何报错。如果其他editor在这个SharedPreferences也做了一个commit()当apply()正在写是，commit()将会被阻塞。