4、Android之SharedPreferences使用及封装

最新推荐文章于 2024-12-05 14:09:19 发布
原创 最新推荐文章于 2024-12-05 14:09:19 发布 · 885 阅读 · 0 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#android #sp #sharedpres

本文详细介绍了Android中的SharedPreferences机制，包括其定义、基本使用方法及注意事项，并提供了一个实用的SPUtil工具类封装示例。

1、定义

先来看看Android官方API对于SharedPreferences（以下简称SP）的定义：SP是通过getSharedPreferences(String,int)返回的用于访问和储存设置（Preferences，我本人理解为设置）数据的接口。对于许多特定的设置的数据集，存在一个单例的类能够将数据集给所有客户分享。修改设置数据必须通过SharedPreferences.Editor对象来确保设置的值保持一个一致的状态并且当它们提交时能受控制。SP对象通过get()方法必须在Application中保持一成不变。简单来说，SharedPreferences是一种轻型的数据存储方式，基于XML文件存储key-value键值对（只能存储简单的类型）数据，常用来存储一些简单的配置信息。

2、基本使用

下面是使用SharedPreferences的基本步骤：

  1. 获得SharedPreferences对象；
  2. 获得SharedPreferences.Editor对象；
  3. 通过Editor接口的putXxx方法保存key-value对其中Xxx表示不同的数据类型；
  4. 通过Editor接口的commit方法保存key-value对。

（注意：上述API定义已经说得很清楚了，SharedPreferences对象本身只能获取数据而不支持存储和修改，存储修改是通过Editor对象来实现的，所以SP对象不能直接用于写入数据）

核心代码如下：

SharedPreferences pref=PreferenceManager.                        getDefaultSharedPreferences(Context context);
    //获取系统默认的SharedPreferences对象（Context中传入上下文，如MainActivity.this）;
//或者：SharedPreferences pref = getSharedPreferences("XML文件名",“读取权限如MODE_PRIVATE");
Editor editor = pref.edit();//获得Editor对象；
editor.putString(key,value);//保存key-value对(有多种类型如putInt等)；
editor.remove(key);//删除键值对；
editor.commit();//一定要提交；
pref.getString(key,defValue);//用于取值，key对应要取出的值的key,defValue是没取到值时的默认值；

3、SPUtil工具类封装

import android.content.Context;
import android.content.SharedPreferences;

import java.io.Serializable;
import java.util.Set;


public class SPStore {
    //自己定义sp名称
    public static String STORE_NAME_SETTING = "Wd_Study";

    /**
     * 获取sp句柄
     * @param context       页面句柄
     * @param storeName     存储名称
     * @return
     */
    private static SharedPreferences getSettingPreferences(Context context, String storeName) {
        SharedPreferences setting = null;
        setting = context.getSharedPreferences(storeName, Context.MODE_PRIVATE);
        return setting;
    }

    /*------------------- string -----------------------*/

    /**
     * 获取指定sp名称中相应key值 <br>
     * 使用样例：<br>
     *     SPStore.getString(ctx, "storeName", "key1")
     * @param ctx           页面句柄
     * @param storeName     保存名称
     * @param key           key值
     * @return
     */
    public static String getString(Context ctx, String storeName, String key) {
        String value = null;
        getSettingPreferences(ctx, storeName).edit();
        if (getSettingPreferences(ctx, storeName).contains(key)) {
            value = getSettingPreferences(ctx, storeName).getString(key, null);
        }
        return value;
    }

    /**
     * 获取指定sp名称中相应key值 <br>
     * 使用样例：<br>
     *     SPStore.getString(ctx, "storeName", "key1", "value1")
     * @param ctx
     * @param storeName
     * @param key
     * @param defaultValue      默认值
     * @return
     */
    public static String getString(Context ctx, String storeName, String key, String defaultValue) {
        String value = null;
        getSettingPreferences(ctx, storeName).edit();
        if (getSettingPreferences(ctx, storeName).contains(key)) {
            value = getSettingPreferences(ctx, storeName).getString(key, defaultValue);
        }else {
            value = defaultValue;
        }
        return value;
    }

    /**
     * 获取sp中key对应的值
     * 使用样例：<br>
     *     SPStore.getString(ctx, "storeName")
     * @param ctx       页面句柄
     * @param key       key值
     * @return
     */
    public static String getString(Context ctx, String key) {
        return getString(ctx, STORE_NAME_SETTING, key);
    }

    public static String getStringWithDefault(Context ctx, String key, String defaultValue) {
        return getString(ctx, STORE_NAME_SETTING, key, defaultValue);
    }

