SharedPreference存储精炼详解

image
  • 前期基础知识储备

之前做应用时碰到一个问题:在用户初次进入某个界面时,需要弹出一个提示,或者在EditText上显示一个hint;而用户之后进入就不再弹出提示了。思考之后就选择了SharedPreferences这个轻型的数据存储方式。存储一个布尔型值作为key,根据这个key作为判断是否是第一次进入此界面。

protected void onCreate(@Nullable Bundle savedInstanceState) {
        ... ...
        preferences = PreferenceManager.getDefaultSharedPreferences(this);
        boolean isStarted = preferences.getBoolean(STARTED, false);
        if ((!isStarted) || ConfigApp.DEBUG) {
            if (isDataNull) {
                mInputFormula.setText("x^2+2x+1=9");
                firstStarted();
            }
        }
    }

//应用第一次启动时调用该方法 用于改变“value”值
private void firstStarted() {
        final SharedPreferences.Editor editor = preferences.edit();
        editor.putBoolean(STARTED, true);
        editor.apply();
    }

SharedPreferences的本质是基于XML文件存储key-value键值对数据,通常用来存储一些简单的配置信息,用Sqlite数据库来存放并不划算,因为数据库连接跟操作等耗时大大影响了程序的效率。其存储位置在/data/data/<包名>/shared_prefs目录下。

“SharedPreference”是Android的四大数据持久化技术之一,其他三个分别是SQLite、Content Provider 和 File。

存储特点:

①保存基本的数据类型:int、long、boolean、String、Float、Set和Map这些数据类型,不支持自定义数据类型;

②4.2之后只能用于应用内部数据存储和共享,4.2之前支持跨应用共享;

③key-value键值对数据,更新时,如果已经插入的key存在,那么将更新原来的key;那么将更新原key所对应的value;

image

④用户应用程序一旦卸载,存在应用数据目录下的shared_prefs文件也会被删除。

  • 上代码,具体实现

1.存放数据信息,步骤如下:

①打开Preferences,名称为user,如果存在则打开它,否则创建新的Preferences;

创建Preference实例对象的方法有三种:

SharedPreference preference=getSharedPreferences("user", Context.MODE_PRIVATE);

SharedPreference preference=PreferenceManager.getDefaultSharedPreferences(context);

SharedPreference preference=context.getPreference;

a.Context.getSharedPreferences(文件名称,操作模式)

文件名称不存在就会创建一个,操作模式有四种:

MODE_PRIVATE:默认操作模式,直接在把第二个参数写0就是默认使用这种操作模式,这种模式表示只有当前的应用程序才可以对当前这个SharedPreferences文件进行读写。

MODE_MULTI_PRIVATE:追加模式,用于当前应用程序内部多个线程共同操作一个SharedPreferences文件。

MODE_WORLD_READABLE:可读模式,用于应用间实现数据共享,即创建出来的文件可被其他应用读取;

MODE_WORLD_WRITEABLE:可写模式,用于应用间实现数据共享,即创建的文件允许其他应用对其进行写入;

注:MODE_WORLD_READABLE和MODE_WORLD_WRITEABLE这两种模式已经在android 4.2版本以后废弃了。

b.PreferenceManager.getDefaultSharedPreferences(Context context)

使用这个方法会自动使用当前程序的包名作为前缀来命名SharedPreferences文件;注意这里需要传入上下文Context作为参数,如果是在Activity内部使用,可直接传入context;如果是在其他类内部使用,需传入的应用程序级别的上下文。

c.Activity.getPreferences(操作模式)

使用这个方法会自动将当前活动的类名作为SharedPreferences的文件名,调用Activity对象的getPreferences()方法获得的SharedPreferences对象只能在该Activity中使用。而第一种调用Context对象的getSharedPreferences()方法获得的SharedPreferences对象可以被同一应用程序下的其他组件共享。所以第一种获取Preference实例的方法使用最多。

②让user处于被编辑状态

Editor editor=preferences.edit(); 

③存放数据

String name="xixi"; 
String age="22"; 
editor.putString("name", name); 
editor.putString("age", age);

④提交

editor.commit();

2.读取数据信息,步骤如下:

①获取Preferences

SharedPreferences preferences=getSharedPreferences("user", Context.MODE_PRIVATE); 

②取出数据

String name=preferences.getString("name", "null"); 
String age=preferences.getString("age", "0"); 

3.SharedPreference其他操作

①清除特定数据

SharedPreferences.Editor editor = user.edit();
editor.remove("KEY");
editor.commit();

②清除所有数据

SharedPreferences.Editor editor = user.edit();
editor.clear();
editor.commit();

③检索特定数据

