Android SharedPreferences数据存储详解

 更新时间:2022年11月15日 09:23:16   作者:后端码匠  
SharedPreferences是安卓平台上一个轻量级的存储类,用来保存应用的一些常用配置,比如Activity状态,Activity暂停时,将此activity的状态保存到SharedPereferences中;当Activity重载,系统回调方法onSaveInstanceState时,再从SharedPreferences中将值取出

前言

Android提供了很多种保存应用程序数据的方法。其中一种就是用SharedPreferences对象来保存我们私有的键值(key-value)数据。

所有的逻辑都是基于下面三个类:

  • SharedPreferences
  • SharedPreferences.Editor
  • SharedPreferences.OnSharedPreferenceChangeListener

SharedPreferences

SharedPreferences是其中最重要的。它负责获取(解析)存储的数据,提供获取Editor对象的接口和添加或移除OnSharedPreferenceChangeListener的接口。

  • 创建SharedPreferences你需要Context对象(也可以是application Context)
  • getSharedPreferences方法会解析Preference文件并为它创建一个Map对象
  • 你可以用Context提供的几个模式创建它,强烈建议使用MODE_PRIVATE模式因为创建全局可读写的文件是比较危险的,可能会导致app的安全漏洞。
  / parse Preference file 解析Preference文件
  SharedPreferences preferences = context.getSharedPreferences("com.example.app", Context.MODE_PRIVATE);
  // get values from Map
  preferences.getBoolean("key", defaultValue)  
  preferences.get..("key", defaultValue)
  // you can get all Map but be careful you must not modify the collection returned by this
  // method, or alter any of its contents.
  //(Preference文件转换成map)你可以获取到一个map但是小心点最好不要修改map或它的内容
  Map<String, ?> all = preferences.getAll();
  // get Editor object
  SharedPreferences.Editor editor = preferences.edit();
  // add on Change Listener 添加监听器
  preferences.registerOnSharedPreferenceChangeListener(mListener);
  // remove on Change Listener 取消监听器
  preferences.unregisterOnSharedPreferenceChangeListener(mListener);
  // listener example 监听器例子
  SharedPreferences.OnSharedPreferenceChangeListener mOnSharedPreferenceChangeListener  
          = new SharedPreferences.OnSharedPreferenceChangeListener() {
      @Override
      public void onSharedPreferenceChanged(SharedPreferences sharedPreferences, String key) {
      }
  };

Editor

SharedPreferences.Editor是一个用来修改SharedPreferences对象值的接口。所有在Editor的修改会进行批处理,同时只有你调用了commit()或者apply()的时候才会复制到原来的SharedPreferences。

  • 用Editor的简单接口添加值
  • 用同步的commit()或速度更快异步的apply()来保存值。实际上在不同的线程使用commit()时会更安全。这是为什么我喜欢用commit()
  • 删除单个值用remove,删除所有值用clear()
  // get Editor object
  SharedPreferences.Editor editor = preferences.edit();
  // put values in editor
  editor.putBoolean("key", value);  
  editor.put..("key", value);
  // remove single value by key
  editor.remove("key");
  // remove all values
  editor.clear();
  // commit your putted values to the SharedPreferences object synchronously
  // returns true if success 同步提交保存 成功返回true
  boolean result = editor.commit();
  // do the same as commit() but asynchronously (faster but not safely)
  // returns nothing 异步保存 不返回结果
  editor.apply();

性能和技巧

SharedPreferences是一个单例对象所以你可以轻易的获取它的多个引用,它只有在第一次调用getSharedPreferences的时候打开文件,只为它创建一个引用。(ps:真啰嗦,其实就是只实例化一次,后面调用会越来越快,看下面的例子)

  // There are 1000 String values in preferences
  SharedPreferences first = context.getSharedPreferences("com.example.app", Context.MODE_PRIVATE);  
  // call time = 4 milliseconds第一次读取文件花了4毫秒
  SharedPreferences second = context.getSharedPreferences("com.example.app", Context.MODE_PRIVATE);  
  // call time = 0 milliseconds第二次0
  SharedPreferences third = context.getSharedPreferences("com.example.app", Context.MODE_PRIVATE);  
  // call time = 0 milliseconds第三次0

因为是单例对象你可以随意更改它多个实例的内容不用担心他们的数据会不同

  first.edit().putInt("key",15).commit();
  int firstValue = first.getInt("key",0)); // firstValue is 15  
  int secondValue = second.getInt("key",0)); // secondValue is also 15

当你第一次调用get方法时,它会通过key解析获取到value然后会把它加到map中,第二次调用get会直接从map拿出,不用解析。

  first.getString("key", null)  
  // call time = 147 milliseconds 第一次拿需要解析比较慢,然后会放到map中
  first.getString("key", null)  
  // call time = 0 milliseconds 第二次直接从map中拿 ,不用解析 很快
  second.getString("key", null)  
  // call time = 0 milliseconds 和第二次一样
  third.getString("key", null)  
  // call time = 0 milliseconds

记住越大的Preference对象它的get,commit,apply,remove和clear等操作时间越长。所以推荐把你的数据分割成不同的小对象。

