SharedPreferences可以保存序列化对象的管理工具

事先声明,本文涉及的代码,是参考网上大神的代码,加以总结的结果。因为时间比较久,无法确定具体的出处,总之要感谢大神们的分享。

言归正传,我们都知道,SharedPreferences只能保存几种基本的数据类型:

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();
}

但是,我们实际开发中,往往需要保存一下简单实体信息(比如登录用户的基本信息),内容太少,没有必要使用数据库存储,而SharedPreferences的简单类型有不能满足我们的需求。这时候我们通常需要将需要保存的对象,转化为字符串,然后通过SharedPreferences,进行保存。
当然具体方法不唯一,比如讲对象转化为json字符串进行保存,我们这里介绍的是将对象转换为ObjectOutputStream流,然后Base64将流转化为字符串进行保存。

    ByteArrayOutputStream baos = new ByteArrayOutputStream();
    ObjectOutputStream oos = null;
    String objectStr = "";
    try {
        oos = new ObjectOutputStream(baos);
        oos.writeObject(object);
        // 将对象放到OutputStream中
        // 将对象转换成byte数组,并将其进行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 统一管理类
     */
    public class SPUtil {
    
        /**
         * 保存到手机的文件
         */
        public final static String FILE_NAME = "share_date";
    
    
        /**
         * 保存数据的方法,将不同类型的数据保存到文件中
         *
         * @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数组
                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数组转换成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数组,并将其进行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);
        }
    
    
        /**
         * 得到保存数据的方法,根据默认值得到保存的数据的具体类型,然后调用相对于的方法获取值
         *
         * @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);
        }
    
        /**
         * 清除所有数据
         *
         * @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();
        }
    
    
        /**
         * 创建一个解决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执行,否则使用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,防止内存泄漏。

    原文作者:Henry_Mark
    原文地址: https://www.jianshu.com/p/8fca0e756595
    本文转自网络文章,转载此文章仅为分享知识,如有侵权,请联系博主进行删除。
点赞