SharedPreference preference=getSharedPreferences("user", Context.MODE_PRIVATE);
boolean isContains=preference.contains("key");
  • SharedPreference保存用户设置实例

  • protected void onCreate(@Nullable Bundle savedInstanceState) {
            ... ...
            wSharedPreferences = getSharedPreferences("window", Context.MODE_PRIVATE);;
            isWindowSharedOpen = wSharedPreferences.getBoolean("isWindowOpen", false);
            if (isWindowSharedOpen) {
                mWCheckBox.setChecked(true);
            }
            vSharedPreferences = getSharedPreferences("vibration",Context.MODE_PRIVATE);
            isVibrationShareOpen = vSharedPreferences.getBoolean("isVibrationOpen",false);
            if (isVibrationShareOpen){
                mVCheckBox.setChecked(true);
            }          
    }
    
        private boolean isWindowSharedOpen,isVibrationShareOpen;
        private boolean b = false;
        private boolean a = false;
        private SharedPreferences wSharedPreferences,vSharedPreferences;
            private CompoundButton.OnCheckedChangeListener listener = new CompoundButton.OnCheckedChangeListener() {
            @Override
            public void onCheckedChanged(CompoundButton buttonView, boolean isChecked) {
                switch (buttonView.getId()) {
                    case R.id.window_check_box:
                        if (!a) {
                            wSharedPreferences.edit().putBoolean("isWindowOpen", true).commit();
                            Toast.makeText(BasicCalculatorActivity.this, "悬浮窗开", Toast.LENGTH_SHORT).show();
                            //开启悬浮窗
                            askForPermission();
                            a = true;
                        } else if (a) {
                            wSharedPreferences.edit().putBoolean("isWindowOpen", false).commit();
                            Toast.makeText(BasicCalculatorActivity.this, "悬浮窗关", Toast.LENGTH_SHORT).show();
                            //关闭悬浮窗
                            stopService(floatWinIntent);
                            a = false;
                        }
                        break;
                    case R.id.vibration_check_box:
                        if (!b) {
                            vSharedPreferences.edit().putBoolean("isVibrationOpen", true).commit();
                            Toast.makeText(BasicCalculatorActivity.this, "振动开", Toast.LENGTH_SHORT).show();
                            //开启振动 所有的键盘都在碎片里 要发送广播
                            sendBroadcast(new Intent(BasboardFragment.OPENVIBRATION));
                            sendBroadcast(new Intent(KeyboardFragment.OPENVIBRATION));
                            b = true;
                        } else if (b) {
                            vSharedPreferences.edit().putBoolean("isVibrationOpen", false).commit();
                            Toast.makeText(BasicCalculatorActivity.this, "振动关", Toast.LENGTH_SHORT).show();
                            //关闭振动
                            sendBroadcast(new Intent(BasboardFragment.CLOSEVIBRATION));
                            sendBroadcast(new Intent(KeyboardFragment.CLOSEVIBRATION));
                            b = false;
                        }
                        break;
                }
            }
        };
    

    上面是CheckBox的点击保存事件,接下来是RadioButton的点击保存事件,注意两个控件的点击按钮逻辑处理不同:

  • public class MainActivity extends AppCompatActivity implements View.OnClickListener {
    
        private PopupWindow popupWindow;
        private View popupView;
        private Button testBtn;
        private RadioButton choice_1, choice_2, result_1, result_2;
    
        @Override
        protected void onCreate(Bundle savedInstanceState) {
            super.onCreate(savedInstanceState);
            setContentView(R.layout.activity_main);
            initPopoupWindow();
            testBtn = (Button) findViewById(R.id.test_btn);
            testBtn.setOnClickListener(new View.OnClickListener() {
                @Override
                public void onClick(View v) {
                    showPopupWindow();
                }
            });
    
            result_1 = (RadioButton) findViewById(R.id.result_1);
            result_2 = (RadioButton) findViewById(R.id.result_2);
    
            /*处理第二个问题,保存SharedPreference存储的动作
             * 第三个问题摆在眼前,处理popupwindow本身的存储逻辑 不能放在应用初始化时,否则报空
             * */
            choice_1Preference = getSharedPreferences("choice_1", 0);
            isShared1 = choice_1Preference.getBoolean("choice_1_key", false);
            if (isShared1) {
                result_1.setChecked(true);
                choice_1.setChecked(true);
            }
            choice_2Preference = getSharedPreferences("choice_2", 0);
            isShared2 = choice_2Preference.getBoolean("choice_2_key", false);
            if (isShared2) {
                result_2.setChecked(true);
                choice_2.setChecked(true);
            }
    
        }
    
        /*
        * 处理第三个问题 popupwindow自身的存储 将其变量做成成员变量 待处理的逻辑还有两个:①进入应用时pop的存储还原;②点击pop时的存储还原
        * */
        private void initPopoupWindow(){
            popupView = LayoutInflater.from(MainActivity.this).inflate(R.layout.popupview, null);
            popupWindow = new PopupWindow(popupView, ViewGroup.LayoutParams.WRAP_CONTENT, ViewGroup.LayoutParams.WRAP_CONTENT, true);
            choice_1 = (RadioButton) popupView.findViewById(R.id.choice_1);
            choice_1.setOnClickListener(this);
            choice_2 = (RadioButton) popupView.findViewById(R.id.choice_2);
            choice_2.setOnClickListener(this);
        }
    
        private void showPopupWindow() {
            popupWindow.setContentView(popupView);
            popupWindow.setOutsideTouchable(true);
            popupWindow.showAsDropDown(testBtn);
            popupWindow.setAnimationStyle();
        }
    
        private SharedPreferences choice_1Preference, choice_2Preference;
        private boolean isShared1, isShared2;
    
        /*
         * 处理第一个问题:单选框和复选框自带逻辑本身就不一样,所以对判断的处理也是不一样
         * */
        @Override
        public void onClick(View v) {
            switch (v.getId()) {
                case R.id.choice_1:
                    choice_1Preference.edit().putBoolean("choice_1_key", true).commit();
                    choice_2Preference.edit().putBoolean("choice_2_key", false).commit();
                    result_1.setChecked(true);
                    break;
                case R.id.choice_2:
                    choice_2Preference.edit().putBoolean("choice_2_key", true).commit();
                    choice_1Preference.edit().putBoolean("choice_1_key", false).commit();
                    result_2.setChecked(true);
            }
        }
    }
    
    
  • 延伸知识

