背景
SharedPreferences是Android上一個(gè)輕量級(jí)的存儲(chǔ)類，用來保存應(yīng)用
的一些常用配置。
但是使用起來還是比較繁瑣的，尤其當(dāng)app比較大，SharedPreferences文件以及需要保存的屬性較多時(shí)，操作和維護(hù)起來很麻煩，經(jīng)常在存取值的時(shí)候思考應(yīng)該取哪個(gè)對(duì)應(yīng)的Key值。
換種思路，我要每一個(gè)SharedPreferences文件對(duì)應(yīng)一個(gè)Java實(shí)體類，存取的時(shí)候，像操作實(shí)體類一樣操作SharedPreferences，像下面這樣：
@Spf
public class User {
long token;
String name;
String mobile;
Boolean first;
}
鏈?zhǔn)绞褂茫?/p>
Spf_User mSpfUser = Spf_User.create(this);
// 單數(shù)據(jù) 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();
// 多數(shù)據(jù) edit
mSpfUser.edit()
.id()
.put(124)
.name()
.put("name")
.mobile()
.remove()
.apply();
// 也可以使用commit()提交，返回boolean類型
這樣的話，操作、維護(hù)工作將大大減少，當(dāng)然這也是完全可以實(shí)現(xiàn)的！
實(shí)現(xiàn)思路
下面只以 String name = mSpfUser.name().get() 為例分析：
反推代碼，可以想象Spf_User應(yīng)該是這樣的：
public class Spf_User ...{
......
public StringSpfField name() {
return new StringSpfField(sharedPreferences,"name");
}
......
}
對(duì)于StringSpfField，應(yīng)該包含get()方法的實(shí)現(xiàn)，即：
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);
}
......
}
這樣最基本的操作單數(shù)據(jù)是不是就完成了？！
對(duì)于存取、清除、判斷是否存在等操作也大同小異，多數(shù)據(jù)的操作稍微復(fù)雜，但原理也一樣，有興趣可以查看文章結(jié)尾的源碼。
當(dāng)然如果我們對(duì)每一個(gè)SharedPreferences對(duì)象都自己手動(dòng)去實(shí)現(xiàn)豈不是也挺繁瑣的，所以我用了@Spf注解，不用緊張，是編譯時(shí)注解，0反射，完全不會(huì)影響性能。這里不多做介紹，文章結(jié)尾源碼里都有。
引用
我將項(xiàng)目發(fā)布到了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、像實(shí)體類一樣創(chuàng)建SharedPreferences對(duì)象XXX（參照上面 圖1代碼），僅定義屬性即可，無須定義方法，在類上使用@Spf注解；
2、編譯項(xiàng)目；
3、編譯后生成Spf_XXX，使用Spf_XXX.create(Context context)創(chuàng)建實(shí)例；
4、參照上面 圖2代碼 使用。
注：
關(guān)于除String/int/boolean/long/float類型之外的屬性，可以使用Gson轉(zhuǎn)換成Json(String類型)存入，取出時(shí)再通過Gson轉(zhuǎn)成對(duì)應(yīng)對(duì)象。
Rx版
注：
Rx版編譯生成的文件，以RxSpf_開頭！
Rx版除了具有普通版全部方法外，增加了2個(gè)方法：
asObservable()：將取出的數(shù)據(jù)轉(zhuǎn)化為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()：轉(zhuǎn)化為Action1，可以快速存儲(chǔ)數(shù)據(jù)
例如：
// 如果你使用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'
}
