Android 数据存储--- SharedPreferences

SharedPreferences

简介

为了保存软件的设置参数，Android平台为我们提供了一个SharedPreferences接口，它是一个轻量级的存储类，特别适合用于保存软件配置参数。使用SharedPreferences保存数据，其背后是用xml文件存放数据，文件存放在/data/data//shared_prefs目录下。

获取对象的方法

1. getSharedPreferences

SharedPreferences pre = Context.getSharedPreferences(String name,int mode);

name:
本组件的配置文件名(自定义)，当这个文件不存在时，直接创建，如果已经存在，则直接使用（如果想要与本应用程序的其他组件共享此配置文件，可以用这个名字来检索到这个配置文件，在这里要特别注意，因为在Android中已经确定了SharedPreferences是以xml形式保存，所以，在填写文件名参数时，不要给定“.xml”后缀，android会自动添加。只要直接写上文件名即可。它会直接被保存在/data/data//shared_prefs路径下，它是采用键值对的形式保存参数。当你需要获得某个参数值时，按照参数的键索引即可）。
mode:
mode为操作模式，默认的模式为0或MODE_PRIVATE，还可以使用MODE_APPEND、MODE_WORLD_READABLE和MODE_WORLD_WRITEABLE。

• MODE_PRIVATE，则该配置文件只能被自己的应用程序访问
• MODE_WORLD_READABLE，则该配置文件除了自己访问外还可以被其它应该程序读取
• MODE_WORLD_WRITEABLE，则该配置文件除了自己访问外还可以被其它应该程序读取和写入

2. getPreferences

SharedPreferences pre = Activity.getPreferences(int mode);

这个方法默认使用当前类不带包名的类名作为文件的名称。配置文件仅可以被调用的Activity使用

3. getDefaultSharedPreferences

SharedPreferences pre = PreferenceManager.getDefaultSharedPreferences(Context);

每个应用都有一个默认的配置文件preferences.xml，使用getDefaultSharedPreferences获取.

使用方法

SharedPreferences使用非常简单，能够轻松地存放数据和读取数据。SharedPreferences只能保存简单类型的数据，例如：String、int等。一般会将复杂类型的数据转换成Base64编码，然后将转换后的数据以字符串的形式保存在XML文件中，再用SharedPreferences保存。

存储

使用SharedPreferences保存key-value对的步骤如下：

1. 打开名为configuration的配置文件，如果存在则打开它，否则创建新的名为configuration的配置文件

SharedPreferences sharedPreferences = getSharedPreferences("configuration", 0);

2. 让sharedPreferences处于编辑状态

SharedPreferences.Editor editor = sharedPreferences.edit();

3. 存放数据

editor.putString("name"，"harvey");

4. 完成提交

editor.commit();

注：

editor.commit()与editor.apply()的区别
相同点：

1.二者都可提交preference的修改数据

2.二者都是原子操作

区别：

1.apply没有返回值而commit返回boolean表明修改是否提交成功

2.apply是将修改数据原子提交到内存，而后异步真正提交到硬件磁盘；而commit是同步的提交到硬件磁盘，因此，在多个并发的提交commit的时候，他们会等待正在处理的commit保存到磁盘后在操作，从而降低了效率。而apply只是原子的提交到内容，后面有调用apply的函数的将会直接覆盖前面的内存数据，这样从一定程度上提高了很多效率。

3.apply方法不会提示任何失败的提示。

总结:

由于在一个进程中，sharedPreference是单实例，一般不会出现并发冲突，如果对提交的结果不关心的话，建议使用apply，当然需要确保提交成功且有后续操作的话，还是需要用commit的。

读取

1. 打开名为configuration的配置文件

SharedPreferences sharedPreferences = getSharedPreferences("configuration", 0);

2. 获取数据

String name = sharedPreferences.getString("name","默认值");

三种创建对象方式的区别

getSharedPreferences 与 getPreferences

getSharedPreferences 是Context类中的方法，可以指定file name以及 mode。

getPreferences是Activity类中的方法，只需指定mode。

getSharedPreferences 与getDefaultSharedPreferences

getSharedPreferences：自定义的一些偏好设置用getSharedPreferences来获取
getDefaultSharedPreferences：每个应用有一个默认的偏好文件preferences.xml，使用getDefaultSharedPreferences获取

访问其他应用的SharedPreferences

访问其他应用中的Preference前提条件：该preference创建时指定了Context.MODE_WORLD_READABLE或者Context.MODE_WORLD_WRITEABLE权限。

例：有个为cn.yang.action的应用使用下面语句创建了preference：

getSharedPreferences("TEST", Context.MODE_WORLD_READABLE);

其他应用要访问上面应用的preference，首先需要创建上面应用的Context，然后通过Context访问preference，访问preference时会在应用所在包下的shared_prefs目录找到preference：

Context otherAppsContext = createPackageContext("cn.yang.action", Context.CONTEXT_IGNORE_SECURITY);
SharedPreferences sharedPreferences = otherAppsContext.getSharedPreferences("TEST", Context.MODE_WORLD_READABLE);
String name = sharedPreferences.getString("name", "");
int age = sharedPreferences.getInt("sex", "");

如果不通过创建Context访问其他应用的preference，也可以读取xml文件方式直接访问其他应用preference对应的xml文件：

//<package name>应替换成应用的包名
File xmlFile = new File(“/data/data/<package name>/shared_prefs/itcast.xml”);

