[71→100]探索Android开发中将JSON转为对应的JavaModel的最佳实践

JSON(JavaScript Object Notation) 是一种轻量级的数据交换格式。它基于ECMAScript的一个子集。 JSON采用完全独立于语言的文本格式,但是也使用了类似于C语言家族的习惯(包括C、C++、C#、Java、JavaScript、Perl、Python等)。这些特性使JSON成为理想的数据交换语言。 易于人阅读和编写,同时也易于机器解析和生成(一般用于提升网络传输速率)。

Android开发基本遵从MVC模式。由于JSON的种种优良特性,使得大部分Model都从JSON转换而来。于是把 JSON转为对应的JavaModel 就成移动端开发工作很常规的一部分。

这个工作的输入输出很明确:
输入 是一个json的字符串

{
  "type":"object",
  "properties": {
    "foo": {
      "type": "string"
    },
    "bar": {
      "type": "integer"
    },
    "baz": {
      "type": "boolean"
    }
  }
}

输出 是对应的一系列java类:

public class DataModel extends BaseModel {
    private String type;
    private PropertiesBean properties;
    
    public String getType() {
      return type;
    }

    public void setType(String type) {
        this.type = type;
    }

    public PropertiesBean getProperties() {
      return properties;
    }

    public void setProperties(PropertiesBean properties) {
        this.properties = properties;
    }
}

public static class PropertiesBean {
    private FooBean foo;
    private BarBean bar;
    private BazBean baz;

    public FooBean getFoo() {
          return foo;
      }

      public void setFoo(FooBean foo) {
          this.foo = foo;
      }

      public BarBean getBar() {
          return bar;
      }

      public void setBar(BarBean bar) {
          this.bar = bar;
      }

      public BazBean getBaz() {
          return baz;
      }

      public void setBaz(BazBean baz) {
          this.baz = baz;
      }

}

public static class FooBean {
    private String type;

    public String getType() {
        return type;
    }

    public void setType(String type) {
        this.type = type;
    }
}

public static class BarBean {
    private String type;

    public String getType() {
        return type;
    }

    public void setType(String type) {
        this.type = type;
    }
}

public static class BazBean {
    private String type;

    public String getType() {
        return type;
    }

    public void setType(String type) {
        this.type = type;
    }
}

怎么完成这个转化过程呢?

转化方式一:复制粘贴、手动修正(最原始!!)

对着原始的json串,把名字复制过来,手动设置每个json项的类型。这种方式的缺点非常明显:

  1. 耗时长
  2. 人工操作太多,容易出错,万一手误把名字复制错了,后期排除错误的过程也比较麻烦。

转化方式二:使用GsonFormat智能转JSON

GsonFormat应该是Android Studio上必备插件之一,先来看效果图

效果非常的赞,而且支持过滤父类已有属性,这样就不用在继承父类后还要删除相同的属性了。它的安装和使用方法也非常简单方便,具体方式参考其github主页:https://github.com/zzz40500/GsonFormat

类似插件还有一个,叫JsonModelGenerator,其支持将类型为 JSONObject 和 JSONArray 的子元素拆分为单独的实体类。不过它用起来比较繁琐,必须透过url获取原始json串,不推荐使用。

由于GsonFormat的使用方式仅限于单个java类内,所以它解析产生的子类都是内嵌类,所以还是会需要手动调整类的继承关系。另外每个JSON串都要先新建再转JSON的时候,当JSON串比较多的时候,就会觉得这一步也挺繁琐的(程序员就是懒啊~),有没有批量转json的方式呢?

转化方式三:使用JsonAnnotation批量转JSON

JsonAnnotation利用了java annotation的特性,在Android编译时将如下格式的代码

String simpleStr = "{\n"
        + "    \"id\": 100,\n"
        + "    \"body\": \"It is my post\",\n"
        + "    \"number\": 0.13,\n"
        + "    \"created_at\": \"2014-05-22 19:12:38\"\n"
        + "}";
// 简单格式
@Json2Model(modelName = "SimpleModel", jsonStr = simpleStr)
String TEST_SIMPLE = "test/simple"; // api url

转化为test.simple包下的一个类SimpleModel,代码如下:

package test.simple;

import com.google.gson.annotations.SerializedName;

public class SimpleModel {
    @SerializedName("id")
    private int id;

    @SerializedName("body")
    private String body;

    @SerializedName("created_at")
    private String createdAt;

    @SerializedName("number")
    private double number;

    public void setId(int id) {
        this.id = id;
    }

    public void setBody(String body) {
        this.body = body;
    }

    public void setCreatedAt(String createdAt) {
        this.createdAt = createdAt;
    }

    public void setNumber(double number) {
        this.number = number;
    }

    public int getId() {
        return id;
    }

    public String getBody() {
        return body;
    }

    public String getCreatedAt() {
        return createdAt;
    }

    public double getNumber() {
        return number;
    }
}

这样就可以批量将json转成Model了,而且由于其只在编译时起作用,所以并不影响程序运行时的性能(非常棒的~)。具体使用方法参考其github主页:https://github.com/tianzhijiexian/JsonAnnotation

不过这种方式还是有不便利的地方,主要体现在两个地方:

  1. 没有办法指定json对应类的父类,因此如果Model之间有继承关系,需要手动处理
  2. 不会智能判断不同json串之间的关联关系,因此如果Model之间有组合关系,需要手动处理。

转化方式四:脱离Android Studio环境转JSON

方式三和四都基于Android Studio这个开发环境,有没有脱离这个环境直接将JSON串转成Java Model的方式呢?
有。
点开http://www.jsonschema2pojo.org/网站,可以看到如下界面:

操作很直观清晰,可以直接将JSON转为Model,而且支持预览,其产物为一系列java文件(因为内嵌的json对象会被解析为独立java类)。

类似网站有JSON To Java

注意:这两个网站都不支持批量转JSON

以上就是目前搜集到的所有可用资源了,它们都是GitHub上的开源项目,相关地址如下:

  1. GsonFormat
  2. JsonAnnotation
  3. JsonToJava
  4. jsonschema2pojo
  5. JsonModelGenerator

目前最佳实践清单

从目前来,最佳方式是综合JsonAnnotationGsonFormat

  1. 首先利用JsonAnnotation批量生成所有的java类。
  2. 然后根据其中的组合、继承关系进行人工修正。
  3. 当遇到参数增删较多的时候,用GsonFormat进行单个操作。

PS:JsonAnnotation 这个项目真不错,如果能把继承和组合关系也解决掉,它就完美了~~

拓展阅读:

  1. Java 注解

Panda
2016-07-06

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,670评论 5 460
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,928评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,926评论 0 320
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,238评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,112评论 4 356
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,138评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,545评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,232评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,496评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,596评论 2 310
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,369评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,226评论 3 313
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,600评论 3 299
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,906评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,185评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,516评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,721评论 2 335

推荐阅读更多精彩内容