android 开源数据层框架。解放数据吧。

1,673 阅读4分钟

data-mediator

Platform compiler gson-support binder SparseArray
java ok ok need manual impl ok
android ok ok ok ok

  • 一个数据层的框架。利用编译时注解技术, 在java和android平台自动生成 数据实体及相关的代码。
    方便数据层的使用。支持gson所有注解. 通过操作binder和代理
    实现绝大部分开发属性设置。 以及支持强大的特性.

现有问题及目标

  • 现有问题:
    通常况下我们写app: 需要写很多实体,常用的就是和server交互的实体.
    在版本不断迭代的情况下,数据模型可能会很很多次(CRUD 字段甚至直接删除整个module).
    即使我们使用parcelable 代码生成器,也经常要ALT+insert去重新生成。toString那些更不用说了。
    而且如果用gson注解映射, 就更不太方便了。
    如果想链式编程....也不方便。
    ...
  • 目标:
    由于数据层是直接和业务打交道。很可能经常变动。为了减小这种变动。我想出了数据中介者框架(data-mediator).
    当然它还会支持很多特性.(目前中介者之数据绑定 可以完美搭配ButterKnife)

设计思想

  • 整个设计分3层: 模型层,代理层,调用层

  • 模型层:代表的是数据模型接口and实现

  • 代理层:数据实体的代理
  • 调用层:操作模型和代理的

特点

  • idea插件支持。
  • 支持自定义方法,字段,实现任意接口。
  • 自动生成数据的接口和实现类.可自动实现Serializable和 Parcelable(android)接口。

    自动生成get/is , set , toString, hashCode/equals方法.

    自动生成代理层 以便监听数据变化。
  • 字段:

    • 1, 支持多种类型 , 8大基本类型(int,long,short,byte,float,double,boolean ,char)及其包装类型, String类型,

      和其他类型 .数组和list结构同样支持。(map暂不支持parcelable)
    • 2, 支持生成字段的gson注解 for 'Google-Gson'.
    • 3, 支持多域, 比如: 重置(IResetable接口), 拷贝(ICopyable接口), 共享(Shareable), 快照(ISnapable)接口。toString.

      作用: 比如重置: 很多时候我们调用了数据的一些方法,改变了一些属性。然后想重置以便重新使用。

      比如 toString. 可选择某些字段参加或者不参加toString方法. hashCode/equals同理
  • 支持依赖或继承 @Field注解的接口(代表数据实体). 继承只能继承一个。

    • 平常我们写 BaseEntity(内有代表http/https响应的code, message, data字段), 通常业务接口的数据会继承这个BaseEntity。

      所以这里规定 继承@Field注解的接口(代表数据实体) 只能一个。否则error.
  • 支持链式调用. data-mediator-compiler 1.0.9 之后默认链式。

    1), 如果需要回到普通的java bean. 则需要将注解 @fields的方法 boolean enableChain()。 返回false.

    2), 需要注意的是,如果模型之间有继承关系。则需要将父module定义的enableChain 和 child的 enableChain 值相同, 否则编译错误。

    3), 下面是示例:

    DataMediator<StudentModule> mediator = DataMediatorFactory.createDataMediator(StudentModule.class);
          //数据代理层
          mediator.getDataProxy()
                  .setName(null)
                  .setAge(0)
                  .setId(0);
    
          //数据真正的模型实现
          mediator.getData().setName(null)
                  .setAge(0)
                  .setId(0);
    • 支持数据缓存 (使用请参考下面进阶指南)
    • 支持android平台的数据绑定,并且可以完美搭配ButterKnife (使用请参考下面进阶指南)

快速入门

1, 在项目根目录添加apt依赖。

 classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8'

2, 在使用的app module中加入。apt plugin

   apply plugin: 'com.neenbedankt.android-apt'

3, 添加dependencies

dependencies {
    //......
    compile 'com.heaven7.java.data.mediator:data-mediator:<see release>'
    compile 'com.heaven7.java.data.mediator.annotation:data-mediator-annotations:<see release>'
    apt 'com.heaven7.java.data.mediator.compiler:data-mediator-compiler:<see release>'
    apt 'com.squareup:javapoet:1.9.0'

    // 如果需要生成对应的gson注解。请加入gson依赖。比如
    compile "com.google.code.gson:gson:2.7"
    // 如果要支持android平台的数据绑定. 请添加依赖
    compile 'com.heaven7.android.data.mediator:data-mediator-android:<see release>'
}

4, 开始定义你的数据实体。比如我要定义关于学生的数据模型, 需要实现Serializable, Parcelable.
假如学生有。年龄,名称, id属性。
那么简单的数据定义为:


@Fields({
        @Field(propName = "age" , type = int.class, flags = FLAGS_ALL_SCOPES),
        @Field(propName = "name" , type = String.class, flags = FLAGS_ALL_SCOPES),
        @Field(propName = "id" , type = long.class, flags = FLAGS_ALL_SCOPES),
})
public interface Student extends Serializable, Parcelable{
}

5, 调用示例 (来自data-mediator-demo下的TestDoubleBindActivity

/**
 * 双向绑定示例程序.
 */
public class TestDoubleBindActivity extends AppCompatActivity {

    @BindView(R.id.tv_desc)
    TextView mTv_desc;

    DataMediator<StudentModule> mMediator;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        ButterKnife.bind(this);

        //为数据模型创建  中介者。
        mMediator = DataMediatorFactory.createDataMediator(StudentModule.class);
        //双向绑定
        DoubleBindUtil.bindDouble(mMediator, mTv_desc, "name");

        mMediator.getDataProxy().setName("heaven7");
    }

    //从TextView 设置文本, 同事改变数据的属性.
    @OnClick(R.id.bt_set_text_on_TextView)
    public void onClickSetTextOnTextView(View v){
        mTv_desc.setText("set by set_text_on_TextView");
    }

    //从数据代理去设置 数据属性,同时更改绑定的TextView属性
    @OnClick(R.id.bt_set_text_on_mediator)
    public void onClickSetTextOnMediator(View v){
        mMediator.getDataProxy().setName("set_text_on_mediator");
    }

}

更多sample 请到github/Data-Mediator

进阶指南

混淆配置

-keepclasseswithmembers public class * implements com.heaven7.java.data.mediator.DataPools$Poolable{
   *;
}
-keepclasseswithmembers public interface * extends com.heaven7.java.data.mediator.DataPools$Poolable{
   *;
}
-keep class * extends com.heaven7.java.data.mediator.BaseMediator{
   *;
}
-keep class com.heaven7.java.data.mediator.BaseMediator
-keep public class com.heaven7.android.data.mediator.BinderSupplierImpl

github 项目地址:github.com/LightSun/da…
想了解项目的核心思想请移步. 数据中介者核心思想

欢迎大家star. 提issue 或者contribute, thanks for read !!!

ps: 如果技术上或者框架有任何问题。我都会快速解决的。
更新很快哦,最好看github地址哈.
author:heaven7