用Android studio插架将json串自动生成bean和parser
2018-06-10 22:08 阅读(302)

1、说明

     a、此插件基于开源的GsonFormat插件来修改实现的,因此保留了GsonFormat插件的特性和设置,使用时不需要的可忽略。

     b、目前会把map类型的数据解析成object对象,要实现对map类型的支持需要在编辑字段时改变字段的type,而目前此插件是不允许改变字段type的,所以只能在源代码中进行更改。

     c、不支持对byte、char、float、short等类型的定义和解析,如果使用到需要自行修改。

     d、目前生成的parser类是和bean类放到一个package下了,大家如果需要更换parser的路径需要自行手动更改并修改parser类中bean的引用位置。

     e、当我们日后扩展我们生成的bean和parser时,可以先考虑手动添加扩展,目前暂不支持直接在原有bean和parser上扩展。

2、插架支持的设置

     a、我们要使用插件时,点击code->Generate...,然后选择WubaJsonToBeanAndParser        

   b、打开插件我们看见的是如下界面:

   c、我们可以点击setting来进行一些生成bean的设置:      

     设置属性字段说明:

     convert method:选中后会自动在bean对象中生成一个parser方法,这个parser方法通过gson的方式将json转成object对象。(原插件特性,可忽略不用)

     virgo mode:建议勾选。勾选后当我们输入json串后点击ok按钮不会马上生成bean对象,会跳转到一个设置页面,可以更高bean对象field字段的名字(默认是json串中的key值)

     generate comments:建议勾选。勾选后我们生成的bean对象会增加一些原json串的注释在calss前面,方便后续字段的查看。

     split generate:根据需要选择。我们解析的目标json含有内部类等复杂结构时,勾选此按钮,会将这些内部的类字段结够独立生成calss文件;不勾选则作为内部类生成。

     generateParser:是否生成parser解析类和方法。默认勾选,使用工具生成bean的同时会生成parser方法。

     reuse bean :是否复用当前类的内部类相关属性字段。

     name suffix:我们生成的内部类等对象的时候,命名是此对象在json串中的key值+name suffix。可改变此值来改变内部类对象的命名结尾。

     name prefix:生成的field字段名字前缀

     use serializedname:是否生成 gson注解(或者fastjson注解)

     use wrapper class:是否将 int等基本类型转成 Integer等包转类型

    最后的convert libraty是让我们选择使用的gson框架还是fastjson框架。

3、插件的具体使用

     a、我们按上面的设置进行我们的定制,然后就可以在下面的界面粘贴我们的json串进行bean的生成:

         

       此界面上面的类名是Androidstudio当前窗口显示的calss的文件名,因此如果不做更改的话,默认会在此calss文件中生成json串中的字段。我们可以点击更改路径和类名,如果我们输入的类不存在则会自动创建。

       formate按钮是将我们粘贴的json串进行格式话,方便阅读。

       注意:这里粘贴的json串中的value一定不能存在null的情况,否则会提示

    b、如果我们勾选的是virgo mode模式,点击ok后会跳转到如下字段设置页面进行字段的重命名操作:

       

     我们根据自己的需要更改字段名即可,注意此时不能更改type,并会按一定规则将string类型的字段强制转换成int。

   c、自动生成bean的特性:

     我们建议字段使用private进行修饰,我们自动生成的bean对象会在 get方法里对非基本类型字段进行判空处理,因此使用此bean对象的get方法得到的数据永远不会是null的,通过此来屏蔽NullPointerException

   d、自动生成parser的特性

     自动生成的parser中全部使用opt相关api,根据bean中的字段key进行赋值。因此通过此parser生成的bean中每个字段都是不为null的。list支持嵌套list的解析,数组为空的情况会自动生成一个size是0的数组对象。