【5年Android从零复盘系列之二十六】Android存储（1）：Sharedpreference详解_android sharedpreference

【5年Android从零复盘系列之二十六】Android存储（1）：Sharedpreference

1.概述（注意要点）

1. SharedPreferences是一个轻量级的存储工具类，实际开发中主要用于保存APP基础设置值。
2. SharedPreference是以键值对key-value形式存储数据
3. 支持直接存储的基础类型有：String 、boolean 、int 、long、float
4. 保存位置：/data/data/app_package_name/shared_prefs/your_sp_name.xml
5. SharedPreferences非常不建议存储长数据，非常不建议、非常不建议、非常不建议 – 实际开发是禁止
6. 不建议存储特殊符号很多的数据，会造成不必要方法调用开销，比如json/html
7. 不建议跨进程数据交换
8. 虽然SharedPreferences是在子线程加载，但是主线程是被暂时阻塞的，sp.getXxx（）是使用了synchronized锁
9. 常用的key-value放data_sp.xml,与不常用的key-value隔离如setting_sp.xml
10. SharedPreferences是一个轻量级的存储工具,【轻量】、【轻量】、【轻量】

2.SharedPreferences数据加工

sp存储轻量数据，如果隐私度较高，建议简单加密处理一下，不推荐使用加密后含有特殊符号的加密方式。

/**
     * 加密
     *
     * @param password 待加密String
     * @return 加密后的String
     */
    public static String encrypt(String password) {
        long enMills = System.currentTimeMillis();
        char[] array = password.toCharArray();
        StringBuilder builder = new StringBuilder();
        for (char c : array) {
            builder.append(c);
            builder.append(new Random().nextInt(9));
        }
        //最后添加一个随机字符
        long mill = System.currentTimeMillis() - enMills;
        if (mill % 3 == 0) {
            builder.append("g");
        }
        if (mill % 3 == 1) {
            builder.append("a");
        }
        if (mill % 3 == 2) {
            builder.append("k");
        }
        return builder.toString();
    }

    /**
     * 解密
     *
     * @param password 加密过的 String
     * @return 解密后的String
     */
    public static String decrypt(String password) {
        char[] array = password.toCharArray();
        StringBuilder builder = new StringBuilder();
        for (int i = 0; i < array.length - 1; i++) {//舍弃最后一个随机字符
            builder.append(array[i]);
            i++;
        }
        return builder.toString();
    }

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

3.封装使用

package com.cupster.spcache;

import android.content.Context;
import android.content.SharedPreferences;
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.util.Random;
import java.util.Set;

/**
 *  code by Cupster 2019.02.06
 */
public final class SPCache {

    private static final String SP_SETTING = "setting";//sp文件setting.xml
    private static final String SP_DATA = "data";//sp文件data.xml

    private static SharedPreferences getPreference(Context context, String spName) {
        return context.getSharedPreferences(spName, 0);
    }

    private static SharedPreferences.Editor getEditor(Context context, String spName) {
        return getPreference(context, spName).edit();
    }

    /**
     * 设置 Setting.sp 的键值对
     *
     * @param context context
     * @param key     key
     * @param value   value
     */
    public static void putSetting(Context context, String key, String value) {
        getEditor(context, SP_SETTING).putString(key, value).apply();
    }
    public static void putSetting(Context context, String key, int value) {
        getEditor(context, SP_SETTING).putInt(key, value).apply();
    }
    public static void putSetting(Context context, String key, boolean value) {
        getEditor(context, SP_SETTING).putBoolean(key, value).apply();
    }
    public static void putSetting(Context context, String key, float value) {
        getEditor(context, SP_SETTING).putFloat(key, value).apply();
    }
    public static void putSetting(Context context, String key, long value) {
        getEditor(context, SP_SETTING).putLong(key, value).apply();
    }
    public static void putSetting(Context context, String key, Set<String> value) {
        getEditor(context, SP_SETTING).putStringSet(key, value).apply();
    }

    /**
     * 获取 Setting.sp 的数据
     *
     * @param context  context
     * @param key      key
     * @param defValue 无数据时替代值
     * @return 值
     */
    public static String getSetting(Context context, String key, String defValue) {
        return getPreference(context, SP_SETTING).getString(key, defValue);
    }
    public static int getSetting(Context context, String key, int defValue) {
        return getPreference(context, SP_SETTING).getInt(key, defValue);
    }
    public static boolean getSetting(Context context, String key, boolean defValue) {
        return getPreference(context, SP_SETTING).getBoolean(key, defValue);
    }
    public static float getSetting(Context context, String key, float defValue) {
        return getPreference(context, SP_SETTING).getFloat(key, defValue);
    }
    public static long getSetting(Context context, String key, long defValue) {
        return getPreference(context, SP_SETTING).getLong(key, defValue);
    }
    public static Set<String> getSetting(Context context, String key) {
        return getPreference(context, SP_SETTING).getStringSet(key, null);
    }
    /**
     * 设置 Setting.sp 的键值对
     *
     * @param context context
     * @param key     key
     * @param value   value
     */
    public static void putData(Context context, String key, String value) {
        getEditor(context, SP_DATA).putString(key, value).apply();
    }

    /**
     * 获取 Setting.sp 的数据
     *
     * @param context  context
     * @param key      key
     * @param defValue 无数据时替代值
     * @return 值
     */
    public static String getData(Context context, String key, String defValue) {
        return getPreference(context, SP_DATA).getString(key, defValue);
    }

    /**
     * 加密
     *
     * @param password 待加密String
     * @return 加密后的String
     */
    public static String encrypt(String password) {
        long enMills = System.currentTimeMillis();
        char[] array = password.toCharArray();
        StringBuilder builder = new StringBuilder();
        for (char c : array) {
            builder.append(c);
            builder.append(new Random().nextInt(9));
        }
        //最后添加一个随机字符
        long mill = System.currentTimeMillis() - enMills;
        if (mill % 3 == 0) {
            builder.append("g");
        }
        if (mill % 3 == 1) {
            builder.append("a");
        }
        if (mill % 3 == 2) {
            builder.append("k");
        }
        return builder.toString();
    }

    /**
     * 解密
     *
     * @param password 加密过的 String
     * @return 解密后的String
     */
    public static String decrypt(String password) {
        char[] array = password.toCharArray();
        StringBuilder builder = new StringBuilder();
        for (int i = 0; i < array.length - 1; i++) {//舍弃最后一个随机字符
            builder.append(array[i]);
            i++;
        }
        return builder.toString();
    }

    /**
     * 将对象转换成byte数组，并将其进行base64编码
     *
     * @param object base64编码前String
     * @return 编码后String
     */
    public static String base64Encrypt(Object object) {
        ByteArrayOutputStream baos = new ByteArrayOutputStream();
        ObjectOutputStream oos = null;
        try {
            oos = new ObjectOutputStream(baos);
            oos.writeObject(object);
        } catch (IOException e) {
            e.printStackTrace();
        }
        // 将对象放到OutputStream中
        // 将对象转换成byte数组，并将其进行base64编码
        String objectStr = new String(Base64.encode(baos.toByteArray(), Base64.DEFAULT));

        try {
            baos.close();
            if (oos != null) {
                oos.close();
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
        return objectStr;
    }

    /**
     * 将base64格式字符串还原成byte数组
     *
     * @param string base64编码前String
     * @return base64解码后的对象
     */
    public static Object base64Decrypt(String string) {
        try {
            if (string == null || string.equals("")) { // 不可少，否则在下面会报java.io.StreamCorruptedException
                return "";
            }
            byte[] objBytes = Base64.decode(string.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 "";
    }


}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208