事先聲明辖试,本文涉及的代碼辜王,是參考網(wǎng)上大神的代碼,加以總結的結果罐孝。因為時間比較久呐馆,無法確定具體的出處,總之要感謝大神們的分享莲兢。
言歸正傳汹来,我們都知道,SharedPreferences只能保存幾種基本的數(shù)據(jù)類型:
public interface Editor {
SharedPreferences.Editor putString(String var1, String var2);
SharedPreferences.Editor putStringSet(String var1, Set<String> var2);
SharedPreferences.Editor putInt(String var1, int var2);
SharedPreferences.Editor putLong(String var1, long var2);
SharedPreferences.Editor putFloat(String var1, float var2);
SharedPreferences.Editor putBoolean(String var1, boolean var2);
SharedPreferences.Editor remove(String var1);
SharedPreferences.Editor clear();
boolean commit();
void apply();
}
但是改艇,我們實際開發(fā)中收班,往往需要保存一下簡單實體信息(比如登錄用戶的基本信息),內容太少谒兄,沒有必要使用數(shù)據(jù)庫存儲摔桦,而SharedPreferences的簡單類型有不能滿足我們的需求。這時候我們通常需要將需要保存的對象承疲,轉化為字符串邻耕,然后通過SharedPreferences,進行保存燕鸽。
當然具體方法不唯一赊豌,比如講對象轉化為json字符串進行保存,我們這里介紹的是將對象轉換為ObjectOutputStream流绵咱,然后Base64將流轉化為字符串進行保存。
ByteArrayOutputStream baos = new ByteArrayOutputStream();
ObjectOutputStream oos = null;
String objectStr = "";
try {
oos = new ObjectOutputStream(baos);
oos.writeObject(object);
// 將對象放到OutputStream中
// 將對象轉換成byte數(shù)組,并將其進行base64編碼
objectStr = new String(Base64.encode(baos.toByteArray(), Base64.DEFAULT));
baos.close();
oos.close();
} catch (IOException e) {
e.printStackTrace();
return;
}
下面是具體的工具類SPUtil :
import android.content.Context;
import android.content.SharedPreferences;
import android.preference.PreferenceManager;
import android.util.Base64;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.io.Serializable;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.util.Map;
/**
* Author:Henry
* Date:2017/12/21
* Email:Heneymark@gmail.com.
* Description: SharedPreferences 統(tǒng)一管理類
*/
public class SPUtil {
/**
* 保存到手機的文件
*/
public final static String FILE_NAME = "share_date";
/**
* 保存數(shù)據(jù)的方法悲伶,將不同類型的數(shù)據(jù)保存到文件中
*
* @param context
* @param key
* @param object
*/
public static void put(Context context, String key, Object object) {
SharedPreferences sp = context.getSharedPreferences(FILE_NAME, Context.MODE_PRIVATE);
SharedPreferences.Editor editor = sp.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());
}
SharedPreferencesCompat.apply(editor);
}
/**
* 獲取保存的序列化的實體
*
* @param context
* @param key
* @return
*/
public static Object getSerializableEntity(Context context, String key) {
SharedPreferences sharePre = PreferenceManager.getDefaultSharedPreferences(context);
try {
String wordBase64 = sharePre.getString(key, "");
// 將base64格式字符串還原成byte數(shù)組
if (wordBase64 == null || wordBase64.equals("")) { // 不可少艾恼,否則在下面會報java.io
// .StreamCorruptedException
return null;
}
byte[] objBytes = Base64.decode(wordBase64.getBytes(), Base64.DEFAULT);
ByteArrayInputStream bais = new ByteArrayInputStream(objBytes);
ObjectInputStream ois = new ObjectInputStream(bais);
// 將byte數(shù)組轉換成product對象
Object obj = ois.readObject();
bais.close();
ois.close();
return obj;
} catch (Exception e) {
e.printStackTrace();
}
return null;
}
/**
* 保存序列號的實體類
*
* @param context
* @param key
* @param object
*/
public static void putSerializableEntity(Context context, String key, Serializable object) {
SharedPreferences share = PreferenceManager.getDefaultSharedPreferences(context);
if (object == null) {
SharedPreferences.Editor editor = share.edit().remove(key);
return;
}
ByteArrayOutputStream baos = new ByteArrayOutputStream();
ObjectOutputStream oos = null;
String objectStr = "";
try {
oos = new ObjectOutputStream(baos);
oos.writeObject(object);
// 將對象放到OutputStream中
// 將對象轉換成byte數(shù)組,并將其進行base64編碼
objectStr = new String(Base64.encode(baos.toByteArray(), Base64.DEFAULT));
baos.close();
oos.close();
} catch (IOException e) {
e.printStackTrace();
return;
}
SharedPreferences.Editor editor = share.edit();
// 將編碼后的字符串寫到base64.xml文件中
editor.putString(key, objectStr);
SharedPreferencesCompat.apply(editor);
}
/**
* 得到保存數(shù)據(jù)的方法麸锉,根據(jù)默認值得到保存的數(shù)據(jù)的具體類型钠绍,然后調用相對于的方法獲取值
*
* @param context
* @param key
* @param defaultObject
* @return
*/
public static Object get(Context context, String key, Object defaultObject) {
SharedPreferences sp = context.getSharedPreferences(FILE_NAME,
Context.MODE_PRIVATE);
if (defaultObject instanceof String) {
return sp.getString(key, (String) defaultObject);
} else if (defaultObject instanceof Integer) {
return sp.getInt(key, (Integer) defaultObject);
} else if (defaultObject instanceof Boolean) {
return sp.getBoolean(key, (Boolean) defaultObject);
} else if (defaultObject instanceof Float) {
return sp.getFloat(key, (Float) defaultObject);
} else if (defaultObject instanceof Long) {
return sp.getLong(key, (Long) defaultObject);
}
return null;
}
/**
* 移除某個key值已經對應的值
*
* @param context
* @param key
*/
public static void remove(Context context, String key) {
SharedPreferences sp = context.getSharedPreferences(FILE_NAME,
Context.MODE_PRIVATE);
SharedPreferences.Editor editor = sp.edit();
editor.remove(key);
SharedPreferencesCompat.apply(editor);
}
/**
* 清除所有數(shù)據(jù)
*
* @param context
*/
public static void clear(Context context) {
SharedPreferences sp = context.getSharedPreferences(FILE_NAME,
Context.MODE_PRIVATE);
SharedPreferences.Editor editor = sp.edit();
editor.clear();
SharedPreferencesCompat.apply(editor);
}
/**
* 查詢某個key是否已經存在
*
* @param context
* @param key
* @return
*/
public static boolean contains(Context context, String key) {
SharedPreferences sp = context.getSharedPreferences(FILE_NAME,
Context.MODE_PRIVATE);
return sp.contains(key);
}
/**
* 返回所有的鍵值對
*
* @param context
* @return
*/
public static Map<String, ?> getAll(Context context) {
SharedPreferences sp = context.getSharedPreferences(FILE_NAME,
Context.MODE_PRIVATE);
return sp.getAll();
}
/**
* 創(chuàng)建一個解決SharedPreferencesCompat.apply方法的一個兼容類
*/
static class SharedPreferencesCompat {
private static final Method sApplyMethod = findApplyMethod();
/**
* 反射查找apply的方法
*
* @return
*/
@SuppressWarnings({"unchecked", "rawtypes"})
private static Method findApplyMethod() {
try {
Class clz = SharedPreferences.Editor.class;
return clz.getMethod("apply");
} catch (NoSuchMethodException e) {
}
return null;
}
/**
* 如果找到則使用apply執(zhí)行,否則使用commit
*
* @param editor
*/
public static void apply(SharedPreferences.Editor editor) {
try {
if (sApplyMethod != null) {
sApplyMethod.invoke(editor);
return;
}
} catch (IllegalArgumentException e) {
} catch (IllegalAccessException e) {
} catch (InvocationTargetException e) {
}
editor.commit();
}
}
}
這里我是將普通類型的存儲與對象的存儲分來花沉,當然也可以直接放到put方法里柳爽,直接加個判斷就行了。
注意:
1.存儲對象必須序列化碱屁;
2.方法中涉及Context的傳值磷脯,盡量使用Application的Context,防止內存泄漏娩脾。