image

1)File类的四种构造方法:

public File(File dir,String name)

Public File(String path)

public File(String dirPath,String name)

public File(URI uri)

2)文件存储之获取 — 应用数据目录/手机外部存储根目录

①应用数据目录:Context.getExternalFilesDir("file1");

返回路径:-/storage/sdcard0/Android/data/com.srain.cube.sample/files/file1

用于存储应用内部数据,该目录下的文件会随着应用删除而一起删除,比如应用内部下载的图标、临时文件等等。

②手机外部存储根目录: Environment.getExternalStoragePublicDirectory("");

返回的路径名:- /storage/sdcard0

该目录用于存储应用产生的对用户有价值的数据,不随着应用删除而删除,比如照片、歌曲,视频等文件等等

3)实例 应用数据目录中保存和删除图片

public class MainActivity extends AppCompatActivity {
    private static final String TAG = "MainActivity";
    private Button saveBtn, deleteBtn;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        if (MarshmallowPermissions.checkPermissionForCamera(MainActivity.this)) {
            MarshmallowPermissions.requestPermissionForCamera(MainActivity.this);
        }
        saveBtn = findViewById(R.id.save);
        saveBtn.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View view) {
                saveImageToGallery(MainActivity.this, "SI1");
            }
        });
        deleteBtn = findViewById(R.id.delete);
        deleteBtn.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View view) {
                if (appDir != null) {
                    deleteDirWihtFile(appDir);
                }
            }
        });
    }

    private File file;
    private File appDir;

    public void saveImageToGallery(Context context, String fileName) {
        // 保存图片
        appDir = new File(context.getExternalFilesDir(""), "测试文件夹");
        if (!appDir.exists()) {
            appDir.mkdir();
        }
        file = new File(appDir, fileName);
        try {
            FileOutputStream fos = new FileOutputStream(file);
            Bitmap btImage = BitmapFactory.decodeResource(getResources(), R.drawable.filter_lut_portrait_m10);
            btImage.compress(Bitmap.CompressFormat.JPEG, 100, fos);
            Log.d(TAG, "saveImageToGallery_Path: " + file.getAbsolutePath());
            Toast.makeText(context, "save success", Toast.LENGTH_SHORT).show();
            fos.flush();
            fos.close();
        } catch (FileNotFoundException e) {
            e.printStackTrace();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    private void deleteDirWihtFile(File dir) {
        Log.d(TAG, "deleteDirWihtFile: " + dir.getPath());
        if (dir == null || !dir.exists() || !dir.isDirectory())
            return;
        for (File file : dir.listFiles()) {
            if (file.getName().equals("SI1"))
                file.delete(); // 删除所有文件
            Toast.makeText(this, "删除成功", Toast.LENGTH_SHORT).show();
        }
    }
}

path —— /storage/emulated/0/Android/data/com.example.recycler_date/files/测试文件夹

Android之不要滥用SharedPreference

注:博主博客会同步发布到CSDN,欢迎读者阅读

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,386评论 6 506
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,142评论 3 394
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,704评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,702评论 1 294
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,716评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,573评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,314评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,230评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,680评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,873评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,991评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,706评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,329评论 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,910评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,038评论 1 270
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,158评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,941评论 2 355

推荐阅读更多精彩内容