    /**
     * 存放数据到指定sp中
     * @param ctx
     * @param storeName
     * @param key
     * @param value
     */
    public static void putString(Context ctx, String storeName, String key, Serializable value) {
        SharedPreferences.Editor edit = getSettingPreferences(ctx, storeName).edit();
        edit.putString(key, "" + value);
        edit.commit();
    }

    /**
     * 存放数据到sp中
     * @param ctx
     * @param key
     * @param value
     */
    public static void putString(Context ctx, String key, Serializable value) {
        putString(ctx, STORE_NAME_SETTING, key, value);
    }

    /*------------------- int -----------------------*/

    public static int getInt(Context ctx, String storeName, String key) {
        int value = -1;
        getSettingPreferences(ctx, storeName).edit();
        if (getSettingPreferences(ctx, storeName).contains(key)) {
            value = getSettingPreferences(ctx, storeName).getInt(key, -1);
        }
        return value;
    }

    public static int getInt(Context ctx, String storeName, String key, int defaultValue) {
        int value = -1;
        getSettingPreferences(ctx, storeName).edit();
        if (getSettingPreferences(ctx, storeName).contains(key)) {
            value = getSettingPreferences(ctx, storeName).getInt(key, defaultValue);
        }else {
            value = defaultValue;
        }
        return value;
    }

    public static int getInt(Context ctx, String key) {
        return getInt(ctx, STORE_NAME_SETTING, key);
    }

    public static int getInt(Context ctx, String key, int defaultValue) {
        return getInt(ctx, STORE_NAME_SETTING, key, defaultValue);
    }

    public static void putInt(Context ctx, String storeName, String key, int value) {
        SharedPreferences.Editor edit = getSettingPreferences(ctx, storeName).edit();
        edit.putInt(key, value);
        edit.commit();
    }

    public static void putInt(Context ctx, String key, int value) {
        putInt(ctx, STORE_NAME_SETTING, key, value);
    }

    /*------------------- long -----------------------*/

    public static long getLong(Context ctx, String storeName, String key) {
        long value = -1l;
        getSettingPreferences(ctx, storeName).edit();
        if (getSettingPreferences(ctx, storeName).contains(key)) {
            value = getSettingPreferences(ctx, storeName).getLong(key, -1l);
        }
        return value;
    }

    public static long getLong(Context ctx, String storeName, String key, long defaultValue) {
        long value = -1l;
        getSettingPreferences(ctx, storeName).edit();
        if (getSettingPreferences(ctx, storeName).contains(key)) {
            value = getSettingPreferences(ctx, storeName).getLong(key, defaultValue);
        }else {
            value = defaultValue;
        }
        return value;
    }

    public static long getLong(Context ctx, String key) {
        return getLong(ctx, STORE_NAME_SETTING, key);
    }

    public static long getLong(Context ctx, String key, long defaultValue) {
        return getLong(ctx, STORE_NAME_SETTING, key, defaultValue);
    }

    public static void putLong(Context ctx, String storeName, String key, long value) {
        SharedPreferences.Editor edit = getSettingPreferences(ctx, storeName).edit();
        edit.putLong(key, value);
        edit.commit();
    }

    public static void putLong(Context ctx, String key, long value) {
        putLong(ctx, STORE_NAME_SETTING, key, value);
    }

    /*------------------- float -----------------------*/

    public static float getFloat(Context ctx, String storeName, String key) {
        float value = -1f;
        getSettingPreferences(ctx, storeName).edit();
        if (getSettingPreferences(ctx, storeName).contains(key)) {
            value = getSettingPreferences(ctx, storeName).getFloat(key, -1f);
        }
        return value;
    }

    public static float getFloat(Context ctx, String storeName, String key, float defaultValue) {
        float value = -1f;
        getSettingPreferences(ctx, storeName).edit();
        if (getSettingPreferences(ctx, storeName).contains(key)) {
            value = getSettingPreferences(ctx, storeName).getFloat(key, defaultValue);
        }else {
            value = defaultValue;
        }
        return value;
    }

    public static float getFloat(Context ctx, String key) {
        return getFloat(ctx, STORE_NAME_SETTING, key);
    }

    public static float getFloat(Context ctx, String key, float defaultValue) {
        return getFloat(ctx, STORE_NAME_SETTING, key, defaultValue);
    }

    public static void putFloat(Context ctx, String storeName, String key, float value) {
        SharedPreferences.Editor edit = getSettingPreferences(ctx, storeName).edit();
        edit.putFloat(key, value);
        edit.commit();
    }

    public static void putFloat(Context ctx, String key, float value) {
        putFloat(ctx, STORE_NAME_SETTING, key, value);
    }

    /*------------------- bool -----------------------*/

    public static boolean getBoolean(Context ctx, String storeName, String key) {
        boolean value = false;
        getSettingPreferences(ctx, storeName).edit();
        if (getSettingPreferences(ctx, storeName).contains(key)) {
            value = getSettingPreferences(ctx, storeName).getBoolean(key, false);
        }
        return value;
    }

