如何优雅地管理SharedPreferences

原创博客，如有转载，请注明出处，非常感谢。

（前置说明，这里所说的POJO，就是大家认为的POJO去掉了getter/setter）
由于SharedPreferences在android开发中的简单实用，我相信android程序员，安卓的项目，几乎没有不使用到的，同时也由于他本身就比较简洁，所以，一般大家都不会特别在意优化即使写了大量的重复性没啥营养的代码，所以，即使作为SmartKey项目下的一个小小子模块，我也特别的把它拿出来说一说了。
一般情况下，大家对于SharedPreferences的玩法都出奇的一致：
建一个比如叫StorageHelper的类，专门管理SharedPreferences的get/set问题，对于用到的key，使用一个专门的常量类比如叫BaseParamNames来存储，然而，大家都一致的遇到同样的问题，就是即使已经用了一个专用的常量类来管理，还是有人使用其他地方的常量来存取SharedPreferences，或者，还是会出现有些值明明是同样意义，但是多个key不知道用哪个等的问题，面对这些问题，我也很好奇，包括我自己，为啥以前一直都是只向队员强调规范，只在会上强调规范，而就不想一些更加优雅的方式来做这件事情呢？能不能让系统来管理这些易出错的问题，特别是key的问题，不需要人共参与呢？
非常感谢现在的公司能让我工作不那么赶那么高压，能让我有时间静下来想一些问题了，对于以上问题，我开源了一个小项目SmartKey，里面有专门集中管理这些key的一个方案，供大家参考使用，多说无谓，直接上代码：
先假设我的应用里面有用到以下的SharedPreferences

1. openTimes，专门记录应用被打开了多少次
2. lastVersion，用户上次打开应用的版本，专门用来在用户升级到新版本或者第一次打开应用的时候，做一些新功能介绍或者使用帮助的显示等
3. selectedCity 用户选择的城市
4. myObject，一个随意的POJO，这里其实没啥用途，就是为了展示可以存取任意值，并且可以指定你想要的key而已
5. contacts，一个ArrayList<MyContact>的SharedPreferences，这个也是仅仅为了展示泛型怎么用而已
   代码来了：

// 需要写的配置类
@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));
  }
}

建议大家只写一个这样的Preferences配置类，之所以叫做配置类，是因为你的应用只需要写这么个类，但是你其实并不使用这个类的，就是为了根据这个类生成需要的SharedPreferences管理类而已！！！你所有的使用SharedPreferences的时候都不是使用这个类的，你使用的是MyAppPreferencesSPBuilder类！！！
** 需要特别说明一句，在你的Application类的onCreate方法里，需要把Application的实例传给管理类，毕竟需要通过application context去操作SharedPreferences：**

public class App extends Application {
      public void onCreate() {
          MyAppPreferencesSPBuilder.setApp(this); 
          // 其他代码
      }
      // 其他方法
}

这里解释一下用到的三个注解：
@SmartSharedPreferences
标注了这个的类，apt工具会根据这个类的字段，生成一个SPBuilder的类，比如这里，生成的类就叫做MyAppPreferencesSPBuilder，所有管理SharedPreferences的东西都在这个类了，使用的时候这样：

// 获取
int openTimes = MyAppPreferencesSPBuilder.openTimes();
// 保存
MyAppPreferencesSPBuilder.openTimes(openTimes + 1);

相信大家已经看清楚套路了，对于所有的在POJO配置类上的字段，都会生成一个对应的同名方法，无参的版本用于获取值，有参的版本用于保存值，就这样，用法也只有这么两个方法，其他的一切都不需要了，至于key，都说了帮您管理了，您就不用管了。
@Key注解
大家看生成的代码就清楚的看到，这个标注是用来指定保存到SharedPreferences或者从里面取值是用的key的，一般情况下，您就不要用这个标注了，这个标注是专门为大家引入新代码同时旧代码还未改造完成的时候用的，当然喜欢起名字的话，写一下也无妨。
@Code标注
这个标注专门用来描述那些有泛型的字段的，isGeneric=true表示这个字段有泛型，genericTypes就是泛型的具体描述，这个genericTypes是一个数组:
1.) 第一个元素用来勾画泛型的结构，比如HashMap<String, ArrayList<String>>，那么碰到出现类名的，都替换成$T就行了，尖括号和逗号保留，比如HashMap<String, ArrayList<String>>的结构描述就是：$T<$T, $T<$T>>
2.) 数组的第二个元素起，就是具体的泛型类名了，按泛型声明的出现顺序列出来就行了，这里就是 java.util.HashMap, java.lang.String, java.util.ArrayList, java.lang.String，所以，对于一个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模块，里面关于SharedPreferences的使用，怎么引入这个库使用请参考另外一篇博文，《原来Activity跳转还可以这么舒畅》，喜欢的朋友可以给个星星鼓励一下，非常感谢。