Android基础#41：Android数据存储之SharedPreferences

不念不忘少年蓝@ 2023-10-17 14:49 7阅读 0赞

**内容简介：**

Android系统提供了多钟数据存储方式，其中，SharedPreferences是一个轻量级存储类，主要是保存一些常用的配置，例如，窗口状态，用户的登录状态等。

SharedPreferences提供了Android平台常规的Long长整形、Int整形、String字符串型的保存。SharedPreferences以xml文件的方式存储这些数据。它的效率对于常规的轻量级而言比SQLite要好不少，如果真的存储量不大可以考虑自己定义文件格式。xml 处理时Dalvik会通过自带底层的本地XML Parser解析，比如XMLpull方式，这样对于内存资源占用比较好。

**基本原理：**  
它的本质是基于XML文件存储key-value键值对数据，通常用来存储一些简单的配置信息。  
其存储位置在/data/data/<包名>/shared\_prefs目录下。  
SharedPreferences对象本身只能获取数据而不支持存储和修改，存储修改是通过Editor对象实现。

**实现步骤与示例：**

实现SharedPreferences存储的步骤如下： 　　  
一、根据Context获取SharedPreferences对象 　　  
二、利用edit()方法获取Editor对象。 　　  
三、通过Editor对象存储key-value键值对数据。 　　  
四、通过commit()方法提交数据。

**下面是示例代码：**

public class MainActivity extends Activity {   
     @Override
         public void onCreate(Bundle savedInstanceState) {
            super.onCreate(savedInstanceState);
            setContentView(R.layout.main);
           
            //获取SharedPreferences对象
            Context ctx = MainActivity.this;      
            SharedPreferences sp = ctx.getSharedPreferences("SP", MODE_PRIVATE);
            //存入数据
            Editor editor = sp.edit();
            editor.putString("STRING_KEY", "string");
            editor.putInt("INT_KEY", 0);
            editor.putBoolean("BOOLEAN_KEY", true);
            editor.commit();
           
            //返回STRING_KEY的值
            Log.d("SP", sp.getString("STRING_KEY", "none"));
            //如果NOT_EXIST不存在，则返回值为"none"
            Log.d("SP", sp.getString("NOT_EXIST", "none"));
         }
    
    }

说明：

这段代码执行过后，即在/data/data/com.test/shared\_prefs目录下生成了一个SP.xml文件，一个应用可以创建多个这样的xml文件。

SharedPreferences对象与SQLite数据库相比，免去了创建数据库，创建表，写SQL语句等诸多操作，相对而言更加方便，简洁。但是SharedPreferences也有其自身缺陷，比如其职能存储boolean，int，float，long和String五种简单的数据类型，比如其无法进行条件查询等。所以不论SharedPreferences的数据存储操作是如何简单，它也只能是存储方式的一种补充，而无法完全替代如SQLite数据库这样的其他数据存储方式。

**一个通用的Pref存储类：**

PrefTmpUtil.java:

package com.test.util;
    
    import android.content.Context;
    import android.content.SharedPreferences;
    
    public class PrefTmpUtil {
    
        //pref file
        private static final String Pref_File = "pref1"; //tmp_d2.xml
    
        public static final String Key_Save_Pass = "key_save_pass";
        private static SharedPreferences preferences = null;
    
        private synchronized static boolean init(Context context) {
            if (preferences != null)
                return true;
            if (context != null) {
                preferences = context.getSharedPreferences(
                        Pref_File,
                        Context.MODE_PRIVATE
                );
                return true;
            }
            return false;
        }
    
        /**
         *
         * @param context
         * @param key
         * @return null: ; ""; value
         */
        public static String GetString(Context context, String key) {
            try {
                if (!init(context)) {
                    return null;
                }
                synchronized (PrefTmpUtil.class) {
                    if (preferences == null)
                        return null;
                    String str = preferences.getString(key, "");
                    return str;
    
                }
            } catch (Exception e) {
                e.printStackTrace();
            }
            return null;
        }
    
        public static boolean SetString(Context context, String key, String data) {
            try {
                if (!init(context)) {
                    return false;
                }
    
                synchronized (PrefTmpUtil.class) {
                    if (preferences == null)
                        return false;
                }
                preferences.edit().putString(key, data).apply();
                return true;
            } catch (Exception e) {
                e.printStackTrace();
            }
            return false;
        }
    
        public static boolean clean(Context context) {
            try {
                if (!init(context)) {
                    return false;
                }
    
                synchronized (PrefTmpUtil.class) {
                    if (preferences == null)
                        return false;
                }
                preferences.edit().clear();
                return true;
            } catch (Exception e) {
                e.printStackTrace();
            }
            return false;
        }
    }

另外，说到SharedPreferences，就不得不提到Android中的PreferenceActivity，看到了么，都有Preference，Android系统本身就大量用到了PreferenceActivity来对系统进行信息配置和管理，例如，无线网络设置界面，MusicPlayer设置界面等.

--------------------