背景
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);
// 單數(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類型
這樣的話指煎,操作、維護工作將大大減少便斥,當然這也是完全可以實現(xiàn)的至壤!
實現(xiàn)思路
下面只以 String name = mSpfUser.name().get() 為例分析:
反推代碼,可以想象Spf_User應該是這樣的:
public class Spf_User ...{
......
public StringSpfField name() {
return new StringSpfField(sharedPreferences,"name");
}
......
}
對于StringSpfField枢纠,應該包含get()方法的實現(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ù)是不是就完成了?晋渺!
對于存取镰绎、清除、判斷是否存在等操作也大同小異木西,多數(shù)據(jù)的操作稍微復雜畴栖,但原理也一樣,有興趣可以查看文章結尾的源碼八千。
當然如果我們對每一個SharedPreferences對象都自己手動去實現(xiàn)豈不是也挺繁瑣的吗讶,所以我用了@Spf注解燎猛,不用緊張,是編譯時注解照皆,0反射重绷,完全不會影響性能。這里不多做介紹膜毁,文章結尾源碼里都有昭卓。
引用
我將項目發(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瘟滨、像實體類一樣創(chuàng)建SharedPreferences對象XXX(參照上面 圖1代碼)葬凳,僅定義屬性即可,無須定義方法室奏,在類上使用@Spf注解;
2劲装、編譯項目胧沫;
3、編譯后生成Spf_XXX占业,使用Spf_XXX.create(Context context)創(chuàng)建實例绒怨;
4、參照上面 圖2代碼 使用谦疾。
注:
關于除String/int/boolean/long/float類型之外的屬性南蹂,可以使用Gson轉換成Json(String類型)存入,取出時再通過Gson轉成對應對象念恍。
Rx版
注:
Rx版編譯生成的文件六剥,以RxSpf_開頭!
Rx版除了具有普通版全部方法外峰伙,增加了2個方法:
asObservable():將取出的數(shù)據(jù)轉化為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疗疟,可以快速存儲數(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'
}