原創(chuàng)博客芦缰，如有轉(zhuǎn)載，請(qǐng)注明出處枫慷，非常感謝让蕾。
（前置說明，這里所說的POJO或听，就是大家認(rèn)為的POJO去掉了getter/setter）
由于SharedPreferences在android開發(fā)中的簡(jiǎn)單實(shí)用探孝，我相信android程序員，安卓的項(xiàng)目誉裆，幾乎沒有不使用到的顿颅，同時(shí)也由于他本身就比較簡(jiǎn)潔，所以足丢，一般大家都不會(huì)特別在意優(yōu)化即使寫了大量的重復(fù)性沒啥營(yíng)養(yǎng)的代碼粱腻，所以庇配，即使作為SmartKey項(xiàng)目下的一個(gè)小小子模塊，我也特別的把它拿出來說一說了绍些。
一般情況下捞慌，大家對(duì)于SharedPreferences的玩法都出奇的一致：
建一個(gè)比如叫StorageHelper的類，專門管理SharedPreferences的get/set問題柬批，對(duì)于用到的key啸澡，使用一個(gè)專門的常量類比如叫BaseParamNames來存儲(chǔ)，然而氮帐，大家都一致的遇到同樣的問題嗅虏，就是即使已經(jīng)用了一個(gè)專用的常量類來管理，還是有人使用其他地方的常量來存取SharedPreferences上沐，或者皮服，還是會(huì)出現(xiàn)有些值明明是同樣意義，但是多個(gè)key不知道用哪個(gè)等的問題参咙，面對(duì)這些問題冰更，我也很好奇，包括我自己昂勒，為啥以前一直都是只向隊(duì)員強(qiáng)調(diào)規(guī)范，只在會(huì)上強(qiáng)調(diào)規(guī)范舟铜，而就不想一些更加優(yōu)雅的方式來做這件事情呢戈盈？能不能讓系統(tǒng)來管理這些易出錯(cuò)的問題，特別是key的問題谆刨，不需要人共參與呢塘娶？
非常感謝現(xiàn)在的公司能讓我工作不那么趕那么高壓，能讓我有時(shí)間靜下來想一些問題了痊夭，對(duì)于以上問題刁岸，我開源了一個(gè)小項(xiàng)目SmartKey，里面有專門集中管理這些key的一個(gè)方案她我，供大家參考使用虹曙，多說無謂，直接上代碼：
先假設(shè)我的應(yīng)用里面有用到以下的SharedPreferences
- openTimes番舆，專門記錄應(yīng)用被打開了多少次
- lastVersion酝碳，用戶上次打開應(yīng)用的版本，專門用來在用戶升級(jí)到新版本或者第一次打開應(yīng)用的時(shí)候恨狈，做一些新功能介紹或者使用幫助的顯示等
- selectedCity 用戶選擇的城市
- myObject疏哗，一個(gè)隨意的POJO，這里其實(shí)沒啥用途禾怠，就是為了展示可以存取任意值返奉，并且可以指定你想要的key而已
- contacts贝搁，一個(gè)ArrayList<MyContact>的SharedPreferences，這個(gè)也是僅僅為了展示泛型怎么用而已
代碼來了：
// 需要寫的配置類
@SmartSharedPreferences
public class MyAppPreferences {
public int openTimes;
public String lastVersion;
public String selectedCity;
@Key("randomObject")
public MyObject myObject;
@Code(isGeneric = true, genericTypes = {"$T<$T>", "java.util.ArrayList", "link.anyauto.smartkey.demo.objects.MyContact"})
public ArrayList<MyContact> contacts;
}
// 生成的代碼
public final class MyAppPreferencesSPBuilder {
private static Application app;
public static void setApp(Application app) {
MyAppPreferencesSPBuilder.app = app;
}
public static Application getApp() {
return app;
}
public static int openTimes() {
return StorageHelper.getInt(app, "openTimes");
}
public static void openTimes(int value) {
StorageHelper.save(app, "openTimes", (int)value);
}
public static String lastVersion() {
return StorageHelper.get(app, "lastVersion");
}
public static void lastVersion(String value) {
StorageHelper.save(app, "lastVersion", (String)value);
}
public static String selectedCity() {
return StorageHelper.get(app, "selectedCity");
}
public static void selectedCity(String value) {
StorageHelper.save(app, "selectedCity", (String)value);
}
public static MyObject myObject() {
return GsonHelper.fromJson(StorageHelper.get(app, "randomObject"), link.anyauto.smartkey.demo.objects.MyObject.class);
}
public static void myObject(MyObject value) {
StorageHelper.save(app, "randomObject", GsonHelper.toJson(value));
}
public static ArrayList<MyContact> contacts() {
return GsonHelper.fromJson(StorageHelper.get(app, "contacts"), new TypeToken<ArrayList<MyContact>>(){}.getType());
}
public static void contacts(ArrayList<MyContact> value) {
StorageHelper.save(app, "contacts", GsonHelper.toJson(value));
}
}
建議大家只寫一個(gè)這樣的Preferences配置類芽偏，之所以叫做配置類雷逆，是因?yàn)槟愕膽?yīng)用只需要寫這么個(gè)類，但是你其實(shí)并不使用這個(gè)類的哮针，就是為了根據(jù)這個(gè)類生成需要的SharedPreferences管理類而已９孛妗！十厢！你所有的使用SharedPreferences的時(shí)候都不是使用這個(gè)類的等太，你使用的是MyAppPreferencesSPBuilder類！Ｂ拧缩抡！
** 需要特別說明一句，在你的Application類的onCreate方法里包颁，需要把Application的實(shí)例傳給管理類瞻想，畢竟需要通過application context去操作SharedPreferences：**
public class App extends Application {
public void onCreate() {
MyAppPreferencesSPBuilder.setApp(this);
// 其他代碼
}
// 其他方法
}
這里解釋一下用到的三個(gè)注解：
@SmartSharedPreferences
標(biāo)注了這個(gè)的類，apt工具會(huì)根據(jù)這個(gè)類的字段娩嚼，生成一個(gè)SPBuilder的類蘑险，比如這里，生成的類就叫做MyAppPreferencesSPBuilder岳悟，所有管理SharedPreferences的東西都在這個(gè)類了佃迄，使用的時(shí)候這樣：
// 獲取
int openTimes = MyAppPreferencesSPBuilder.openTimes();
// 保存
MyAppPreferencesSPBuilder.openTimes(openTimes + 1);
相信大家已經(jīng)看清楚套路了，對(duì)于所有的在POJO配置類上的字段贵少，都會(huì)生成一個(gè)對(duì)應(yīng)的同名方法呵俏，無參的版本用于獲取值，有參的版本用于保存值滔灶，就這樣普碎，用法也只有這么兩個(gè)方法，其他的一切都不需要了录平，至于key麻车，都說了幫您管理了，您就不用管了斗这。
@Key注解
大家看生成的代碼就清楚的看到绪氛，這個(gè)標(biāo)注是用來指定保存到SharedPreferences或者從里面取值是用的key的，一般情況下涝影，您就不要用這個(gè)標(biāo)注了枣察，這個(gè)標(biāo)注是專門為大家引入新代碼同時(shí)舊代碼還未改造完成的時(shí)候用的，當(dāng)然喜歡起名字的話，寫一下也無妨序目。
@Code標(biāo)注
這個(gè)標(biāo)注專門用來描述那些有泛型的字段的臂痕，isGeneric=true表示這個(gè)字段有泛型，genericTypes就是泛型的具體描述猿涨，這個(gè)genericTypes是一個(gè)數(shù)組:
1.) 第一個(gè)元素用來勾畫泛型的結(jié)構(gòu)握童，比如HashMap<String, ArrayList<String>>，那么碰到出現(xiàn)類名的叛赚，都替換成$T就行了澡绩，尖括號(hào)和逗號(hào)保留，比如HashMap<String, ArrayList<String>>的結(jié)構(gòu)描述就是：$T<$T, $T<$T>>
2.) 數(shù)組的第二個(gè)元素起俺附，就是具體的泛型類名了肥卡，按泛型聲明的出現(xiàn)順序列出來就行了，這里就是 java.util.HashMap, java.lang.String, java.util.ArrayList, java.lang.String事镣，所以步鉴，對(duì)于一個(gè)HashMap<String, ArrayList<String>>的字段，需要這樣寫：
@Code(isGeneric = true, genericTypes = {"$T<$T,$T<$T>>", "java.util.HashMap", "java.util.String", "java.util.ArrayList", "java.lang.String"})
public HashMap<String, ArrayList<String>> map;
生成的代碼：
public static HashMap<String, ArrayList<String>> map() {
return GsonHelper.fromJson(StorageHelper.get(app, "map"), new TypeToken<HashMap<String,ArrayList<String>>>(){}.getType());
}
public static void map(HashMap<String, ArrayList<String>> value) {
StorageHelper.save(app, "map", GsonHelper.toJson(value));
}
大家可以參考SmartKey里面的app模塊璃哟，里面關(guān)于SharedPreferences的使用氛琢，怎么引入這個(gè)庫(kù)使用請(qǐng)參考另外一篇博文，《原來Activity跳轉(zhuǎn)還可以這么舒暢》随闪，喜歡的朋友可以給個(gè)星星鼓勵(lì)一下阳似，非常感謝。
