Android 数据保存 - SharedPreferences

2024-06-21 15:32
文章标签 数据 android 保存 sharedpreferences

本文主要是介绍Android 数据保存 - SharedPreferences，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

参考：

保存数据：https://developer.android.com/training/basics/data-storage/index.html

在应用过程中，可能会产生多种不同类型的数据，有些数据需要重复使用。Android 系统提供了多种方式来保存数据，包括使用 SharedPreferences API 保存共享首选项，保存本地文件以及数据库操作

主要内容

  1. SharedPreferences API
  2. SharedPreferencesUtil.java

SharedPreferences API

参考：

保存键值集

使用共享首选项

SharedPreferences

SharedPreferences API 可以 保存和检索原始数据类型的永久性键值对

原始数据类型包括

  • 布尔值
  • 浮点值
  • 整型值
  • 长整型
  • 字符串

获取 SharedPreferences 对象

创建新的共享首选项文件或访问现有的文件，可通过以下两种方法：

  • getSharedPreferences() — 如果您需要按照您用第一个参数指定的名称识别的多个共享首选项文件，请使用此方法。您可以从您的应用中的 任何 Context 调用此方法
  • getPreferences() — 如果您只需使用 Activity 的一个共享首选项，请从 Activity 中使用此方法。 因为此方法会检索属于该 Activity 的默认共享首选项文件，您无需提供名称

方法一：

/*** Retrieve and hold the contents of the preferences file 'name', returning* a SharedPreferences through which you can retrieve and modify its* values.  Only one instance of the SharedPreferences object is returned* to any callers for the same name, meaning they will see each other's* edits as soon as they are made.** @param name Desired preferences file. If a preferences file by this name* does not exist, it will be created when you retrieve an* editor (SharedPreferences.edit()) and then commit changes (Editor.commit()).* @param mode Operating mode.  Use 0 or {@link #MODE_PRIVATE} for the* default operation.** @return The single {@link SharedPreferences} instance that can be used*         to retrieve and modify the preference values.** @see #MODE_PRIVATE*/
public abstract SharedPreferences getSharedPreferences(String name, int mode);

参数 name 表示共享首选项文件名，如果不存在该共享首选项文件，则新建

参数 mode 表示文件操作模式，使用 0 或者 Context.MODE_PRIVATE 表示仅本应用可访问

方法二：

/*** Retrieve a {@link SharedPreferences} object for accessing preferences* that are private to this activity.  This simply calls the underlying* {@link #getSharedPreferences(String, int)} method by passing in this activity's* class name as the preferences name.** @param mode Operating mode.  Use {@link #MODE_PRIVATE} for the default*             operation.** @return Returns the single SharedPreferences instance that can be used*         to retrieve and modify the preference values.*/
public SharedPreferences getPreferences(int mode) {return getSharedPreferences(getLocalClassName(), mode);
}

就是默认使用 Activity 名作为方法一中的 name

写入共享首选项

  • 从 SharedPreferences 对象中调用方法 edit 得到 SharedPreferences.Editor

    /*** Create a new Editor for these preferences, through which you can make* modifications to the data in the preferences and atomically commit those* changes back to the SharedPreferences object.* * <p>Note that you <em>must</em> call {@link Editor#commit} to have any* changes you perform in the Editor actually show up in the* SharedPreferences.* * @return Returns a new instance of the {@link Editor} interface, allowing* you to modify the values in this SharedPreferences object.*/
Editor edit();

  • 调用 SharedPreferences.Editor 中的方法输入键值对

    putBoolean(String key, boolean value)
putFloat(String key, float value)
putInt(String key, int value)
putLong(String key, long value)
putString(String key, String value)
putStringSet(String key, Set<String> values)

  • 修改完成后，调用方法 commit() 提交

    /*** Commit your preferences changes back from this Editor to the* {@link SharedPreferences} object it is editing.  This atomically* performs the requested modifications, replacing whatever is currently* in the SharedPreferences.** <p>Note that when two editors are modifying preferences at the same* time, the last one to call commit wins.** <p>If you don't care about the return value and you're* using this from your application's main thread, consider* using {@link #apply} instead.** @return Returns true if the new values were successfully written* to persistent storage.*/
