帅气的使用SharedPreferences(含RxJava版)

背景

SharedPreferences是Android上一个轻量级的存储类,用来保存应用
的一些常用配置。
但是使用起来还是比较繁琐的,尤其当app比较大,SharedPreferences文件以及需要保存的属性较多时,操作和维护起来很麻烦,经常在存取值的时候思考应该取哪个对应的Key值。

换种思路,我要每一个SharedPreferences文件对应一个Java实体类,存取的时候,像操作实体类一样操作SharedPreferences,像下面这样:

@Spf
public class User {
    long token;

    String name;

    String mobile;

    Boolean first;
}

链式使用:

  Spf_User mSpfUser = Spf_User.create(this);

  // 单数据 edit
  mSpfUser.name().put("name");
  String name = mSpfUser.name().get();
  String mobile = mSpfUser.name().get("defaultValue");

  // 清理Preferences
  mSpfUser.clear();

  // name 是否存在
  boolean exists = mSpfUser.name().exists();

  // 多数据 edit
  mSpfUser.edit()
          .id()
          .put(124)
          .name()
          .put("name")
          .mobile()
          .remove()
          .apply();
// 也可以使用commit()提交,返回boolean类型

这样的话,操作、维护工作将大大减少,当然这也是完全可以实现的!

实现思路

下面只以 String name = mSpfUser.name().get() 为例分析:
反推代码,可以想象Spf_User应该是这样的:

public class Spf_User ...{
    ......

    public StringSpfField name() {
        return new StringSpfField(sharedPreferences,"name");
    }

    ......
}

对于StringSpfField,应该包含get()方法的实现,即:

public class StringSpfField ... {
    public StringSpfField(SharedPreferences sharedPreferences, String key) {
        super(sharedPreferences, key);
    }
    @Override
    public String get(String defaultValue) {
        if (defaultValue == null) {
            defaultValue = "";
        }
        return _sharedPreferences.getString(_key, defaultValue);
    }
    
    ......
}

这样最基本的操作单数据是不是就完成了?!
对于存取、清除、判断是否存在等操作也大同小异,多数据的操作稍微复杂,但原理也一样,有兴趣可以查看文章结尾的源码。

当然如果我们对每一个SharedPreferences对象都自己手动去实现岂不是也挺繁琐的,所以我用了@Spf注解,不用紧张,是编译时注解,0反射,完全不会影响性能。这里不多做介绍,文章结尾源码里都有。

引用

我将项目发布到了JCenter上,有需要的童鞋可以直接使用:

project的gradle.build里添加:

buildscript {
   dependencies {
       classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8' 
   }
}

app的gradle.build里添加:

apply plugin: 'com.neenbedankt.android-apt'

dependencies {
    compile 'me.yokeyword.smartsharedpreferences:api:1.0.0'
    apt 'me.yokeyword.smartsharedpreferences:compiler:1.0.0'
}

使用介绍

1、像实体类一样创建SharedPreferences对象XXX(参照上面 图1代码),仅定义属性即可,无须定义方法,在类上使用@Spf注解;
2、编译项目;
3、编译后生成Spf_XXX,使用Spf_XXX.create(Context context)创建实例;
4、参照上面 图2代码 使用。

注:
关于除String/int/boolean/long/float类型之外的属性,可以使用Gson转换成Json(String类型)存入,取出时再通过Gson转成对应对象。

Rx版

注:
Rx版编译生成的文件,以RxSpf_开头!

Rx版除了具有普通版全部方法外,增加了2个方法:

asObservable():将取出的数据转化为Observable
例如:

RxSpf_User.create(context)
        .name().asObservable()
        .subscribeOn(Schedulers.io())
        .map(new Func1<String, String>() {
            @Override
            public String call(String s) {
                return "rx" + s;
            }
        })
        .observeOn(AndroidSchedulers.mainThread())
        .subscribe(new Action1<String>() {
            @Override
            public void call(String s) {
                mTvShow.setText("name:  " + s);
            }
        })

asAction():转化为Action1,可以快速存储数据
例如:

// 如果你使用RxBinding
RxView.clicks(mBtnSave)
        .map(new Func1<Void, String>() {
            @Override
            public String call(Void aVoid) {
                return mEtName.getText().toString();
            }
        })
        .doOnNext(new Action1<String>() {
            @Override
            public void call(String s) {
                Toast.makeText(getApplicationContext(),"保存成功",Toast.LENGTH_SHORT).show();
            }
        })
        .subscribe(RxSpf_User.create(context).name().asAction());
Rx版引用

project的gradle.build里添加:

buildscript {
   dependencies {
       classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8' 
   }
}

app的gradle.build里添加:

apply plugin: 'com.neenbedankt.android-apt'

dependencies {
    // 你的RxJava版本
    compile 'io.reactivex:rxjava:x.x.x'

    compile 'me.yokeyword.rxsmartsharedpreferences:api:1.0.0'
    apt 'me.yokeyword.rxsmartsharedpreferences:compiler:1.0.0'
}

源码

GitHub地址
Rx版GitHub地址

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

推荐阅读更多精彩内容