Android进阶——Sharedpreferences保存对象和图片等复杂类型的数据

引言

前面的一篇文章Android入门——数据存储之SharedPreferences详解与应用简单总结了下Sharedpreferences的基本语法和用法。虽然说通常我们都用Sharedpreferences保存轻量级的基本类型的数据，但是并不意味着Sharedpreference不能保存复杂的数据类型，比如说对象、图片等等。

一、保存和读取基本数据类型

1、保存基本类型的数据

/**
* 根据传入的prefereces的文件名设置指定key-valeu
*@param context
* @param preferenceName  SharedPreferences的name
* @param key 对应的Key键
* @param object 对应的各种类型的值
*/
public static void saveKeyValue(Context context, String preferenceName, String key, Object object){
SharedPreferences sharedPreferences=context.getSharedPreferences(preferenceName,context.MODE_PRIVATE);
SharedPreferences.Editor editor=sharedPreferences.edit();

if (object instanceof String) {
editor.putString(key, (String) object);
} else if (object instanceof Integer) {
editor.putInt(key, (Integer) object);
} else if (object instanceof Boolean) {
editor.putBoolean(key, (Boolean) object);
} else if (object instanceof Float) {
editor.putFloat(key, (Float) object);
} else if (object instanceof Long) {
editor.putLong(key, (Long) object);
} else {
editor.putString(key, object.toString());
}
editor.commit();
}

2、读取基本类型的数据

/**
* 根据传入的prefereces的文件名设置指定key-valeu
*@param context
* @param preferenceName  SharedPreferences的name
* @param key 对应的Key键
* @param object 对应的各种类型的值
*/
public static Object getValueByKey(Context context, String preferenceName,String key,Object object){
SharedPreferences sharedPreferences=context.getSharedPreferences(preferenceName,context.MODE_PRIVATE);
if (object instanceof String) {
return sharedPreferences.getString(key, (String) object);
} else if (object instanceof Integer) {
return sharedPreferences.getInt(key, (Integer) object);
} else if (object instanceof Boolean) {
return sharedPreferences.getBoolean(key, (Boolean) object);
} else if (object instanceof Float) {
return sharedPreferences.getFloat(key, (Float) object);
} else if (object instanceof Long) {
return sharedPreferences.getLong(key, (Long) object);
} else {
return sharedPreferences.getString(key, object.toString());
}
}

二、保存和读取图片

SharedPreferences原则上只能将字符串以key-value的形式保存， 但是万物皆二进制，所以我们可以采用编码的方式将任何二进制数据转化为字符串， 从而将可以将二进制数据保存在SharedPreferences文件中，而最常用的编码格式是Base64.

1、保存二进制数据

/**
* @param context
* @param preferenceName
* @param resId
* @param key
*/
public static void saveDrawable(Context context, String preferenceName,int resId,String key) {
SharedPreferences sharedPreferences=context.getSharedPreferences(preferenceName,context.MODE_PRIVATE);
SharedPreferences.Editor editor=sharedPreferences.edit();
Bitmap bitmap = BitmapFactory.decodeResource(context.getResources(), resId);
ByteArrayOutputStream baos = new ByteArrayOutputStream();
bitmap.compress(Bitmap.CompressFormat.PNG, 50, baos);
String imageBase64 = new String(Base64.encodeToString(baos.toByteArray(),Base64.DEFAULT));
editor.putString(key,imageBase64 );
editor.commit();
}

2、读取二进制数据

public static Drawable getDrawableByKey(Context context, String preferenceName,String key) {
SharedPreferences sharedPreferences=context.getSharedPreferences(preferenceName,context.MODE_PRIVATE);
String temp = sharedPreferences.getString(key, "");
ByteArrayInputStream bais = new ByteArrayInputStream(Base64.decode(temp.getBytes(), Base64.DEFAULT));
return Drawable.createFromStream(bais, "");
}

三、保存和读取序列化的对象

由于二进制数据经过编码后可以用SharedPreferences以字符串的形式存储，所以保存对象也成为了可能，但是这个类必须是可序列化即implements Serializable（实际上Serializable接口是个空接口，只是为了标记该对象是被序列化的），然后可以通过ObjectOutputStream保存再转为二进制存储。

1、保存序列化的对象

/**
* @param user
*/
public static void saveUser(Context context, String preferenceName,String key,User user) throws Exception {
if(user instanceof Serializable) {
SharedPreferences sharedPreferences = context.getSharedPreferences(preferenceName, context.MODE_PRIVATE);
SharedPreferences.Editor editor = sharedPreferences.edit();
ByteArrayOutputStream baos = new ByteArrayOutputStream();
try {
ObjectOutputStream oos = new ObjectOutputStream(baos);
oos.writeObject(user);//把对象写到流里
String temp = new String(Base64.encode(baos.toByteArray(), Base64.DEFAULT));
editor.putString(key, temp);
editor.commit();
} catch (IOException e) {
e.printStackTrace();
}
}else {
throw new Exception("User must implements Serializable");
}
}

2、读取序列化的对象

public static User getUser(Context context, String preferenceName,String key) {
SharedPreferences sharedPreferences=context.getSharedPreferences(preferenceName,context.MODE_PRIVATE);
String temp = sharedPreferences.getString(key, "");
ByteArrayInputStream bais =  new ByteArrayInputStream(Base64.decode(temp.getBytes(), Base64.DEFAULT));
User user = null;
try {
ObjectInputStream ois = new ObjectInputStream(bais);
user = (User) ois.readObject();
} catch (IOException e) {
}catch(ClassNotFoundException e1) {

}
return user;
}

当然Sharedpreferences也是可以存储各种集合类的比如说List，都可以通过转为ObjectOutputStream输出流进而编码存储：