boolean commit();

    Note：使用同一 name 检索得到的是同一个共享首选项文件，如果多个 Editor 同时编辑并提交，后面一个会覆盖前面的（这个是注释的内容，应该是说相同键的会覆盖）

  • 也可以使用方法 apply() 提交：

        /*** Commit your preferences changes back from this Editor to the* {@link SharedPreferences} object it is editing.  This atomically* performs the requested modifications, replacing whatever is currently* in the SharedPreferences.** <p>Note that when two editors are modifying preferences at the same* time, the last one to call apply wins.** <p>Unlike {@link #commit}, which writes its preferences out* to persistent storage synchronously, {@link #apply}* commits its changes to the in-memory* {@link SharedPreferences} immediately but starts an* asynchronous commit to disk and you won't be notified of* any failures.  If another editor on this* {@link SharedPreferences} does a regular {@link #commit}* while a {@link #apply} is still outstanding, the* {@link #commit} will block until all async commits are* completed as well as the commit itself.** <p>As {@link SharedPreferences} instances are singletons within* a process, it's safe to replace any instance of {@link #commit} with* {@link #apply} if you were already ignoring the return value.** <p>You don't need to worry about Android component* lifecycles and their interaction with <code>apply()</code>* writing to disk.  The framework makes sure in-flight disk* writes from <code>apply()</code> complete before switching* states.** <p class='note'>The SharedPreferences.Editor interface* isn't expected to be implemented directly.  However, if you* previously did implement it and are now getting errors* about missing <code>apply()</code>, you can simply call* {@link #commit} from <code>apply()</code>.*/
