Android SharedPreferences一个很好的封装类

时间：2021-12-11 05:29:58

在进行Android开发中难免要保存一些数据保存，我们大多使用的是数据库保存数据的。数据库保存数据固然好但是这样的开销也是很大的。有时我们只是保存一部分很少的数据，比如我们应用的配置等用户的登录账号和密码时这样在使用数据库感觉有点浪费。这时我们今天的主角sharedPreference就登场了。我们可以用sharedPreference保存一些这样的数据。今天就封装了一个sharedPreferences的封装类主要为了sharedPreferences的操作，话不多说直接上代码，代码注释的很清楚。

public class SharedPreferencesHelper {
private static SharedPreferences sharedPreferences;
/**
 * 保存在手机里面的名字
 */
public static final String FILE_NAME = "shared_data";
private static SharedPreferences.Editor editor;

public SharedPreferencesHelper(Context context) {
        sharedPreferences = context.getSharedPreferences(FILE_NAME, Context.MODE_PRIVATE);
        editor = sharedPreferences.edit();
    }

/**
 * 保存数据的方法，拿到数据保存数据的基本类型，然后根据类型调用不同的保存方法
 *
 * @param key
 * @param object
 */
public static void put(String key, Object object) {

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());
        }
        org.androidannotations.api.sharedpreferences.SharedPreferencesCompat.apply(editor);
    }

/**
 * 获取保存数据的方法，我们根据默认值的到保存的数据的具体类型，然后调用相对于的方法获取值
 *
 * @param key 键的值
 * @param defaultObject 默认值
 * @return
 */

public static Object get(String key, Object defaultObject) {
if (defaultObject instanceof String) {
return sharedPreferences.getString(key, (String) defaultObject);
        } else if (defaultObject instanceof Integer) {
return sharedPreferences.getInt(key, (Integer) defaultObject);
        } else if (defaultObject instanceof Boolean) {
return sharedPreferences.getBoolean(key, (Boolean) defaultObject);
        } else if (defaultObject instanceof Float) {
return sharedPreferences.getFloat(key, (Float) defaultObject);
        } else if (defaultObject instanceof Long) {
return sharedPreferences.getLong(key, (Long) defaultObject);
        } else {
return sharedPreferences.getString(key, null);
        }

    }

/**
 * 移除某个key值已经对应的值
 *
 * @param key
 */
public static void remove(String key) {
        editor.remove(key);
        SharedPreferencesCompat.apply(editor);
    }

/**
 * 清除所有的数据
 */
public static void clear() {
        editor.clear();
        SharedPreferencesCompat.apply(editor);
    }

/**
 * 查询某个key是否存在
 *
 * @param key
 * @return
 */
public static boolean contains(String key) {
return sharedPreferences.contains(key);
    }

/**
 * 返回所有的键值对
 *
 * @return
 */
public static Map<String, ?> getAll() {
return sharedPreferences.getAll();
    }

这里我们对SharedPreference的使用做了建议的封装，对外公布出put,get,remove,clear等等方法；
我们在使用中实例化SharedPreference后就可以进行操作了。
这里需要注意的一点是，里面所有的commit操作使用了SharedPreferencesCompat.apply进行替代，目的是尽可能的使用apply代替commit，这里的原因很重要的，因为commit方法是同步的，并且我们很多时候的commit操作都是ui线程中，毕竟是IO操作，尽可能异步；所以我们使用apply进行替代，apply异步的进行写入。这里我们使用的是开源框架androidannotations为我们提供的这个API。不想自己写了！！！以后会继续将这个类进行改进！！！
标签：

相关文章