AnyPref,可直接在SharedPreferences中保存对象实例的SharedPreferences工具类

项目Github地址https://github.com/NashLegend/AnyPref
有时候在写代码的时候经常会有一些要持久保存某个对象的需求,这时候如果动用Sqlite又觉得太重,使用SharedPreferences保存的话确实是轻量级了,但是还要针对对象的每个字段都要保存,可能要好多行代码,读取出来又是好多行代码,我们为什么不直接自动保存与读取对象中的字段呢,如果有保存几个不同对象的需求的话,那就能省下大量的代码了。
AnyPref是一个SharedPreferences工具类,它可以直接保存某个对象到SharedPreferences中,使用方法:
在工程根目录build.gradle添加jitpack:

allprojects {
    repositories {
        maven { url "https://jitpack.io" }
    }
}

在使用app/build.gradle中添加:

dependencies {
    compile 'com.github.NashLegend:AnyPref:1.2.1'
}

AnyPref的基本原理是使用反射读取字段名,并将类名作为SharedPreferences的name,将字段名作为SharedPreferences中的key保存字段,同时也支持通过注解来自定义SharedPreferences的name和key,默认它会将所有的SharedPreferences支持的public字段保存(static和final修饰的除外),也可以通过注解来排除某些不需要的字段。如果要保存的对象中还包含了另一个复杂子对象,比如Family类中有一个Son的字段,这时候Son对象默认是不会保存的,如果想同时保存这个子对象,需要添加PrefSub注解。同理如果要保存的对象中还包含一个ArrayList,要想保存这个ArrayList,需要添加PrefArrayList注解。
如何保存与读取数据呢?
在应用的Application的onCreate()中添加如下代码(主要是为了省却后面要传入Context参数的麻烦)

    AnyPref.init(this);

1. 读写实例对象

假设有一个Sample类

    @PrefModel("prefName")//可不添加此注解,"prefName"表示保存SharedPreferences的name,可为任意String字符串,如果不写,则为类的全名
    public class Sample {
    
        @PrefField("intFieldKey")//可不添加此注解,"intFieldKey"表示保存此值时的key,可为任意String字符串,如果不写,则为此变量的变量名
        public int intField = 32;
        
        @PrefIgnore//添加此注解表示不保存这个变量
        public float floatField = 1.2345f;
        
        @PrefField(numDef = 110)//表示如果读取不到后使用的默认值
        public long longField = 95789465213L;
        
        public String stringField = "string";
        
        @PrefField(boolDef = true)
        public boolean boolField = false;
        
        @PrefField(value = "setValueWithSpecifiedKey", strDef = {"1", "2", "3", "4"})//默认值是[1,2,3,4]
        public Set<String> setValue = new LinkedHashSet<>(); 
        
        @PrefSub(nullable = false)//nullable表示取子对象的时候,子对象是否可以为null,默认是true
        public SubSample son1;//标注了@PrefSub的变量,虽然不是SharedPreferences支持的类型,但是仍会被保存
        
        @PrefArrayList(nullable = true, itemNullable = true)//nullable同上,itemNullable表示列表中的数据是否可以为null,默认为true
        public ArrayList<SubSample> sampleArrayList;//标注了@PrefArrayList的ArrayList会被保存,但是ArrayList不能是基本类型的
    }

保存数据:

    AnyPref.put(sample);
    //或者
    AnyPref.put(sample, "your prefName");第二个参数是自己定义的保存此类的sharedPreferences name,不是PrefModel定义的那个name

读取数据

    Sample sample = AnyPref.get(Sample.class);
    //或者
    Sample sample = AnyPref.get(Sample.class, "your prefName");
    //或者
    Sample sample = AnyPref.get(Sample.class, "your prefName", true);//第三个参数表示读取出来的对象是否可以为null,默认不为null

清除数据

    AnyPref.clear(Sample.class);
    //或者
    AnyPref.clear(Sample.class, "your prefName");

PS,对于实例对象的读写:

  1. 保存的对象必须支持无参构造函数,它是写代码时用到的Model对象或者一组Setting等,不是用来保存一些系统对象比如String,View的;
  2. 保存的对象的变量们中只保存SharedPreferences支持的以及标注了@PrefSub@PrefArrayList的变量;
  3. 标注了@PrefSub@PrefArrayList的类型要求同第一条
  4. 只会保存修饰符为public的变量,staticfinal的变量均不会保存;
  5. 不要有循环引用,标注了@PrefSub的对象中不要包含标注了@PrefSub的父对象的类,@PrefArrayList同理,否则会导致向下无限读取
如果使用了ProGuard,在proguard配置文件中添加
-keep class net.nashlegend.demo.Sample{ *; }

或者

-keepclasseswithmembernames class net.nashlegend.demo.Sample {
   public <fields>;
}

net.nashlegend.demo.Sample改成对应的类

2. 读写任意数据

    AnyPref.getPrefs("sample")//或者new SharedPrefs("sample")
            .putLong("long", 920394857382L)
            .putInt("int", 63)
            .putString("string", "sample string");

    AnyPref.getPrefs(Sample.class)
            .beginTransaction()
            .putLong("long", 920394857382L)
            .putInt("int", 63)
            .putString("string", "sample string")
            .commit();

    SharedPrefs sharedPrefs = AnyPref.getPrefs("sample");
    System.out.println(sharedPrefs.getInt("int", 0));
    System.out.println(sharedPrefs.getLong("long", 0));
    System.out.println(sharedPrefs.getString("string", ""));

项目Github地址https://github.com/NashLegend/AnyPref

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 173,466评论 25 708
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,981评论 19 139
  • 前言 人生苦多,快来 Kotlin ,快速学习Kotlin! 什么是Kotlin? Kotlin 是种静态类型编程...
    任半生嚣狂阅读 26,282评论 9 118
  • junit框架介绍 JUnit ——是一个开发源代码的Java测试框架,用于编写和运行可重复的测试。他是用于单元测...
    onweer阅读 1,374评论 2 4
  • 穿过山冈的风, 远行而来的云, 从土里出来的蛙, 外婆吹起的口哨, 沁凉的溪流下的小脚丫, 野草散发的芬芳, 暖风...
    likeCtsu阅读 155评论 0 0