SharedPreferences

• 简介
• SharedPreferences的使用流程
  • 一、<font color=red>保存键值对的步骤</font>：
  • 二、<font color=red>读取键值对的步骤</font>：

简介

  首先应该表明SharedPreferences是一个接口，就是interface，而不是一个class。SharedPreferences是一个轻量级的存储接口,原理是使用xml文件存放键值对数据，文件存放在/data/data/<package-name>/shred-prefs目录下。使用SharedPreferences接口中的内部接口Editor的方法，可以存放String、set、int、long、float、boolean类型的数据，通过SharedPreferences中的方法进行读取以上几种类型的数据。

使用SharedPreferences进行键值对的存储和读取有三种方式获取SharedPreferences对象：
(1).SharedPreferences sp = Context.getSharedPreferences(String name,int mode);
  使用该方法，配置的xml文件名字是参数中的name字段，如果该文件不存在，就创建，如果已经存在就直接使用，在填写name字段时，不要添加".xml"后缀，系统会自动添加后缀。
(2).SharedPreferences sp = Activity.getPreferences(int mode);
  使用该方法，配置的xml文件名字是使用当前类名；
(3).SharedPreferences sp = PreferenceManager.getDefaultSharedPreferences(Context context);
  首先需要知道，每个应用都有一个默认的配置文件preferences.xml。使用该方法，就是使用那个默认的配置文件；
(4).SharedPreferences sp = PreferenceManager.getSharedPreferences();
  用的也是以包名作为名字的xml文件；

getSharedPreferences（） 是Context类中的方法，可以指定file name以及 mode；
getPreferences（）是Activity类中的方法，只需指定mode；
getSharedPreferences（）是PreferenceManager类中的方法，使用自定义的xml文件；
getDefaultSharedPreferences（）是PreferenceManager类中的方法，使用应用默认xml文件；

注意：参数mode字段是操作模式，默认的模式为0或者是字段MODE_PRIVATE，还可以使用MODE_APPEND、MODE_WORLD_READABLE和MODE_WRITEABLE；

类型	解释
MODE_PRIVATE	该配置文件只能被自己的应用程序访问；
MODE_WORLD_READABLE	该配置文件除了自己访问外，还可以被其他应用程序读取；
MODE_WORLD_WRITEABLE	该配置文件除了自己访问外，还可以被其他应用程序读取和写入；

  在这里啰嗦一点，引申一下。Activity继承自ContextThemeWrapper，ContextThemeWrapper继承自ContextWrapper，ContextWrapper继承自Context。以下源码可以找到（1）、（2）这两个方法的使用。

Activity.java类中代码

public SharedPreferences getPreferences(@Context.PreferencesMode int mode) {
    return getSharedPreferences(getLocalClassName(), mode);
}

ContextWrapper.java类中代码

@Override
public SharedPreferences getSharedPreferences(String name, int mode) {
    return mBase.getSharedPreferences(name, mode);
}

@Override
public SharedPreferences getSharedPreferences(File file, int mode) {
    return mBase.getSharedPreferences(file, mode);
}

Context.java类中的代码：

public abstract SharedPreferences getSharedPreferences(String name, @PreferencesMode int mode);

public abstract SharedPreferences getSharedPreferences(File file, @PreferencesMode int mode);

  以下源码是(3)、（4）方法的实现。
PreferenceManager.java类中的实现：

public static SharedPreferences getDefaultSharedPreferences(Context context) {
    //最终调用是Context.java类中的getSharedPreferences（）方法;
    return context.getSharedPreferences(getDefaultSharedPreferencesName(context),
        etDefaultSharedPreferencesMode());
}

public SharedPreferences getSharedPreferences() {
    if (mPreferenceDataStore != null) {
        return null;
    }
    
    if (mSharedPreferences == null) {
        final Context storageContext;
        switch (mStorage) {
            case STORAGE_DEVICE_PROTECTED:
                storageContext = mContext.createDeviceProtectedStorageContext();
                break;
            case STORAGE_CREDENTIAL_PROTECTED:
                storageContext = mContext.createCredentialProtectedStorageContext();
                break;
            default:
                storageContext = mContext;
                break;
        }
        //最终调用也是Context.java中的storageContext.getSharedPreferences（）方法;
        mSharedPreferences = storageContext.getSharedPreferences(mSharedPreferencesName,
                mSharedPreferencesMode);
    }
    
    return mSharedPreferences;
}

SharedPreferences的文件结构：