public static String listToString(List<?> list)throws IOException {
// 实例化一个ByteArrayOutputStream对象，用来装载压缩后的字节文件。
ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
// 然后将得到的字符数据装载到ObjectOutputStream
ObjectOutputStream objectOutputStream = new ObjectOutputStream(
byteArrayOutputStream);
// writeObject 方法负责写入特定类的对象的状态，以便相应的 readObject 方法可以还原它
objectOutputStream.writeObject(list);
// 最后，用Base64.encode将字节文件转换成Base64编码保存在String中
String listString = new String(Base64.encode(
byteArrayOutputStream.toByteArray(), Base64.DEFAULT));
// 关闭objectOutputStream
objectOutputStream.close();
return listString;
}

@SuppressWarnings("unchecked")
public static List<?> StringToList(String listString) throws StreamCorruptedException, IOException,
ClassNotFoundException {
byte[] mobileBytes = Base64.decode(listString.getBytes(),
Base64.DEFAULT);
ByteArrayInputStream byteArrayInputStream = new ByteArrayInputStream(
mobileBytes);
ObjectInputStream objectInputStream = new ObjectInputStream(
byteArrayInputStream);
List<?> WeatherList = (List<?>) objectInputStream
.readObject();
objectInputStream.close();
return WeatherList;
}

测试代码（SharedpreferesUtil就是自己写的工具类）：

/**
* Sharedpreferences 保存复杂数据
*/
public class MainActivity extends Activity {

@butterknife.Bind(R.id.save_list_btn)
Button saveListBtn;
@butterknife.Bind(R.id.save_img_btn)
Button saveImgBtn;
@butterknife.Bind(R.id.save_obj_btn)
Button saveObjBtn;
@butterknife.Bind(R.id.show_imv)
ImageView showImv;
@butterknife.Bind(R.id.imfo_edt)
EditText imfoEdt;
@butterknife.Bind(R.id.activity_main)
RelativeLayout activityMain;

private final  static String SHAREDPREFS_USER="user_config";
private final  static String USER_AVATAR="avatar";
private static final String USER_IMFO = "user";
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
butterknife.ButterKnife.bind(this);
}
@TargetApi(Build.VERSION_CODES.JELLY_BEAN)
@OnClick({R.id.save_img_btn,R.id.save_list_btn,R.id.save_obj_btn})
void OnClick(View v){
switch (v.getId()){
case R.id.save_img_btn:
if("read Image".equals(saveImgBtn.getText())) {
Drawable drawable=SharedpreferesUtil.getDrawableByKey(this, SHAREDPREFS_USER, USER_AVATAR);
showImv.setVisibility(View.VISIBLE);
//showImv.setBackgroundResource(R.mipmap.ic_launcher);
showImv.setImageBitmap(IOUtil.drawableToBitmap(drawable));
}else {
SharedpreferesUtil.saveDrawable(this, SHAREDPREFS_USER, R.mipmap.ic_launcher, USER_AVATAR);
saveImgBtn.setText("read Image");
}
break;
case R.id.save_list_btn:
break;
case R.id.save_obj_btn:
if("read object".equals(saveObjBtn.getText())) {
showImv.setVisibility(View.GONE);
User user=SharedpreferesUtil.getUser(this,SHAREDPREFS_USER,USER_IMFO);
imfoEdt.setVisibility(View.VISIBLE);
imfoEdt.setText("Id:"+user.get_id()+"  Name:"+user.getName());
}else {
try {
SharedpreferesUtil.saveUser(this, SHAREDPREFS_USER, USER_IMFO, new User(1001, "CrazyMo"));
saveObjBtn.setText("read object");
} catch (Exception e) {
e.printStackTrace();
}
}

break;
default:
break;
}
}
}

四、关于Base64

public static void main(String[] args) {
BASE64Encoder encoder = new BASE64Encoder();
String s = "Man";
String encoded = encoder.encode(s.getBytes());
System.out.println("ecoded Man " + encoded);
s = "Mo";
String encoded = encoder.encode(s.getBytes());
System.out.println("ecoded Mo" + encoded);
s = "c";
String encoded = encoder.encode(s.getBytes());
System.out.println("ecoded c" + encoded);

}

Base64是一种基于64个可打印字符来表示二进制数据的表示方法。由于2的6次方等于64，所以每6个比特为一个单元，对应某个可打印字符。三个字节有24个比特，对应于4个Base64单元，即3个字节可表示4个可打印字符。它可用来作为电子邮件的传输编码。在Base64中的可打印字符包括字母A-Z、a-z、0-9，这样共有62个字符，此外两个可打印符号在不同的系统中而不同。Base64是一种可逆的编码方式。最常见的表现就是在于可以用Base64对图片编码变成流，反过来也可以把流转为图片，Base64常用于在通常处理文本数据的场合，表示、传输、存储一些二进制数据。包括MIME的email、在XML中存储复杂数据。

这是编码后的数据是一个字符串，其中包含的字符为：A-Z、a-z、0-9、+、/共64个字符(其实是65个字符，而“=”是填充字符)。



当长度为3个字节的数据经过Base64编码后就变为4个字节，比如



如果要编码的字节数不能被3整除，最后会多出1个或2个字节，那么可以使用下面的方法进行处理：先使用0字节值在末尾补足，使其能够被3整除，然后再进行base64的编码。在编码后的base64文本后加上一个或两个’=’号，代表补足的字节数。也就是说，当最后剩余一个八位字节（一个byte）时，最后一个6位的base64字节块有四位是0值，最后附加上两个等号；如果最后剩余两个八位字节（2个byte）时，最后一个6位的base字节块有两位是0值，最后附加一个等号。 参考下表：


引自Wiki百科