Android SharedPreferences存储的正确写法

发布时间 - 2026-01-11 01:47:30    点击率:

SharedPreferences 特点

即便是Android小白都知道的SharedPreferences的用法,这是保存数据最简便的方法,但是不处理好的话后期维护将是一个巨大的坑。那么该如何处理好SharedPreferences才方便维护呢。先从它的特点开始入手吧。

  1. 通过Context.getSharedPreferences()获取的SharedPreferences是一个单例
  2. SharedPreferences.edit()每次都会创建一个新的编辑对象,commit()之前一切改动都无效

SharedPreferences的具体实现并不在公开API内,创建方法只有通过Context获取。具体实现我们不去研究,通过Log打印每次获取的对象都是同一个,同样的方法可知道每次edit()都会得到不同的对象。

难以维护的 SharedPreferences

SharedPreference userPreferences = context.getSharedPreferences("UserInfo", Context.MODE_PRIVATE);
userPreferences.edit()
  .putString("id", "myId")
  .putString("name", "myName")
  .putString("head", "myHead")
  .commit();
Log.e("id", userPreferences.getString("id",""));
Log.e("name", userPreferences.getString("name",""));
Log.e("head", userPreferences.getString("head",""));

如上一段SharedPreferences保存和读取的方法非常简便,正因此才不易维护,可能因为写错Key而找不出问题所在,当然一般我们都会把Key写成静态常量。但随着项目增大,可能需要多处修改用户信息,每次都要一个个put(), 除了写着厌烦看着难受,当遇到需要增加或减少字段时也非常不便。

SharedPreferences 该这么写

如果能保留原有写法,又能规范方法那是最好不过了,看下SharedPreferences的接口方法并不多,很容易就写个包装类封装下。

import android.content.SharedPreferences;
import android.support.annotation.Nullable;

import java.util.Map;
import java.util.Set;

/**
 * SharedPreferences 包装类
 * Created by wittytutu on 17-3-29.
 */

public class PreferencesWrapper implements SharedPreferences {

  protected SharedPreferences mPreferences;

  public PreferencesWrapper(SharedPreferences preferences) {
    mPreferences = preferences;
  }

  @Override
  public Map getAll() {
    return mPreferences.getAll();
  }

  @Nullable
  @Override
  public String getString(String key, @Nullable String defValue) {
    return mPreferences.getString(key, defValue);
  }

  @Nullable
  @Override
  public Set getStringSet(String key, @Nullable Set defValues) {
    return mPreferences.getStringSet(key, defValues);
  }

  @Override
  public int getInt(String key, int defValue) {
    return mPreferences.getInt(key, defValue);
  }

  @Override
  public long getLong(String key, long defValue) {
    return mPreferences.getLong(key, defValue);
  }

  @Override
  public float getFloat(String key, float defValue) {
    return mPreferences.getFloat(key, defValue);
  }

  @Override
  public boolean getBoolean(String key, boolean defValue) {
    return mPreferences.getBoolean(key, defValue);
  }

  @Override
  public boolean contains(String key) {
    return mPreferences.contains(key);
  }

  @Override
  public EditorWrapper edit() {
    return new EditorWrapper(mPreferences.edit());
  }

  @Override
  public void registerOnSharedPreferenceChangeListener(OnSharedPreferenceChangeListener listener) {
    mPreferences.registerOnSharedPreferenceChangeListener(listener);
  }

  @Override
  public void unregisterOnSharedPreferenceChangeListener(OnSharedPreferenceChangeListener listener) {
    mPreferences.unregisterOnSharedPreferenceChangeListener(listener);
  }

  public static class EditorWrapper implements Editor {
    protected Editor mEditor;

    public EditorWrapper(Editor editor) {
      mEditor = editor;
    }

    @Override
    public EditorWrapper putString(String key, @Nullable String value) {
      mEditor.putString(key, value);
      return this;
    }

    @Override
    public EditorWrapper putStringSet(String key, @Nullable Set values) {
      mEditor.putStringSet(key, values);
      return this;
    }

    @Override
    public EditorWrapper putInt(String key, int value) {
      mEditor.putInt(key, value);
      return this;
    }

    @Override
    public EditorWrapper putLong(String key, long value) {
      mEditor.putLong(key, value);
      return this;
    }

    @Override
    public EditorWrapper putFloat(String key, float value) {
      mEditor.putFloat(key, value);
      return this;
    }

    @Override
    public EditorWrapper putBoolean(String key, boolean value) {
      mEditor.putBoolean(key, value);
      return this;
    }

    @Override
    public EditorWrapper remove(String key) {
      mEditor.remove(key);
      return this;
    }

    @Override
    public EditorWrapper clear() {
      mEditor.clear();
      return this;
    }

    @Override
    public boolean commit() {
      return mEditor.commit();
    }

    @Override
    public void apply() {
      mEditor.apply();
    }
  }
}

接下来的使用就简单了

public class UserInfoPreferences extends PreferencesWrapper {
  private static final String NAME = "UserInfo";

  public static final KEY_ID = "id"
  public static final KEY_NAME = "name";
  public static final KEY_HEAD = "head";
  public static final KEY_SEX = "sex";

  private static volatile UserInfoPreferences mPreferences;

  public static UserInfoPreferences getInstance(Context context){
    if(mPreferences == null) {
      synchronized (UserInfoPreferences.class){
        if(mPreferences == null) {
          SharedPreferences preferences = context.getApplicationCtontext().getShaedPreferences(NAME, Context.MODE_PRIVATE);
          mPreferences = new UserInfoPreferences(preferences);
        }
      }
    }
    return mPreferences;
  }