public interface SharedPreferences {
    //监听接口；
    public interface OnSharedPreferenceChangeListener {
        void onSharedPreferenceChanged(SharedPreferences sharedPreferences, String key);
    }
    //Editor接口；
    public interface Editor {
        //存放String型数据；
        Editor putString(String key, @Nullable String value);
        Editor putStringSet(String key, @Nullable Set<String> values);
        //存放int型数据；
        Editor putInt(String key, int value);
        //存放long型数据；
        Editor putLong(String key, long value);
        //存放float型数据；
        Editor putFloat(String key, float value);
        //存放boolean型数据；
        Editor putBoolean(String key, boolean value);
        Editor remove(String key);
        Editor clear();
        //提交；
        boolean commit();
        //应用；
        void apply();
    }
    
    Map<String, ?> getAll();
    //获取String类型数据；
    @Nullable
    String getString(String key, @Nullable String defValue);
    @Nullable
    Set<String> getStringSet(String key, @Nullable Set<String> defValues);
    //获取int型数据；
    int getInt(String key, int defValue);
    //获取long型数据；；
    long getLong(String key, long defValue);
    //获取float型数据；
    float getFloat(String key, float defValue);
    //获取boolean型数据；
    boolean getBoolean(String key, boolean defValue);
    boolean contains(String key);
    Editor edit();
    void registerOnSharedPreferenceChangeListener(OnSharedPreferenceChangeListener listener);
    void unregisterOnSharedPreferenceChangeListener(OnSharedPreferenceChangeListener listener);
}

PreferenceManager的文件结构:

public class PreferenceManager {
    public interface OnPreferenceTreeClickListener {
        boolean onPreferenceTreeClick(PreferenceScreen preferenceScreen, Preference preference);
    }
    public interface OnActivityResultListener {
        boolean onActivityResult(int requestCode, int resultCode, Intent data);
    }
    public interface OnActivityStopListener {
        void onActivityStop();
    }
    public interface OnActivityDestroyListener {
        void onActivityDestroy();
    }
    
    //获取SharedPreferences对象；
    public SharedPreferences getSharedPreferences() {
        if (mPreferenceDataStore != null) {
            return null;
        }
        if (mSharedPreferences == null) {
            final Context storageContext;
            switch (mStorage) {
                case STORAGE_DEVICE_PROTECTED:
                    storageContext = mContext.createDeviceProtectedStorageContext();
                    break;
                case STORAGE_CREDENTIAL_PROTECTED:
                    storageContext = mContext.createCredentialProtectedStorageContext();
                    break;
                default:
                    storageContext = mContext;
                    break;
            }
            mSharedPreferences = storageContext.getSharedPreferences(mSharedPreferencesName,
                    mSharedPreferencesMode);
        }
        return mSharedPreferences;
    }
    //获取SharedPreferences对象；
    public static SharedPreferences getDefaultSharedPreferences(Context context) {
        return context.getSharedPreferences(getDefaultSharedPreferencesName(context),
                getDefaultSharedPreferencesMode());
    }
    //获取SharedPreferences文件名字；
    public static String getDefaultSharedPreferencesName(Context context) {
        return context.getPackageName() + "_preferences";
    }
    //获取SharedPreferences的读取类型；
    private static int getDefaultSharedPreferencesMode() {
        return Context.MODE_PRIVATE;
    }
}

SharedPreferences的使用流程

一、保存键值对的步骤：

(1).获得SharedPreferences对象；
(2).获得SharedPreferences.Editor对象；
(3).通过SharedPreferences.Editor接口的putXxx（）方法存放key-value对（其中Xxx表示不同的数据类型。如：字符串类型的value需要用putString（）方法）；
(4).通过SharedPreferences.Editor接口的commit（）方法或者apply（）方法保存key-value对（commit方法相当于数据库事务中的提交（commit）操作）；

commit()和apply()的区别：
(1).apply()没有返回值，而commit()返回boolean表明修改是否提交成功；
(2).apply是将修改数据原子提交到内存, 而后异步真正提交到硬件磁盘, 而commit是同步的提交到硬件磁盘，因此，在多个并发的提交commit的时候，他们会等待正在处理的commit保存到磁盘后在操作，从而降低了效率。而apply只是原子的提交到内容，后面有调用apply的函数的将会直接覆盖前面的内存数据，这样从一定程度上提高了很多效率。
(3).apply方法不会提示任何失败的提示。 由于在一个进程中，sharedPreference是单实例，一般不会出现并发冲突，如果对提交的结果不关心的话，建议使用apply，当然需要确保提交成功且有后续操作的话，还是需要用commit的。

二、读取键值对的步骤：

(1).获得SharedPreferences对象；
(2).调用SharedPreferences对象的getXxx()方法来获取数据；