一 简单介绍SharedPreferences
- SharedPreferences是Android平台上一个轻量级的存储类,是一种最容易理解和使用的存储技术,主要用于存储一些应用程序的配置参数,例如用户名.密码.自定义参数的设置等。
- 它是通过key/value(键值对)的形式将数据保存在XML文件中,该文件位于data/data/<packagename>/shared_prefs文件夹中。需要注意的是, SharedPreferences中的value值只能是Float.int.Long.Boolean.String.StringSet类型数据。接下来将针对SharedPreferences存储数据进行详细解说。
二 SharedPreferences数据的四种操作模式
- Context.MODE_PRIVATE:为默认操作模式,代表该文件是私有数据,只能被应用本身访问,在该模式下,写入的内容会覆盖原文件的内容。
- Context.MODE_APPEND:模式会检查文件是否存在,存在就往文件追加内容,否则就创建新文件。
- Context.MODE_WORLD_READABLE和Context.MODE_WORLD_WRITEABLE:用来控制其他应用是否有权限读写该文件。
三 使用SharedPreferences保存key/value的步骤
- 使用Activity类的getSharedPreferences方法获得SharedPreferences对象,其中存储key-value的文件名由getSharedPreferences方法的第一个参数指定。
- 使用SharedPreferences接口的edit获得SharedPreferences.Editor对象。
- 通过SharedPreferences.Editor接口的putXxx方法保存key-value对,其中Xxx表示不同的数据类型。例如:字符串类型的value需要用putString方法。
- 通过SharedPreferences.Editor接口的commit方法保存key-value对,commit方法相当于数据库事务中的提交操作。
四 存储数据与获取数据的示例代码
1. 存储数据
使用SharedPreferences类存储数据时,首先需要调用getSharedPreferences(String name,int mode)方法获取实例对象。由于该对象本身只能获取数据,不能对数据进行存储和修改,因此需要调用SharedPreferences的edit()方法获取到可编辑的Editer对象,最后通过该对象的putString()方法和putInt()方法存储数据。示例代码如下:
a. 打开Preferences,名称为setting,如果存在则打开它,否则创建新的Preferences
SharedPreferences userSettings = getSharedPreferences("setting", 0);
b.让setting处于编辑状态
SharedPreferences.Editor editor = userSettings.edit();
c.存入数据
editor.putString("name","aaa");
editor.putString("age","20");
d.提交修改
editor.commit();
从上述代码可以看出,Editor对象是以key/value的形式保存数据的,并且根据数据类型的不同,会调用不同的方法,需要注意的是,操作完数据后,一定要调用commit()方法进行数据提交,否则所以操作不生效。
如果需要删除数据,则只需要调用Editor对象的remove(String key)方法或者clear()方法即可,示例代码如下。
editor.remove("name"); //删除一条数据
editor.clear(); //删除所有数据
2. 获取数据
使用SharedPreferences类获取数据时非常简单,只需要获取到SharedPreferences对象,然后通过该对象的getxxx()方法获取到相应key的值即可。示例代码如下。
a.获取Preferences
SharedPreferences userSettings= getSharedPreferences("setting", 0);
b.获取数据
String name = userSettings.getString("name","bbb");
String age = userSettings.getString("age","21");
需要注意的是,getxxx()方法的第二个参数为缺省值,如果SP中不存在该key,将返回缺省值,例如getString("name",""),若name不存在,则key就返回空字符串。
五 使用SharedPreferences的注意事项
- 设置相应的权限:如果只供本程序或者有相同user id的程序使用 使用Context.MODE_PRIVATE权限;如果允许其它程序可读设置权限;如果允许其它程序可写设置相应权限;
- SharedPreferences保存的数据最好是基础数据类型(当然也可以用来保存用户配置,官方推荐PreferenceActivtiy )。 如果想让程序有多个preferences文件使用getSharedPreferences(xxx , xxx);如果想让程序只有一个preferences使用getPreferences()。
- SharedPreferences最好不要用来保存多个程序交互使用的共享数据,建议使用ContentProvider, BroadcastReceiver, and Service 来完成多个程序之间的数据共享。
六 SharedPreferences的简单封装
SharedPreferences读取数据时,会将整个xml放入内存中,当发生存放数据较大,或者当应用中有许多需要保存在SharedPreferences中的数据时,整个应用使用同一个SharedPreferences情况时就会影响读取速度,严重时造成卡顿,甚至是ANR,用户体验很差。 SharedPreferences的key定义也需要规范起来,不能使用的时候直接“xxx”这种情况,一旦复制粘贴keyName的时候多个空格或者少个字母就会引发严重后果,非常难发现。
为了解决上面的问题,这里整理了一些使用规范以及简单的封装。封装的核心目的:为了方便维护,对每个SharedPreferences中保存的key-value能快速了解使用。
举个例子:假如项目中,需要将用户的一些信息(name,age,sex,phone,isMarried)保存在SharedPreferences中。
1.创建SharedPreferences key的描述类
新建一个包,专门存放SharedPreferences相关的内容,可以更清晰地展现这个其保存的所有key。在新建的包下新建一个SpKeyUser类如下:
public class SpKeyUser {
/**
* 姓名
* valueType[String]
* 默认值:""
*/
public static final String NAME="name";
/**
* 姓名
* valueType[int]
* 默认值:0
*/
public static final String AGE="age";
/**
* 姓名
* valueType[String]
* 默认值:"man"
*/
public static final String SEX="sex";
/**
* 姓名
* valueType[String]
* 默认值:""
*/
public static final String PHONE="phone";
/**
* 姓名
* valueType[Boolean]
* 默认值:false
*/
public static final String IS_MARRIED="is_married";
}
2.创建SharedPreferences的帮助类
这个类主要作为各个SharedPreferences的生产工厂使用,并进一步提供简化的提交,获取值的方法。
public class SharedPreferencesHelper {
private static final String SP_NAME_USER = "sp_name_user";//用户相关的SP
/**
* 用户相关Sp
* 相关的key见{@link SpKeyUser}
*/
public static SharedPreferences getUserSp() {
return MyApplication.getInstances().getSharedPreferences(SP_NAME_USER, Context.MODE_PRIVATE);
}
/**
* 用户相关Sp
* 相关的key见{@link SpKeyDefault}
*/
public static SharedPreferences getDefaultSp() {
return PreferenceManager.getDefaultSharedPreferences(MyApplication.getInstances());
}
//sharedPreferences 是否为空
public static boolean isEmpty(SharedPreferences sp) {
return sp == null || sp.getAll() == null || 0 == sp.getAll().size();
}
/**
* 默认值为""
*/
public static String getString(SharedPreferences sp, String key) {
return sp.getString(key, Key.NIL);
}
/**
* 具有默认值
*
* @param defValue 默认值
*/
public static String getString(SharedPreferences sp, String key, String defValue) {
return sp.getString(key, defValue);
}
/**
* 默认值为0L
*/
public static long getLong(SharedPreferences sp, String key) {
return sp.getLong(key, 0L);
}
/**
* 默认值为0
*/
public static int getInt(SharedPreferences sp, String key) {
return sp.getInt(key, 0);
}
public static void setPreference(SharedPreferences sp, String key, int value) {
sp.edit().putInt(key, value).apply();
}
public static void setPreference(SharedPreferences sp, String key, String value) {
sp.edit().putString(key, value).apply();
}
public static void setPreference(SharedPreferences sp, String key, boolean value) {
sp.edit().putBoolean(key, value).apply();
}
//批量put数据
public static void setPreferenceWithList(SharedPreferences sp, List<SpItem> spItemList) {
if (sp == null || spItemList == null || spItemList.isEmpty()) {
return;
}
Editor spEditor = sp.edit();
for (SpItem item : spItemList) {
setSpItem(spEditor, item);
}
spEditor.apply();
}
public static void setPreference(SharedPreferences sp, String key, long value) {
sp.edit().putLong(key, value).apply();
}
/**
* 默认值为false
*/
public static boolean getBoolean(SharedPreferences sp, String key) {
return sp.getBoolean(key, false);
}
/**
* 自定义默认值
*/
public static boolean getBoolean(SharedPreferences sp, String key, boolean defValue) {
return sp.getBoolean(key, defValue);
}
/**
* 清除某一个key
*/
public static void remove(SharedPreferences sp, String key) {
if (sp == null || TextUtils.isEmpty(key)) {
return;
}
sp.edit().remove(key).apply();
}
//值类型(String:0,int:1,long:2,float:3,boolean:4)
private static final int VALUE_TYPE_STRING = 0;
private static final int VALUE_TYPE_INT = 1;
private static final int VALUE_TYPE_LONG = 2;
private static final int VALUE_TYPE_FLOAT = 3;
private static final int VALUE_TYPE_BOOLEAN = 4;
//Sp提交多个时使用,用于描述每个提交项
public static class SpItem<T> {
private String mKey;
private T mValue;
private int mValueType;
public SpItem(String key, T value) {
this.mKey = key;
this.mValue = value;
this.mValueType = initValueType(value);
}
private int initValueType(T t) {
int typ = -1;
if (t instanceof String) {
typ = VALUE_TYPE_STRING;
} else if (t instanceof Integer) {
typ = VALUE_TYPE_INT;
} else if (t instanceof Long) {
typ = VALUE_TYPE_LONG;
} else if (t instanceof Float) {
typ = VALUE_TYPE_FLOAT;
} else if (t instanceof Boolean) {
typ = VALUE_TYPE_BOOLEAN;
}
return typ;
}
}
//按类型put数据
private static void setSpItem(Editor spEditor, SpItem spItem) {
if (spItem == null || spEditor == null) {
return;
}
switch (spItem.mValueType) {
case VALUE_TYPE_STRING:
spEditor.putString(spItem.mKey, (String) spItem.mValue);
break;
case VALUE_TYPE_INT:
spEditor.putInt(spItem.mKey, (Integer) spItem.mValue);
break;
case VALUE_TYPE_LONG:
spEditor.putLong(spItem.mKey, (Long) spItem.mValue);
break;
case VALUE_TYPE_FLOAT:
spEditor.putFloat(spItem.mKey, (Float) spItem.mValue);
break;
case VALUE_TYPE_BOOLEAN:
spEditor.putBoolean(spItem.mKey, (Boolean) spItem.mValue);
break;
}
}
}
END
以上就是我对SharedPreferences的一些理解。
作者:余建武
原文地址:https://blog.youkuaiyun.com/qq_41936913/article/details/90729363