  public UserInfoPreferences(SharedPreferences preferences) {
    super(preferences);
  }

  // 获取用户信息
  public UserInfo getUserInfo(){
    String id = mPreferences.getString(KEY_ID, "");
    String name = mPreferences.getString(KEY_NAME, "");
    String head = mPreferences.getString(KEY_HEAD, "");
    return new UserInfo(id, name, head);
  }

  @Override
  public Editor edit(){
    return new Editor(mPreferences.edit());
  }

  public static class Editor extends EditorWrapper {

    public Editor(SharedPreferences.Editor editor) {
      super(editor);
    }

    // 保存用户信息
    public Editor putUserInfo(String id, String name, String head) {

      mEditor.putString(KEY_ID, id)
          .putString(KEY_AME, name)
          .putString(KEY_HEAD, head);
      return this;
    }

    // 清空用户信息
    public Editor clearUserInfo() {

      mEditor.remove(KEY_ID)
          .remove(KEY_NAME)
          .remove(KEY_HEAD);
      return this;
    }
  }
}

调用即方便扩展,也保留了原有方法。

UserInfoPreferences preferences = UserInfoPreferences.getInstance(context);
preferences.edit()
  .clearUserInfo()
  .putUserInfo("myId", "myName", "myHead")
  .putInt(KEY_SEX, 0)
  .commit();
UserInfo userInfo = preferences.getUserInfo();
int sex = preferences.getInt(KEY_SEX, 0);

感谢阅读,希望能帮助到大家,谢谢大家对本站的支持!


# Android  # SharedPreferences  # SharedPreferences详解  # Android 使用 SharedPreferences 保存少量数据的实现代码  # Android数据共享 sharedPreferences 的使用方法  # Android中SharedPreferences简单使用实例  # Android本地存储SharedPreferences详解  # 详解Android中的SharedPreferences  # Android 文件存储与SharedPreferences存储方式详解用法  # 都是  # 是一个  # 这是  # 看着  # 那是  # 都要  # 不出  # 不去  # 很容易  # 希望能  # 将是  # 该如何  # 又能  # 写着  # 会把  # 谢谢大家  # 留了  # 创建一个  # 并不多  # 多处 


相关栏目: 【 网站优化151355 】 【 网络推广146373 】 【 网络技术251813 】 【 AI营销90571


相关推荐: HTML 中动态设置元素 name 属性的正确语法详解  Laravel如何记录日志_Laravel Logging系统配置与自定义日志通道  如何用西部建站助手快速创建专业网站?  微信小程序 HTTPS报错整理常见问题及解决方案  Laravel Pest测试框架怎么用_从PHPUnit转向Pest的Laravel测试教程  php结合redis实现高并发下的抢购、秒杀功能的实例  JavaScript中如何操作剪贴板_ClipboardAPI怎么用  EditPlus中的正则表达式实战(6)  Laravel任务队列怎么用_Laravel Queues异步处理任务提升应用性能  Python结构化数据采集_字段抽取解析【教程】  创业网站制作流程,创业网站可靠吗?  Swift中循环语句中的转移语句 break 和 continue  Java遍历集合的三种方式  jquery插件bootstrapValidator表单验证详解  Midjourney怎么调整光影效果_Midjourney光影调整方法【指南】  小视频制作网站有哪些,有什么看国内小视频的网站,求推荐?  哪家制作企业网站好,开办像阿里巴巴那样的网络公司和网站要怎么做?  海南网站制作公司有哪些,海口网是哪家的?  网站制作企业,网站的banner和导航栏是指什么?  HTML5段落标签p和br怎么选_文本排版常用标签对比【解答】  如何在阿里云香港服务器快速搭建网站?  如何在阿里云ECS服务器部署织梦CMS网站?  电商网站制作多少钱一个,电子商务公司的网站制作费用计入什么科目?  Python正则表达式进阶教程_复杂匹配与分组替换解析  谷歌浏览器下载文件时中断怎么办 Google Chrome下载管理修复  韩国服务器如何优化跨境访问实现高效连接?  Laravel如何使用Gate和Policy进行权限控制_Laravel权限判定与策略规则配置  米侠浏览器网页图片不显示怎么办 米侠图片加载修复  详解阿里云nginx服务器多站点的配置  Laravel Seeder怎么填充数据_Laravel数据库填充器的使用方法与技巧  如何用JavaScript实现文本编辑器_光标和选区怎么处理  什么是JavaScript解构赋值_解构赋值有哪些实用技巧  大连网站制作公司哪家好一点,大连买房网站哪个好?  Laravel API资源类怎么用_Laravel API Resource数据转换  Laravel怎么实现观察者模式Observer_Laravel模型事件监听与解耦开发【指南】  如何在Windows环境下新建FTP站点并设置权限?  小米17系列还有一款新机?主打6.9英寸大直屏和旗舰级影像  Laravel如何配置和使用缓存?(Redis代码示例)  Laravel怎么为数据库表字段添加索引以优化查询  Win11怎么开启自动HDR画质_Windows11显示设置HDR选项  Python面向对象测试方法_mock解析【教程】  Laravel怎么上传文件_Laravel图片上传及存储配置  公司网站制作价格怎么算,公司办个官网需要多少钱?  怎么用AI帮你设计一套个性化的手机App图标?  微博html5版本怎么弄发语音微博_语音录制入口及时长限制操作【教程】  手机网站制作平台,手机靓号代理商怎么制作属于自己的手机靓号网站?  Laravel如何使用Livewire构建动态组件?(入门代码)  Firefox Developer Edition开发者版本入口  广州网站制作公司哪家好一点,广州欧莱雅百库网络科技有限公司官网?  如何快速选择适合个人网站的云服务器配置?