DoKV

Project Url: leavesC/DoKV
Introduction: 一个小巧而强大的 Key-Value 管理框架
More: Author   ReportBugs   
Tags:

DoKV

DoKV 是一个小巧而强大的 Key-Value 管理框架,其设计初衷是为了解决 Android 平台下各种繁琐且丑陋的配置类代码

(如果你是从我的博客:Android APT 实例讲解 跳转过来的,那需要切换到 master 分支,对应的是第二次的提交记录)

Download

dependencies {
    implementation 'leavesc.hello:dokv:0.1.8'
    annotationProcessor 'leavesc.hello:dokv-compiler:0.1.8'
}

如果不想自定义序列化方案,则可以使用我的另一个开源实现

dependencies {
    implementation 'leavesc.hello:dokv-impl:0.1.8'
}

更新日记:CHANGELOG

一、介绍

之所以说小巧,是因为 DoKV 的实现仅依赖于一个注解、一个接口、四个类。当然,其实现基础不仅仅如此,还需要 APT 技术的支持,需要依赖于 APT 来自动生成某些中间代码,关于 APT 的知识我在以前的一篇博客中也有所介绍,点击查看:APT

之所以说强大,是因为通过使用 DoKV 后,你基本是可以抛弃如下类型的代码了

        SharedPreferences sharedPreferences = getSharedPreferences("SharedPreferencesName", Context.MODE_PRIVATE);
        SharedPreferences.Editor editor = sharedPreferences.edit();
        editor.putString("IP", "192.168.0.1");
        editor.commit();
        String userName = sharedPreferences.getString("userName", "");
        String ip = sharedPreferences.getString("IP", "");

通常,我们的应用都会有很多配置项需要进行缓存,比如用户信息、设置项开关、服务器 IP 地址等。如果采用原生的 SharedPreferences 来实现的话,则很容易就写出如上所示那样丑陋的代码,不仅需要维护多个数据项的 key 值,而且每次存入和取出数据时都会有一大片重复的代码,不易维护

那 DoKV 的表现如何呢?

很简单!!!

假设你的应用包含了一个 User 类用于缓存用户信息,首先,为该类加上一个注解:@DoKV

/**
 * 作者:leavesC
 * 时间:2019/03/17 0:12
 * 描述:
 * GitHub:https://github.com/leavesC
 * Blog:https://www.jianshu.com/u/9df45b87cfdf
 */
@DoKV
public class User {

    private String name;

    private int age;

    private String sex;

    private Book book;

    private List<String> stringList;

    ···

}

build 下工程,DoKV 就会自动为你生成一个以 类名+DoKV 结尾 的 Java 类(UserDoKV),之后你就可以通过以下这种形式来进行数据存取了,而你无需关心其内部是如何保存的(当然,其内部的缓存机制是可以由你来自定义的)

        //缓存整个对象
        User user = new User();
        user.setAge(24);
        user.setName("leavesC");
        UserDoKV.get().setUser(user);

        //获取缓存的对象
        User user1 = UserDoKV.get().getUser();

        //更新本地已缓存的数据的某个设置项
        //如果之前没有缓存过,则会自动 new 一个对象并自动赋值
        //因为 DoKV 要求注解类必须包含一个无参构造函数,并且包含的字段有对应的 Get 和 Set 方法
        UserDoKV.get().setName("leavesCZY");
        UserDoKV.get().setAge(28);

        //移除缓存数据
        UserDoKV.get().remove();

        //移除所有缓存数据
        DoKV.clear();

上文说过,DoKV 是依赖于 APT 技术的,其实际原理就是开发者通过继承 AbstractProcessor 来定义目标代码的生成规则,由编译器根据此规则来生成目标代码,所以 DoKv 的执行效率就如同构造一般的 Java 类,不存在什么依靠反射使性能降低的情况

UserDoKV 类的定义如下所示:

public class UserDoKV extends User {

    private static final String KEY = "leavesc.hello.dokv.model.UserDoKV";

    private UserDoKV() {
    }

    public static UserDoKV get() {
        return new UserDoKV();
    }

    private IDoKVHolder getDoKVHolder() {
        return DoKV.getInstance().getDoKVHolder();
    }

    private String serialize(String _KEY, User _User) {
        return getDoKVHolder().serialize(_KEY, _User);
    }

    private User deserialize(String _KEY) {
        return getDoKVHolder().deserialize(_KEY, User.class);
    }

    public User getUser() {
        return deserialize(KEY);
    }

    private User getUserNotNull() {
        User variable = deserialize(KEY);
        if (variable != null) {
            return variable;
        }
        return new User();
    }

    public String setUser(User instance) {
        if (instance == null) {
            remove();
            return "";
        }
        return serialize(KEY, instance);
    }

    public void remove() {
        getDoKVHolder().remove(KEY);
    }

    @Override
    public String getName() {
        User variable = getUser();
        if (variable != null) {
            return variable.getName();
        }
        return super.getName();
    }

    @Override
    public void setName(String _name) {
        User _user = getUserNotNull();
        _user.setName(_name);
        serialize(KEY, _user);
    }

    //省略类似的 Get/Set 方法
}

二、自定义缓存 Key

在 v0.1.7 版本之前, DoKV 默认以被注解类的类路径作为缓存 Key,以此来保证 Key 值的唯一性,但考虑到被注解类在后续开发中可能会被移动到其它包下从而导致丢失缓存数据,因为在 v0.1.7 版本中为注解 DoKV 新增了 Key 属性,如果开发者向该属性赋予了值,则以该值作为缓存 Key,而且该 Key 的唯一性需要由开发者自己来保证

@DoKV(key = "CustomKeyUser_Key")
public class CustomKeyUser {

   ···

}
public class CustomKeyUserDoKV extends CustomKeyUser {

    private static final String KEY = "CustomKeyUser_Key";

}




### 三、引入

为了获得更高的自由度, DoKV 默认将数据持久化的实现方案交由外部来实现,即由使用者来决定如何将对象序列化保存到本地,此时你就可以选择只依赖以下两个引用

```groovy
dependencies {
    implementation 'leavesc.hello:dokv:xxx'
    annotationProcessor 'leavesc.hello:dokv-compiler:xxx'
}

然后,外部将 IDoKVHolder 实例传给 DoKV 即可

       DoKV.init(new IDoKVHolder() {

            //序列化
            @Override
            public String serialize(String key, Object src) {
                return null;
            }

            //反序列化
            @Override
            public <T> T deserialize(String key, Class<T> classOfT) {
                return null;
            }

            //移除指定对象
            @Override
            public void remove(String key) {

            }

            //删除全局的缓存数据
            @Override
            public void clear() {

            }
        });

如果你不想自己实现 IDoKVHolder ,DoKV 也提供了一个默认实现,此时你就只要多引用如下一个依赖即可,其内部是通过 Gson + MMKV 来实现序列化方案

dependencies {
    implementation 'leavesc.hello:dokv-impl:xxx'
}

进行初始化,之后就可以自由地玩耍了

    DoKV.init(new MMKVDoKVHolder(Context));

四、结尾

本开源库的 GitHub 主页在这里:DoKV

APK 下载体检:DoKV

我的博客主页:leavesC

Support Me
Apps
About Me
Google+: Trinea trinea
GitHub: Trinea