void apply();

    如果在 UI 线程内操作并且不关心返回值，推荐使用方法 apply

    If you don’t care about the return value and you’re using this from your application’s main thread, consider using {@link #apply} instead.

清除共享首选项

获取 SharedPreferences.Editor 对象后，还可以调用其函数清除相对应的共享首选项：

    /*** Mark in the editor that a preference value should be removed, which* will be done in the actual preferences once {@link #commit} is* called.* * <p>Note that when committing back to the preferences, all removals* are done first, regardless of whether you called remove before* or after put methods on this editor.* * @param key The name of the preference to remove.* * @return Returns a reference to the same Editor object, so you can* chain put calls together.*/Editor remove(String key);

其返回一个新的 SharedPreferences.Editor 对象

如果想要全部清除可以调用函数 clear：

    /*** Mark in the editor to remove <em>all</em> values from the* preferences.  Once commit is called, the only remaining preferences* will be any that you have defined in this editor.* * <p>Note that when committing back to the preferences, the clear* is done first, regardless of whether you called clear before* or after put methods on this editor.* * @return Returns a reference to the same Editor object, so you can* chain put calls together.*/Editor clear();

其同样返回一个新的 SharedPreferences.Editor 对象

Note：执行完清除动作后还需要进行提交操作，使用 apply 或者 commit 方法

读取共享首选项

获取 SharedPreferences 对象后，就可以调用函数进行读取

abstract Map<String, ?> getAll()
abstract boolean    getBoolean(String key, boolean defValue)
abstract float  getFloat(String key, float defValue)
abstract int    getInt(String key, int defValue)
abstract long   getLong(String key, long defValue)
abstract String getString(String key, String defValue)
abstract Set<String>    getStringSet(String key, Set<String> defValues)

调用函数 contains 可以判断是否存在该键值对：

/*** Checks whether the preferences contains a preference.* * @param key The name of the preference to check.* @return Returns true if the preference exists in the preferences,*         otherwise false.*/
boolean contains(String key);

接口

SharedPreferences 还包含了一个接口 SharedPreferences.OnSharedPreferenceChangeListener

/*** Interface definition for a callback to be invoked when a shared* preference is changed.*/
public interface OnSharedPreferenceChangeListener {/*** Called when a shared preference is changed, added, or removed. This* may be called even if a preference is set to its existing value.** <p>This callback will be run on your main thread.** @param sharedPreferences The {@link SharedPreferences} that received*            the change.* @param key The key of the preference that was changed, added, or*            removed.*/void onSharedPreferenceChanged(SharedPreferences sharedPreferences, String key);
}

SharedPreferences 对象调用函数 registerOnSharedPreferenceChangeListener 注册该接口后，当其 改变，增加或者移除 了某个键时，会调用该函数

示例：

public class MainActivity extends AppCompatActivity implements SharedPreferences.OnSharedPreferenceChangeListener {private static final String TAG = MainActivity.class.getSimpleName();@Overrideprotected void onCreate(Bundle savedInstanceState) {super.onCreate(savedInstanceState);setContentView(R.layout.activity_main);SharedPreferences sharedPreferences = getSharedPreferences("test", Context.MODE_PRIVATE);sharedPreferences.registerOnSharedPreferenceChangeListener(this);SharedPreferences.Editor editor = sharedPreferences.edit();editor.putString("key", "value");editor.commit();}@Overridepublic void onSharedPreferenceChanged(SharedPreferences sharedPreferences, String key) {Log.e(TAG, "onSharedPreferenceChanged: key = " + key);}
}

SharedPreferencesUtil.java

参考：消除unchecked cast Warning

封装 SharedPreferences 操作，方便日后使用

分为 4 个部分，构造函数，写入，删除，获取

可选择默认共享首选项文件，或者自定义共享首选项文件

完整代码如下：

import android.content.Context;
import android.content.SharedPreferences;import java.util.Set;/*** Created by zj on 2017/7/18.*/public class SharedPreferencesUtil {private static final String TAG = "SharedPreferencesUtil";// 获取 SharedPreferences 对象 --------------------------------private static SharedPreferences sharedPreferences;private static SharedPreferences getInstance(Context context) {if (sharedPreferences == null) {sharedPreferences = getSharedPreferences(context, TAG);}return sharedPreferences;}private static SharedPreferences getSharedPreferences(Context context, String name) {return context.getSharedPreferences(name, Context.MODE_PRIVATE);}// 写入 ---------------------------------------------------/*** 写入共享首选项，可写入 字符串 / 布尔值 / 整形 / 长整形 / 浮点型** @param context 上下文* @param key     键* @param value   值*/public static <T> void apply(Context context, String key, T value) {SharedPreferences sharedPreferences = getInstance(context);SharedPreferences.Editor editor = sharedPreferences.edit();if (value instanceof String) {editor.putString(key, String.valueOf(value));} else if (value instanceof Boolean) {editor.putBoolean(key, (Boolean) value);} else if (value instanceof Integer) {editor.putInt(key, (Integer) value);} else if (value instanceof Long) {editor.putLong(key, (Long) value);} else if (value instanceof Float) {editor.putFloat(key, (Float) value);}editor.apply();}/*** 写入共享首选项，可写入 字符串 / 布尔值 / 整形 / 长整形 / 浮点型** @param context 上下文* @param name    共享首选项文件名* @param key     键* @param value   值*/public static <T> void apply(Context context, String name, String key, T value) {SharedPreferences sharedPreferences = getSharedPreferences(context, name);SharedPreferences.Editor editor = sharedPreferences.edit();if (value instanceof String) {editor.putString(key, String.valueOf(value));} else if (value instanceof Boolean) {editor.putBoolean(key, (Boolean) value);} else if (value instanceof Integer) {editor.putInt(key, (Integer) value);} else if (value instanceof Long) {editor.putLong(key, (Long) value);} else if (value instanceof Float) {editor.putFloat(key, (Float) value);}editor.apply();}/*** 写入字符串集** @param context 上下文* @param key     键* @param values  值*/public static void applyStringSet(Context context, String key, Set<String> values) {SharedPreferences sharedPreferences = getInstance(context);SharedPreferences.Editor editor = sharedPreferences.edit();editor.putStringSet(key, values);editor.apply();}/*** 写入字符串集** @param context 上下文* @param name    共享首选项文件名* @param key     键* @param values  值*/public static void applyStringSet(Context context, String name, String key, Set<String> values) {SharedPreferences sharedPreferences = getSharedPreferences(context, name);SharedPreferences.Editor editor = sharedPreferences.edit();editor.putStringSet(key, values);editor.apply();}// 清除 ----------------------------------------------/*** 清除对应健值对** @param context 上下文* @param key     键*/public static void remove(Context context, String key) {SharedPreferences sharedPreferences = getInstance(context);SharedPreferences.Editor editor = sharedPreferences.edit();editor.remove(key);editor.apply();}/*** 清除对应健值对** @param context 上下文* @param name    共享首选项文件名* @param key     键*/public static void remove(Context context, String name, String key) {SharedPreferences sharedPreferences = getSharedPreferences(context, name);SharedPreferences.Editor editor = sharedPreferences.edit();editor.remove(key);editor.apply();}/*** 清空整个共享首选项文件** @param context 上下文*/public static void clear(Context context) {SharedPreferences sharedPreferences = getInstance(context);SharedPreferences.Editor editor = sharedPreferences.edit();editor.clear();editor.apply();}/*** 清空整个共享首选项文件** @param context 上下文* @param name    共享首选项文件名*/public static void clear(Context context, String name) {SharedPreferences sharedPreferences = getSharedPreferences(context, name);SharedPreferences.Editor editor = sharedPreferences.edit();editor.clear();editor.apply();}// 读取 --------------------------------------------/*** 读取共享首选项 ，可读取 字符串 / 布尔值 / 整形 / 长整形 / 浮点型** @param context  上下文* @param key      键* @param defValue 默认值* @return 值*/public static <T> T get(Context context, String key, T defValue) {SharedPreferences sharedPreferences = getInstance(context);T res = null;if (defValue instanceof String) {res = cast(sharedPreferences.getString(key, String.valueOf(defValue)));} else if (defValue instanceof Boolean) {res = cast(sharedPreferences.getBoolean(key, (Boolean) defValue));} else if (defValue instanceof Integer) {res = cast(sharedPreferences.getInt(key, (Integer) defValue));} else if (defValue instanceof Long) {res = cast(sharedPreferences.getLong(key, (Long) defValue));} else if (defValue instanceof Float) {res = cast(sharedPreferences.getFloat(key, (Float) defValue));}return res;}/*** 读取共享首选项 ，可读取 字符串 / 布尔值 / 整形 / 长整形 / 浮点型** @param context  上下文* @param name     共享首选项文件名* @param key      键* @param defValue 默认值* @return 值*/public static <T> T get(Context context, String name, String key, T defValue) {SharedPreferences sharedPreferences = getSharedPreferences(context, name);T res = null;if (defValue instanceof String) {res = cast(sharedPreferences.getString(key, String.valueOf(defValue)));} else if (defValue instanceof Boolean) {res = cast(sharedPreferences.getBoolean(key, (Boolean) defValue));} else if (defValue instanceof Integer) {res = cast(sharedPreferences.getInt(key, (Integer) defValue));} else if (defValue instanceof Long) {res = cast(sharedPreferences.getLong(key, (Long) defValue));} else if (defValue instanceof Float) {res = cast(sharedPreferences.getFloat(key, (Float) defValue));}return res;}/*** 读取字符串集** @param context   上下文* @param key       键* @param defValues 默认值* @return 值*/public static Set<String> getStringSet(Context context, String key, Set<String> defValues) {SharedPreferences sharedPreferences = getInstance(context);return sharedPreferences.getStringSet(key, defValues);}/*** 读取字符串集** @param context   上下文* @param name      共享首选项文件名* @param key       键* @param defValues 默认值* @return 值*/public static Set<String> getStringSet(Context context, String name, String key, Set<String> defValues) {SharedPreferences sharedPreferences = getSharedPreferences(context, name);return sharedPreferences.getStringSet(key, defValues);}// --------------------------------------------------------@SuppressWarnings("unchecked")private static <T> T cast(Object obj) {return (T) obj;}}

这篇关于Android 数据保存 - SharedPreferences的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/1081605。

相关文章

大模型研发全揭秘：客服工单数据标注的完整攻略

大模型研发全揭秘：客服工单数据标注的完整攻略

在人工智能（AI）领域，数据标注是模型训练过程中至关重要的一步。无论你是新手还是有经验的从业者，掌握数据标注的技术细节和常见问题的解决方案都能为你的AI项目增添不少价值。在电信运营商的客服系统中，工单数据是客户问题和解决方案的重要记录。通过对这些工单数据进行有效标注，不仅能够帮助提升客服自动化系统的智能化水平，还能优化客户服务流程，提高客户满意度。本文将详细介绍如何在电信运营商客服工单的背景下进行
阅读更多...
基于MySQL Binlog的Elasticsearch数据同步实践

基于MySQL Binlog的Elasticsearch数据同步实践

一、为什么要做 随着马蜂窝的逐渐发展，我们的业务数据越来越多，单纯使用 MySQL 已经不能满足我们的数据查询需求，例如对于商品、订单等数据的多维度检索。 使用 Elasticsearch 存储业务数据可以很好的解决我们业务中的搜索需求。而数据进行异构存储后，随之而来的就是数据同步的问题。 二、现有方法及问题 对于数据同步，我们目前的解决方案是建立数据中间表。把需要检索的业务数据，统一放到一张M
阅读更多...
关于数据埋点，你需要了解这些基本知识

关于数据埋点，你需要了解这些基本知识

产品汪每天都在和数据打交道，你知道数据来自哪里吗？ 移动app端内的用户行为数据大多来自埋点，了解一些埋点知识，能和数据分析师、技术侃大山，参与到前期的数据采集，更重要是让最终的埋点数据能为我所用，否则可怜巴巴等上几个月是常有的事。   埋点类型 根据埋点方式，可以区分为： 手动埋点半自动埋点全自动埋点 秉承“任何事物都有两面性”的道理：自动程度高的，能解决通用统计，便于统一化管理，但个性化定
阅读更多...
使用SecondaryNameNode恢复NameNode的数据

使用SecondaryNameNode恢复NameNode的数据

1）需求： NameNode进程挂了并且存储的数据也丢失了，如何恢复NameNode 此种方式恢复的数据可能存在小部分数据的丢失。 2）故障模拟 （1）kill -9 NameNode进程 [lytfly@hadoop102 current]$ kill -9 19886 （2）删除NameNode存储的数据（/opt/module/hadoop-3.1.4/data/tmp/dfs/na
阅读更多...
异构存储（冷热数据分离）

异构存储（冷热数据分离）

异构存储主要解决不同的数据，存储在不同类型的硬盘中，达到最佳性能的问题。 异构存储Shell操作 （1）查看当前有哪些存储策略可以用 [lytfly@hadoop102 hadoop-3.1.4]$ hdfs storagepolicies -listPolicies （2）为指定路径（数据存储目录）设置指定的存储策略 hdfs storagepolicies -setStoragePo
阅读更多...
Hadoop集群数据均衡之磁盘间数据均衡

Hadoop集群数据均衡之磁盘间数据均衡

生产环境，由于硬盘空间不足，往往需要增加一块硬盘。刚加载的硬盘没有数据时，可以执行磁盘数据均衡命令。（Hadoop3.x新特性） plan后面带的节点的名字必须是已经存在的，并且是需要均衡的节点。 如果节点不存在，会报如下错误： 如果节点只有一个硬盘的话，不会创建均衡计划： （1）生成均衡计划 hdfs diskbalancer -plan hadoop102 （2）执行均衡计划 hd
阅读更多...
【Prometheus】PromQL向量匹配实现不同标签的向量数据进行运算

【Prometheus】PromQL向量匹配实现不同标签的向量数据进行运算

✨✨ 欢迎大家来到景天科技苑✨✨ 🎈🎈 养成好习惯，先赞后看哦~🎈🎈 🏆 作者简介：景天科技苑 🏆《头衔》：大厂架构师，华为云开发者社区专家博主，阿里云开发者社区专家博主，CSDN全栈领域优质创作者，掘金优秀博主，51CTO博客专家等。 🏆《博客》：Python全栈，前后端开发，小程序开发，人工智能，js逆向，App逆向，网络系统安全，数据分析，Django，fastapi
阅读更多...
Android实现任意版本设置默认的锁屏壁纸和桌面壁纸（两张壁纸可不一致）

Android实现任意版本设置默认的锁屏壁纸和桌面壁纸（两张壁纸可不一致）

客户有些需求需要设置默认壁纸和锁屏壁纸  在默认情况下 这两个壁纸是相同的  如果需要默认的锁屏壁纸和桌面壁纸不一样 需要额外修改 Android13实现 替换默认桌面壁纸： 将图片文件替换frameworks/base/core/res/res/drawable-nodpi/default_wallpaper.*  （注意不能是bmp格式） 替换默认锁屏壁纸： 将图片资源放入vendo
阅读更多...
Android平台播放RTSP流的几种方案探究（VLC VS ExoPlayer VS SmartPlayer）

Android平台播放RTSP流的几种方案探究（VLC VS ExoPlayer VS SmartPlayer）

技术背景 好多开发者需要遴选Android平台RTSP直播播放器的时候，不知道如何选的好，本文针对常用的方案，做个大概的说明： 1. 使用VLC for Android VLC Media Player（VLC多媒体播放器），最初命名为VideoLAN客户端，是VideoLAN品牌产品，是VideoLAN计划的多媒体播放器。它支持众多音频与视频解码器及文件格式，并支持DVD影音光盘，VCD影
阅读更多...
烟火目标检测数据集 7800张 烟火检测 带标注 voc yolo

烟火目标检测数据集 7800张 烟火检测 带标注 voc yolo

一个包含7800张带标注图像的数据集，专门用于烟火目标检测，是一个非常有价值的资源，尤其对于那些致力于公共安全、事件管理和烟花表演监控等领域的人士而言。下面是对此数据集的一个详细介绍： 数据集名称：烟火目标检测数据集 数据集规模： 图片数量：7800张类别：主要包含烟火类目标，可能还包括其他相关类别，如烟火发射装置、背景等。格式：图像文件通常为JPEG或PNG格式；标注文件可能为X
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2