在Android开发中,经常需要将少量简单类型数据保存在本地,如:用户设置。这些需要保存的数据可能一两个字符串,像这样的数据一般选择使用SharedPreferences来保存。
SharedPreferences:一个轻量级的存储类,特别适合用于保存软件配置参数。(是用xml文件存放数据,文件存放在/data/data/<package name>/shared_prefs目录下)
SharedPreferences可以保存的数据类型有:int、boolean、float、long、String、StringSet。
保存数据一般分为四个步骤:
读取数据一般分为两个步骤:
public abstract SharedPreferences getSharedPreferences (String name, int mode)
参数 name:命名 mode:模式,包括 MODE_PRIVATE(只能被自己的应用程序访问) MODE_WORLD_READABLE(除了自己访问外还可以被其它应该程序读取) MODE_WORLD_WRITEABLE(除了自己访问外还可以被其它应该程序读取和写入)
若该Activity只需要创建一个SharedPreferences对象的时候,可以使用getPreferences方法,不需要为SharedPreferences对象命名,只要传入参数mode即可
public SharedPreferences getPreferences (int mode)
abstract SharedPreferences.Editor edit()
//写入boolean类型的数据
abstract SharedPreferences.Editor putBoolean(String key, boolean value)
//写入float类型的数据
abstract SharedPreferences.Editor putFloat(String key, float value)
//写入int类型的数据
abstract SharedPreferences.Editor putInt(String key, int value)
//写入long类型的数据
abstract SharedPreferences.Editor putLong(String key, long value)
//写入String类型的数据
abstract SharedPreferences.Editor putString(String key, String value)
//写入Set<String>类型的数据
abstract SharedPreferences.Editor putStringSet(String key, Set<String> values)
参数 key:指定数据对应的key value:指定的值
abstract SharedPreferences.Editor remove(String key)
参数 key:指定数据的key
abstract SharedPreferences.Editor clear()
abstract boolean commit()
//读取所有数据
abstract Map<String, ?> getAll()
//读取的数据为boolean类型
abstract boolean getBoolean(String key, boolean defValue)
//读取的数据为float类型
abstract float getFloat(String key, float defValue)
//读取的数据为int类型
abstract int getInt(String key, int defValue)
//读取的数据为long类型
abstract long getLong(String key, long defValue)
//读取的数据为String类型
abstract String getString(String key, String defValue)
//读取的数据为Set<String>类型
abstract Set<String> getStringSet(String key, Set<String> defValues)
参数 key:指定数据的key defValue:当读取不到指定的数据时,使用的默认值defValue
看烦了这些方法?别着急,,,代码来了
/**
* 保存用户信息
*/
private void saveUserInfo(){
SharedPreferences userInfo = getSharedPreferences(PREFS_NAME, MODE_PRIVATE);
SharedPreferences.Editor editor = userInfo.edit();//获取Editor
//得到Editor后,写入需要保存的数据
editor.putString("username", "一只猫的涵养");
editor.putInt("age", 20);
editor.commit();//提交修改
Log.i(TAG, "保存用户信息成功");
}
/**
* 读取用户信息
*/
private void getUserInfo(){
SharedPreferences userInfo = getSharedPreferences(PREFS_NAME, MODE_PRIVATE);
String username = userInfo.getString("username", null);//读取username
int age = userInfo.getInt("age", 0);//读取age
Log.i(TAG, "读取用户信息");
Log.i(TAG, "username:" + username + ", age:" + age);
}
/**
* 移除年龄信数据
*/
private void removeUserInfo(){
SharedPreferences userInfo = getSharedPreferences(PREFS_NAME, MODE_PRIVATE);
SharedPreferences.Editor editor = userInfo.edit();//获取Editor
editor.remove("age");
editor.commit();
Log.i(TAG, "移除年龄数据");
}
/**
* 清空数据
*/
private void clearUserInfo(){
SharedPreferences userInfo = getSharedPreferences(PREFS_NAME, MODE_PRIVATE);
SharedPreferences.Editor editor = userInfo.edit();//获取Editor
editor.clear();
editor.commit();
Log.i(TAG, "清空数据");
}
这里将SharedPreferences简单的用法都列举了出来。
api中还注册和注销SharedPreferences被编辑时的监听
SharedPreferences.OnSharedPreferenceChangeListener changeListener = new OnSharedPreferenceChangeListener() {
@Override
public void onSharedPreferenceChanged(SharedPreferences preferences, String key) {
//preferences被 编辑的SharedPreferences实例
//该SharedPreferences中被编辑的条目所对应的key
}
};
//userInfo注册监听事件
userInfo.registerOnSharedPreferenceChangeListener(changeListener);
//userInfo注销监听事件
userInfo.unregisterOnSharedPreferenceChangeListener(changeListener);
getSharedPreferences (String name, int mode)
getPreferences (int mode)
MODE_PRIVATE
都是在Acitivty中执行的。若不在Activity中,请使用
context.getSharedPreferences (String name, int mode)
context.getPreferences (int mode)
Conetxt.MODE_PRIVATE
editor.putInt("age", 20);
//覆盖key为age的数据,得到的结果:age = 32
editor.putInt("age", 32);
editor.putString("age", "20");
//覆盖key为age的数据,得到的结果:age = 32 (int类型)
editor.putInt("age", 32);
editor.putInt("age", 32);//保存为int类型
String age = userInfo.getString("age", "null");//读取时为String类型,出现异常
editor.putInt("age", 20);//写入操作
editor.remove("age"); //移除操作
editor.clear(); //清空操作
editor.commit();//记得commit
import android.app.Activity;
import android.content.Context;
import android.content.SharedPreferences;
import android.os.Bundle;
import android.util.Log;
/**
* SharedPreferences用法 测试Activity
* @author Gavin
*
*/
public class MainActivity extends Activity {
private static final String TAG = "SharedPreferencesTest";
/**
* 保存数据SharedPreferences文件的名字
*/
private final String PREFS_NAME = "MyPrefsFile";
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
saveUserInfo();
getUserInfo();
removeUserInfo();
getUserInfo();
clearUserInfo();
getUserInfo();
}
/**
* 保存用户信息
*/
private void saveUserInfo(){
SharedPreferences userInfo = getSharedPreferences(PREFS_NAME, MODE_PRIVATE);
SharedPreferences.OnSharedPreferenceChangeListener changeListener = new OnSharedPreferenceChangeListener() {
@Override
public void onSharedPreferenceChanged(SharedPreferences preferences, String key) {
//preferences被 编辑的SharedPreferences实例
//该SharedPreferences中被编辑的条目所对应的key
}
};
//userInfo注册监听事件
userInfo.registerOnSharedPreferenceChangeListener(changeListener);
SharedPreferences.Editor editor = userInfo.edit();//获取Editor
//得到Editor后,写入需要保存的数据
editor.putString("username", "一只猫的涵养");
editor.putInt("age", 20);
editor.commit();//提交修改
Log.i(TAG, "保存用户信息成功");
}
/**
* 读取用户信息
*/
private void getUserInfo(){
SharedPreferences userInfo = getSharedPreferences(PREFS_NAME, MODE_PRIVATE);
String username = userInfo.getString("username", null);//读取username
int age = userInfo.getInt("age", 0);//读取age
Log.i(TAG, "读取用户信息");
Log.i(TAG, "username:" + username + ", age:" + age);
}
/**
* 移除年龄信数据
*/
private void removeUserInfo(){
SharedPreferences userInfo = getSharedPreferences(PREFS_NAME, MODE_PRIVATE);
SharedPreferences.Editor editor = userInfo.edit();//获取Editor
editor.remove("age");
editor.commit();
Log.i(TAG, "移除年龄数据");
}
/**
* 清空数据
*/
private void clearUserInfo(){
SharedPreferences userInfo = getSharedPreferences(PREFS_NAME, MODE_PRIVATE);
SharedPreferences.Editor editor = userInfo.edit();//获取Editor
editor.clear();
editor.commit();
Log.i(TAG, "清空数据");
}
}
得到log:
log
参考: google开发者文档 http://www.cnblogs.com/linjiqin/archive/2011/05/26/2059133.html