    public static boolean getBoolean(Context ctx, String storeName, String key, boolean defaultValue) {
        boolean value = false;
        getSettingPreferences(ctx, storeName).edit();
        if (getSettingPreferences(ctx, storeName).contains(key)) {
            value = getSettingPreferences(ctx, storeName).getBoolean(key, defaultValue);
        }else {
            value = defaultValue;
        }
        return value;
    }

    public static boolean getBoolean(Context ctx, String key) {
        return getBoolean(ctx, STORE_NAME_SETTING, key);
    }

    public static boolean getBoolean(Context ctx, String key, boolean defaultValue) {
        return getBoolean(ctx, STORE_NAME_SETTING, key, defaultValue);
    }

    public static void putBoolean(Context ctx, String storeName, String key, boolean value) {
        SharedPreferences.Editor edit = getSettingPreferences(ctx, storeName).edit();
        edit.putBoolean(key, value);
        edit.commit();
    }

    public static void putBoolean(Context ctx, String key, boolean value) {
        putBoolean(ctx, STORE_NAME_SETTING, key, value);
    }

    /*------------------- set string -----------------------*/

    public static Set<String> getStringSet(Context ctx, String storeName, String key) {
        Set<String> value = null;
        getSettingPreferences(ctx, storeName).edit();
        if (getSettingPreferences(ctx, storeName).contains(key)) {
            value = getSettingPreferences(ctx, storeName).getStringSet(key, null);
        }
        return value;
    }

    public static Set<String> getStringSet(Context ctx, String key) {
        return getStringSet(ctx, STORE_NAME_SETTING, key);
    }

    public static void putStringSet(Context ctx, String storeName, String key, Set<String> value) {
        SharedPreferences.Editor edit = getSettingPreferences(ctx, storeName).edit();
        edit.putStringSet(key, value);
        edit.commit();
    }

    public static void putStringSet(Context ctx, String key, Set<String> value) {
        putStringSet(ctx, STORE_NAME_SETTING, key, value);
    }

    /*------------------- object -----------------------*/

    // TODO: 16/7/6 未实现

//    public static <T> void getObject(Context ctx, String storeName, String key, T resObj) {
//        String value = null;
//        getSettingPreferences(ctx, storeName).edit();
//        if (getSettingPreferences(ctx, storeName).contains(key)) {
//            value = getSettingPreferences(ctx, storeName).getString(key, null);
//        }
//        Gson gson = new GsonBuilder().create();
//        resObj = gson.fromJson(value, T.class);
//    }
//
//    public static String getString(Context ctx, String key) {
//        return getString(ctx, STORE_NAME_SETTING, key);
//    }
//
//    public static void putString(Context ctx, String storeName, String key, Serializable value) {
//        SharedPreferences.Editor edit = getSettingPreferences(ctx, storeName).edit();
//        edit.putString(key, "" + value);
//        edit.commit();
//    }
//
//    public static void putString(Context ctx, String key, Serializable value) {
//        putString(ctx, STORE_NAME_SETTING, key, value);
//    }

    public static Set<String> getAllKey(Context context) {
        return getSettingPreferences(context, STORE_NAME_SETTING).getAll().keySet();
    }

    public static Set<String> getAllKey(Context context, String storeName) {
        return getSettingPreferences(context, storeName).getAll().keySet();
    }