你的Preference不会在你的app更新后移除,所以有时候你需要创建一个迁移方案。例如你的app需要在启动的时候解析本地的JSON,只有在第一次启动执行然后保存boolean的标识wasLocalDataLoaded,一段时间后你更新了JSON发布了一个新版本,用户会更新app但是他们不会加载新的JSON因为他们在第一个版本已经做了。

  public class MigrationManager {  
      private final static String KEY_PREFERENCES_VERSION = "key_preferences_version";
      private final static int PREFERENCES_VERSION = 2;
      public static void migrate(Context context) {
          SharedPreferences preferences = context.getSharedPreferences("pref", Context.MODE_PRIVATE);
          checkPreferences(preferences);
      }
      private static void checkPreferences(SharedPreferences thePreferences) {
          final double oldVersion = thePreferences.getInt(KEY_PREFERENCES_VERSION, 1);
          if (oldVersion < PREFERENCES_VERSION) {
              final SharedPreferences.Editor edit = thePreferences.edit();
              edit.clear();
              edit.putInt(KEY_PREFERENCES_VERSION, currentVersion);
              edit.commit();
          }
      }
  }

SharedPreferences保存在app的data文件夹下xml文件里面

  // yours preferences 我们自己创建的
  /data/data/YOUR_PACKAGE_NAME/shared_prefs/YOUR_PREFS_NAME.xml
  // default preferences 默认
  /data/data/YOUR_PACKAGE_NAME/shared_prefs/YOUR_PACKAGE_NAME_preferences.xml

示例代码

    public class PreferencesManager {
        private static final String PREF_NAME = "com.example.app.PREF_NAME";
        private static final String KEY_VALUE = "com.example.app.KEY_VALUE";
        private static PreferencesManager sInstance;
        private final SharedPreferences mPref;
        private PreferencesManager(Context context) {
            mPref = context.getSharedPreferences(PREF_NAME, Context.MODE_PRIVATE);
        }
        public static synchronized void initializeInstance(Context context) {
            if (sInstance == null) {
                sInstance = new PreferencesManager(context);
            }
        }
        public static synchronized PreferencesManager getInstance() {
            if (sInstance == null) {
                throw new IllegalStateException(PreferencesManager.class.getSimpleName() +
                        " is not initialized, call initializeInstance(..) method first.");
            }
            return sInstance;
        }
        public void setValue(long value) {
            mPref.edit()
                    .putLong(KEY_VALUE, value)
                    .commit();
        }
        public long getValue() {
            return mPref.getLong(KEY_VALUE, 0);
        }
        public void remove(String key) {
            mPref.edit()
                    .remove(key)
                    .commit();
        }
        public boolean clear() {
            return mPref.edit()
                    .clear()
                    .commit();
        }
    }

到此这篇关于Android SharedPreferences数据存储详解的文章就介绍到这了,更多相关Android SharedPreferences内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • android canvas使用line画半圆

    android canvas使用line画半圆

    这篇文章主要为大家详细介绍了android canvas使用line画半园,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2020-02-02
  • 亲自动手编写Android通用刷新控件

    亲自动手编写Android通用刷新控件

    这篇文章主要记录了亲自动手编写Android通用刷新控件的详细过程,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-06-06
  • Android工程师面试题大全

    Android工程师面试题大全

    这篇文章主要为大家分享了Android工程师面试题,内容很丰富,结合网上各位的大神秒下的面试题做个总结,感兴趣的小伙伴们可以参考一下
    2016-02-02
  • android surfaceView实现播放视频功能

    android surfaceView实现播放视频功能

    这篇文章主要为大家详细介绍了android surfaceView实现播放视频功能,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2020-05-05
  • Android Universal ImageLoader 缓存图片

    Android Universal ImageLoader 缓存图片

    Universal Image Loader for Android的目的是为了实现异步的网络图片加载、缓存及显示,支持多线程异步加载,通过本文给大家介绍Android Universal ImageLoader缓存图片相关资料,涉及到imageloader缓存图片相关知识,对imageloader缓存图片相关知识感兴趣的朋友一起学习
    2016-01-01
  • Android开发笔记之:一分钟学会使用Logcat调试程序的详解

    Android开发笔记之:一分钟学会使用Logcat调试程序的详解

    本篇文章是对Android中Logcat调试程序的使用进行了详细的分析介绍,需要的朋友参考下
    2013-05-05
  • Android仿网易新闻图片详情下滑隐藏效果示例代码

    Android仿网易新闻图片详情下滑隐藏效果示例代码

    这篇文章主要给大家介绍了关于利用Android如何仿网易新闻图片详情下滑隐藏效果的相关资料,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2018-07-07
  • Android开发利器之pidcat安装方式

    Android开发利器之pidcat安装方式

    pidcat 是Android届JakeWharton大神开发的一款命令行工具,堪称Android开发利器,它能方便Android程序猿捕获日志,过滤日志,定位程序问题,超级好用。这篇文章给大家介绍了Android开发利器之pidcat,需要的朋友可以参考下
    2019-05-05
  • Android传递Bitmap对象在两个Activity之间

    Android传递Bitmap对象在两个Activity之间

    这篇文章主要介绍了Android传递Bitmap对象在两个Activity之间的相关资料,需要的朋友可以参考下
    2016-01-01
  • Android如何在App中启动系统闹钟

    Android如何在App中启动系统闹钟

    这篇文章主要为大家详细介绍了Android如何在App中启动系统闹钟,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2018-01-01

最新评论