《一个Android工程的从零开始》9、base（八） 数据存储-SharedPreferences

先扯两句

好吧，这次就不说深深的罪恶感之类的话了，毕竟又半个月过去了，才写这一篇。这次我老实交代，真的不是忙了，而是真的懒了，人往往就是这样，很容易为自己找借口，也很容易原谅自己，人老了，年纪大了，就更是如此了。不过亡羊补牢、希望为时未晚吧。

闲言少叙，老规矩还是先上我的Git库，然后开始正文吧。

MyBaseApplication (https://github.com/BanShouWeng/MyBaseApplication)

正文

数据存储的功能的必要性我这里就不多说了，因为实在我也不知道应该说些什么，无奈，个人是真心没有耐性坐在那老老实实的研究各种定义的，如果大家实在想知道，还是自行百度吧。

至于存储的方式，如果你刚刚百度的时候顺手查了一下，就会看到，通用的说法，是一共五种：

SharedPreferences存储数据

SQLite数据库存储数据

文件存储数据

使用ContentProvider存储数据

网络存储数据

当然，某次我在面试的时候，也是按这个说的，结果就是被面试官狠狠羞辱了一顿，说是网络存储根本就不算是存储方式，作为一个讨工作的弱势群体，我就只能没骨气的同意了。

而无论网络存储数据究竟算不算是一种存储方式，这里我们暂且不论，诸位如果去面试，又倒霉的遇到面试官还真就问了这道题，那我劝你也不肯定它就是，也不说它不是，咱也犯不着做语文阅读理解似的揣摩出题人心理对吧，就告诉他上面的四种，然后说还有另一种说法，说网络存储算是第五种，结了。

当然，我这个数据存储的部分，我是不会把网络存储数据加进去的，这当然不是我被面试官的淫威影响了，只是单纯的在前面的文章中，Retrofit中所说的，就是如果通过网络存储数据的方式。

至于其他这四种的定义之类的，想要应付面试官的话，[Android]Android数据的四种存储方式希望可以帮到你。

SharedPreferences

下面我们来进入今天的主题——SharedPreferences。

等等，进入主题之前，再插一句，还是一次面试经历，一位面试官特淡定的问我，之前使用过偏爱存储吗，问得我一脸的懵逼，当初还嫩的我只能说没用过，后来面试官一说，原来就是SharedPreferences，当时心头何止一万只“草泥马”在奔驰而过，这里说一下，也防止大家遇到类似的问题。

下面真的开始进入正文，虽然不情不愿，我还是把SharedPreferences的基本信息放在下面了，大家随便看看。

1、SharedPreferences是一种轻型的数据存储方式，实际上是基于XML文件存储的“key-value”键值对数据。

2、通常用来存储程序的一些配置信息。其存储在“data/data/程序包名/shared_prefs目录下。

3、SharedPreferences本身只能获取数据，不支持存储和修改。存储和修改要通过Editor对象来实现。

从上面的内容，我们可以看到，一般而言，SharedPreferences存储的还是一些比较简单的数据，至于复杂的数据，是真心无能为力。

若说如何使用，其实也简单的很，常用的无非也就是几个方法

1、创建实例：

SharedPreferences preferences= context.getSharedPreferences("SharedPreferences",MODE_PRIVATE);

至于其中的context是谁，请参照我前面的写的博客，如果你真是懒得去翻的话，那就用getApplicationContext()吧。不过这都不重要，无论是context还是getApplicationContext()，一会在封装的部分，我们统统都用不到。

至于其中的参数，也很简单，只有两个，第一个，数据库的名字，为什么要有名字就不用说了吧，就好像“我爸是李刚”，如果没有“李刚”这个名字，“我爸是……”，你拿这话能吓到谁啊。

第二个是访问权限的限定，可以看到，我给的是MODE_PRIVATE，也就是私有模式，具体的几种可选模式如下：

MODE_PRIVATE，则该配置文件只能被自己的应用程序访问。

MODE_WORLD_READABLE，则该配置文件除了自己访问外还可以被其它应该程序读取。

MODE_WORLD_WRITEABLE，则该配置文件除了自己访问外还可以被其它应该程序读取和写入

不过呢，现在设置的时候，可以看到下面两个都已经过时了，也就说，这道题已经变成A、B、C三个选择，其中B、C是错的，那么我们应该选那个答案的问题。



当然，大家可以看到，这里还是有其他的选项的，只可惜，这些备选项都是跑错片场的，大家可以看一下他们的说明，与SharedPreferences没有什么关系，这里就不一一说明。

2、创建编辑器：

SharedPreferences.Editor edit= preferences.edit();

3、添加数据：



大家只要选择对应的

4、提交数据

以提交字符串为例：

edit.putString("putString", "string").apply();

当然，如果我们查到之前SharedPreferences使用的方法，提交的部分使用的是commit()，而不是apply()，可是现在的版本还是建议使用apply()的，因为你一旦使用了commit()，在执行lint的时候，会提示你修改为apply()。



5、删除指定数据

edit.remove("putString").apply();

传入的参数为需要删除的数据的key值即可，同样需要apply()方法提交该操作。

6、清空所有数据

edit.clear().apply();

不需要传入参数，但是还是需要apply()方法提交该操作。

以上就是SharedPreferences的常用方式，现在大家也可以根据自己的需求运用SharedPreferences了，需要说明的是。由于SharedPreferences之间区分，就是靠创建时的名字，所以说，SharedPreferences在一个工程中可以存在一个，也可以存在多个，至于创建几个数据库就看需求而定了，如果只是一般简单运用，只有一个即可，不需要每次存储数据都创建新的SharedPreferences。

而且只有在同一个名的SharedPreferences中，才可以使用相同的key去添加、删除、修改其中的数据。

SharedPreferences与map相类似，同一个key值只能对应一条数据，所以修改的时候，只需要调用put方法即可。

封装

当然，在一个工程中使用，我们也不可能每次都需要创建一个SharedPreferences，然后通过edit去进行操作，一般而言，还是将其封装成一个工具类来使用来得更简便，没办法，谁让我懒呢。

细心的可能会发现，我在gif图中，将SharedPreferences创建在了app中，但是下面我的封装却并不打算这么做，只是因为移植性差些，还需要去设置app类，继承application，并且在AndroidManifest中配置，太麻烦了。

下面贴出来我的SPUtils类的配置内容。

private SharedPreferences preferences = null;
private static SPUtils utils;

public SPUtils(Context context) {
initPreferences(context);
}

public static SPUtils getInstance(Context context) {
if (utils == null) {
utils = new SPUtils(context);
}
return utils;
}

private void initPreferences(Context context) {
if (preferences == null) {
preferences = context.getApplicationContext().getSharedPreferences("SharedPreferences", Context.MODE_PRIVATE);
}
}

可以看到创建的部分我做了一些修改：context.getApplicationContext()，多出来的getApplicationContext()是防止传入的是Activity，而不是Context时导致的内存泄漏，具体情况还有待测试。

使用的时候，SPUtils.getInstance(context)对SPUtils进行初始化，得到SPUtils的同时，也完成了对SharedPreferences的创建。

至于其中增加、删除、获取的方法如下
dc95
：

public void put(String key, String value) {
preferences.edit().putString(key, value).apply();
}

public void put(String key, boolean value) {
preferences.edit().putBoolean(key, value).apply();
}

public void put(String key, int value) {
preferences.edit().putInt(key, value).apply();
}

public void put(String key, float value) {
preferences.edit().putFloat(key, value).apply();
}

public void put(String key, long value) {
preferences.edit().putLong(key, value).apply();
}

public void put(String key, Set<String> values) {
preferences.edit().putStringSet(key, values).apply();
}

public String getString(String key, String defaultString) {
return preferences.getString(key, defaultString);
}

public String getString(String key) {
return preferences.getString(key, "");
}

public boolean getBoolean(String key) {
return preferences.getBoolean(key, false);
}

public boolean getBoolean(String key, boolean defaultBoolean) {
return preferences.getBoolean(key, defaultBoolean);
}

public int getInt(String key) {
return preferences.getInt(key, 0);
}

public int getInt(String key, int defaultInt) {
return preferences.getInt(key, defaultInt);
}

public float getFloat(String key, float defaultFloat) {
return preferences.getFloat(key, defaultFloat);
}

public float getFloat(String key) {
return preferences.getFloat(key, 0);
}

public long getLong(String key) {
return preferences.getLong(key, 0);
}

public long getLong(String key, long defaultLong) {
return preferences.getLong(key, defaultLong);
}

public Set<String> getStringSet(String key) {
return preferences.getStringSet(key, null);
}

public Set<String> getStringSet(String key, Set<String> defaultStringSet) {
return preferences.getStringSet(key, defaultStringSet);
}

public Map<String, ?> getStringSet() {
return preferences.getAll();
}

public void remove(String key) {
preferences.edit().remove(key).apply();
}

public void clear() {
preferences.edit().clear().apply();
}

可以看到，在添加/修改的部分是对put方法重载，虽然在封装的时候麻烦一些，但是使用的时候，就可以无脑传key-value，而不同担心参数类型了。

取值的部分我也想过封装成一个方法，只可惜String、int、float、map、set等的公共父类没有找到，所以也就只能放弃了。

至于remove和clear方法就不用单独说明了，直接使用即可。

使用

1、存储

SPUtils.getInstance(activity).put("test", "test");

2、取值

SPUtils.getInstance(activity).getString("test")

remove与clear类似。

不过需要提醒的是，这部分虽然已经封装好了，测试使用的过程中也没有发现问题，只是SharedPreferences的使用方法，还是需要我们记住的，尤其是edit()方法与apply()方法在封装中已经完全看不到了，至少大家在面试的时候或许还是会被问道的。

附录

附录1

工具类完整代码

package com.banshouweng.mybaseapplication.utils;

import android.content.Context;
import android.content.SharedPreferences;

import java.util.HashMap;
import java.util.Map;
import java.util.Objects;
import java.util.Set;

/**
* 《一个Android工程的从零开始》
*
* @author 半寿翁
* @博客：
* @CSDN http://blog.csdn.net/u010513377/article/details/74455960 * @简书 http://www.jianshu.com/p/1410051701fe */

public class SPUtils {
private SharedPreferences preferences = null;
private static SPUtils utils;

public SPUtils(Context context) {
initPreferences(context);
}

public static SPUtils getInstance(Context context) {
if (utils == null) {
utils = new SPUtils(context);
}
return utils;
}

private void initPreferences(Context context) {
if (preferences == null) {
preferences = context.getApplicationContext().getSharedPreferences("SharedPreferences", Context.MODE_PRIVATE);
}
}
public void put(String key, String value) {
preferences.edit().putString(key, value).apply();
}

public void put(String key, boolean value) {
preferences.edit().putBoolean(key, value).apply();
}

public void put(String key, int value) {
preferences.edit().putInt(key, value).apply();
}

public void put(String key, float value) {
preferences.edit().putFloat(key, value).apply();
}

public void put(String key, long value) {
preferences.edit().putLong(key, value).apply();
}

public void put(String key, Set<String> values) {
preferences.edit().putStringSet(key, values).apply();
}

public String getString(String key, String defaultString) {
return preferences.getString(key, defaultString);
}

public String getString(String key) {
return preferences.getString(key, "");
}

public boolean getBoolean(String key) {
return preferences.getBoolean(key, false);
}

public boolean getBoolean(String key, boolean defaultBoolean) {
return preferences.getBoolean(key, defaultBoolean);
}

public int getInt(String key) {
return preferences.getInt(key, 0);
}

public int getInt(String key, int defaultInt) {
return preferences.getInt(key, defaultInt);
}

public float getFloat(String key, float defaultFloat) {
return preferences.getFloat(key, defaultFloat);
}

public float getFloat(String key) {
return preferences.getFloat(key, 0);
}

public long getLong(String key) {
return preferences.getLong(key, 0);
}

public long getLong(String key, long defaultLong) {
return preferences.getLong(key, defaultLong);
}

public Set<String> getStringSet(String key) {
return preferences.getStringSet(key, null);
}

public Set<String> getStringSet(String key, Set<String> defaultStringSet) {
return preferences.getStringSet(key, defaultStringSet);
}

public Map<String, ?> getStringSet() {
return preferences.getAll();
}

public void remove(String key) {
preferences.edit().remove(key).apply();
}

public void clear() {
preferences.edit().clear().apply();
}
}

附录2

《一个Android工程的从零开始》- 目录