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,防止内存泄漏。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 202,980评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,178评论 2 380
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,868评论 0 336
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,498评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,492评论 5 364
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,521评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,910评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,569评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,793评论 1 296
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,559评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,639评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,342评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,931评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,904评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,144评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,833评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,350评论 2 342

推荐阅读更多精彩内容

  • 第5章 引用类型(返回首页) 本章内容 使用对象 创建并操作数组 理解基本的JavaScript类型 使用基本类型...
    大学一百阅读 3,204评论 0 4
  • 1. Java基础部分 基础部分的顺序:基本语法,类相关的语法,内部类的语法,继承相关的语法,异常的语法,线程的语...
    子非鱼_t_阅读 31,560评论 18 399
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,580评论 18 139
  • 每每听到别人搬家,内心总会升腾出莫须有的小小的羡慕,以为那将是一个无比美妙的过程,伴随搬家,总会舍去一些旧物新增一...
    柳二白阅读 455评论 1 1
  • 蓝夫原创,转载请联系授权。 一茶易苦易甜易此生,一禅静心静念静欲静繁世。抛俗抛怨抛金抛禄,生有聚,死易散。此生何惧...
    蓝笑笑阅读 249评论 0 0