SharedPreferences工具类

相信Android的这个最简单的存储方式大家都很熟悉了，但是有一个小小技巧，也许你没有用过，今天就跟大家分享一下，我们可以把SharedPreferences封装在一个工具类中，当我们需要写数据和读数据的时候，就可以直接通过工具类的set和get方法来完成，类似JavaBean，这样使用起来就比较方便，建议项目中使用次数比较多使用。

public class SharePreferenceUtil {
 
    private SharedPreferences sp;
    private SharedPreferences.Editor editor;
 
    //这里可以使用自定义Application类代替构造函数 很方便
    public SharePreferenceUtil(Context context, String file) {
        sp = context.getSharedPreferences(file, context.MODE_PRIVATE);
        editor = sp.edit();
    }
 
    // 用户的密码
    public void setPasswd(String passwd) {
        editor.putString("passwd", passwd);
        editor.commit();
    }
 
    public String getPasswd() {
        return sp.getString("passwd", "");
    }
 
    // 用户的id，即QQ号
    public void setId(String id) {
        editor.putString("id", id);
        editor.commit();
    }
 
    public String getId() {
        return sp.getString("id", "");
    }
 
    // 用户的昵称
    public String getName() {
        return sp.getString("name", "");
    }
 
    public void setName(String name) {
        editor.putString("name", name);
        editor.commit();
    }
 
    // 用户的邮箱
    public String getEmail() {
        return sp.getString("email", "");
    }
 
    public void setEmail(String email) {
        editor.putString("email", email);
        editor.commit();
    }
 
    // 用户自己的头像
    public Integer getImg() {
        return sp.getInt("img", 0);
    }
 
    public void setImg(int i) {
        editor.putInt("img", i);
        editor.commit();
    }
 
    // ip
    public void setIp(String ip) {
        editor.putString("ip", ip);
        editor.commit();
    }
 
    public String getIp() {
        return sp.getString("ip", Constants.SERVER_IP);
    }
 
    // 端口
    public void setPort(int port) {
        editor.putInt("port", port);
        editor.commit();
    }
 
    public int getPort() {
        return sp.getInt("port", Constants.SERVER_PORT);
    }
 
    // 是否在后台运行标记
    public void setIsStart(boolean isStart) {
        editor.putBoolean("isStart", isStart);
 
        editor.commit();
    }
 
    public boolean getIsStart() {
        return sp.getBoolean("isStart", false);
    }
 
    // 是否第一次运行本应用
    public void setIsFirst(boolean isFirst) {
        editor.putBoolean("isFirst", isFirst);
 
        editor.commit();
    }
 
    public boolean getisFirst() {
        return sp.getBoolean("isFirst", true);
    }
}

第二种方法是更加简单方便：取值时只用传入context和对应的key，就能获取到对应的value；设值时，也是传入context和对应key和value即可，非常方便实用。

public class PreferenceUtils {
 
    public static String getPrefString(Context context, String key,
        final String defaultValue) {
        final SharedPreferences settings = PreferenceManager.getDefaultSharedPreferences(context);
        return settings.getString(key, defaultValue);
    }
 
    public static void setPrefString(Context context, final String key,
        final String value) {
        final SharedPreferences settings = PreferenceManager.getDefaultSharedPreferences(context);
        settings.edit().putString(key, value).commit();
    }
 
    public static boolean getPrefBoolean(Context context, final String key,
        final boolean defaultValue) {
        final SharedPreferences settings = PreferenceManager.getDefaultSharedPreferences(context);
        return settings.getBoolean(key, defaultValue);
    }
 
    public static boolean hasKey(Context context, final String key) {
        return PreferenceManager.getDefaultSharedPreferences(context).contains(key);
    }
 
    public static void setPrefBoolean(Context context, final String key,
        final boolean value) {
        final SharedPreferences settings = PreferenceManager.getDefaultSharedPreferences(context);
        settings.edit().putBoolean(key, value).commit();
    }
 
    public static void setPrefInt(Context context, final String key,
        final int value) {
        final SharedPreferences settings = PreferenceManager.getDefaultSharedPreferences(context);
        settings.edit().putInt(key, value).commit();
    }
 
    public static int getPrefInt(Context context, final String key,
        final int defaultValue) {
        final SharedPreferences settings = PreferenceManager.getDefaultSharedPreferences(context);
        return settings.getInt(key, defaultValue);
    }
 
    public static void setPrefFloat(Context context, final String key,
        final float value) {
        final SharedPreferences settings = PreferenceManager.getDefaultSharedPreferences(context);
        settings.edit().putFloat(key, value).commit();
    }
 
    public static float getPrefFloat(Context context, final String key,
        final float defaultValue) {
        final SharedPreferences settings = PreferenceManager.getDefaultSharedPreferences(context);
        return settings.getFloat(key, defaultValue);
    }
 
    public static void setSettingLong(Context context, final String key,
        final long value) {
        finalSharedPreferencessettings = PreferenceManager.getDefaultSharedPreferences(context);
        settings.edit().putLong(key, value).commit();
    }
 
    public static long getPrefLong(Context context, final String key,
        final long defaultValue) {
        final SharedPreferences settings = PreferenceManager.getDefaultSharedPreferences(context);
        return settings.getLong(key, defaultValue);
    }
 
    public static void clearPreference(Context context,
        final SharedPreferences p) {
        final Editor editor = p.edit();
        editor.clear();
        editor.commit();
    }
}