    public static void clearStoreName(Context context, String storeName) {
        SharedPreferences.Editor edit = getSettingPreferences(context, storeName).edit();
        edit.clear();
        edit.apply();
    }
}
Android本地保存实用工具SpUtil 对SharedPreferences的简单封装
Johnwa的博客
08-04 1842
在Android开发中封装一个SharedPreferences工具，可以快速的对各数据类型进行本地化保存中，有效提高开发效率。 除了支持常用的几种数据类型，我们还可以通过Gson来对实体类、List类型以及HashMap来实现本地的保存和读取。 一、新建SpUtil.java工具类 构造函数定义好sharedPreferences存取数据的key值，获取editor对象、gson对象，最后使用单例模式实例化SpUtil。 public class SpUtil{ private final
Android-Android系统SharedPreferences进行的封装
08-13
Android系统SharedPreferences进行的封装
&nbsp;Android的SharedPreferences的使用
09-09
SharedPreferences是一种轻型的数据存储方式，它的本质是基于XML文件存储key-value键值对数据，通常用来存储一些简单的配置信息。其存储位置在/data/data/<包名>/shared_prefs目录下。SharedPreferences对象本身只能获取数据而不支持存储和修改，存储修改是通过Editor对象实现。比较经典的使用方式例如用户输入框对过往登录账户的存储。 详细介绍请参考博文：http://blog.youkuaiyun.com/stoppig/article/details/39157337
Android-简单的AndroidSharedPreferences封装
08-13
简单的Android SharedPreferences封装
Android SharedPreferences的使用
热门推荐
小小程序员 欢迎光临！专注于移动互联网！
10-18 7万+
SharedPreferences是Android平台上一个轻量级的存储类，主要是保存一些常用的配置比如窗口状态，一般在Activity中 重载窗口状态onSaveInstanceState保存一般使用SharedPreferences完成，它提供了Android平台常规的Long长 整形、Int整形、String字符串型的保存，它是什么样的处理方式呢?SharedPreferences类似过去W
Android 开发 Kotlin 封装 SharedPreferences 技术指南及实例解析
最新发布
12-10
内容概要：本文详细介绍了如何在 Kotlin 编程语言中优雅地封装 SharedPreferences。作者通过创建 MyPreferences 和通用的 Preference 类，实现了对字符串、整型等多种数据类型读写的高效封装，同时避免了代码重复并...
Android DataStore使用和封装
03-18
本文将深入探讨Android DataStore的使用方法及其封装技巧，旨在帮助开发者更好地理解和应用这一技术。 首先，我们需要了解DataStore的基本概念。DataStore基于Kotlin Coroutines和Flow，提供了异步操作，使得在读写...
Android SharedPreferences使用详解与封装实现
本文围绕标题《Android SharedPreferences详解[代码]》和描述内容展开深入解析，系统阐述SharedPreferences的核心原理、基本操作方法（增删改查）、使用场景、最佳实践以及封装优化技巧，并结合实际开发需求探讨如何...
Android SharedPreferences封装
loserOr的博客
08-28 1567
Android SharedPreferences封装 SharedPreferences是Android中一个轻量级的存储辅助类，用来保存一些常用的简单配置，在应用中作为一种简单的数据化持久，在本文中，封装了这种简单的存储方式，可以直接调用方法进行数据存储和提取。 下来就是我们封装的代码: SPManager public class SPManager { //定义存储用户名字段 priva...
Android ——SharedPreferences的简单封装
FranzLiszt的博客
11-18 2588
存储时将其转化为json字符串保存到缓存文件中，取时，解析json字符串即可，使用起来就跟存储字符串无异。参数三默认值，例如此key没有相对应的缓存value,则取默认值作为value。参数一Context上下文。参数一Context上下文。...
android缓存SharedPreferences封装
zhaoxiaoyu0822的博客
05-25 242
public class SP { //存储的sharedpreferences文件名 private static final String FILE_NAME = "1212121"; /** * 保存数据到文件 */ public static void saveData( String key, Object data){ String type = data.getClass().getSimpleName();
Android SharedPreferences的简单封装
原氢的专栏
02-28 6044
Android SharedPreferences的简单封装 SP数据保存在/data/data//shared_prefs目录下且以XML格式保存的。 SPUtils package com.example.shen.sputil.utils; import android.content.Context; import android.content.SharedPrefere
安卓开发SharedPreferences的封装
liuliuhelingdao的博客
10-09 439
/键 值}//键 默认值}//键 值}//键 默认值}//键 值}//键 默认值}//刪除 单个}//刪除 全部}}
Android SharedPreferences封装类SPUtils
洪勇坤的博客
05-02 633
package utils; import android.content.Context; import android.content.SharedPreferences; import java.lang.reflect.InvocationTargetException; import java.lang.reflect.Method; import java.util.Map; /...
Android开发之SharedPreferences的封装
六桥风月IT随笔
08-23 540
  对于大部分初学者来说，如果想利用SharedPreferences进行数据存储的话大部分人(包括本人)应该会这样： 存储： SharedPreferences sharedPreferences = getSharedPreferences(context.getPackageName(), Context.MODE_PRIVATE); Editor editor ...
Android中SharedPreferences共享参数的封装
qq_34942689的博客
03-24 937
Android中存在五种数据存储方式： 一：SharedPreferences共享参数存储 二：SQLite数据存储 三：File文件存储 四：ContentProvider内容提供者 五：网络存储。 在项目中也是经常用到这几大存储方式来进行数据存储，项目中会不止一次的用到这些存储方式中的某一个或者某几个，要是每次用到的时候都去写一次，这不免很麻烦，代码也很不清晰，这个时候就需要对相应
Android 封装一个SharedPreferencesUtil
weixin_44911775的博客
12-05 621
私有构造方法: 将构造方法设为私有，确保外部无法直接通过 new 来创建 SharedPreferencesUtils 实例，只能通过 getInstance 方法获取。SharedPreferences 的操作: 这个类封装了所有常用的 SharedPreferences 操作，如保存和获取字符串、整数、布尔值、列表等。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值