Gson的进阶使用

正确熟练的使用Gson这个开源库能够有效的提高开发的效率,它可以快捷的将json串转化成Map<>,List<>或实体类,并支持反向操作

基本操作
// 序列化
String string = new Gson().toJson(user);
// 反序列化
User user = new Gson().fromeJson(string, User.class);
泛型的反序列化
// 序列化
String string = new Gson().toJson(userList);
// 反序列化
List<User> userList = new Gson().
    fromeJson(string, new TypeToken<List<User>>(){}.getType());

TypeToken的源码,可以对Java的泛型有更深刻的理解

复杂嵌套json串需要注意的问题

有些json串的嵌套很复杂,对象中某个字段为列表,列表中又有多个对象。在处理这种json串的时候要注意的是,分步操作,每一步操作后打印json串看一下

// 错误的json串格式,没有双引号
[{rec_id=797, type=4, data=杭州, remark=}]

// 正确的json串格式是有双引号的,这样才能保证被正确的解析
[{"rec_id":"797","type":"4","data":"杭州","remark":""}]

// 实际上如果上面的remark字段不为空,这两种都可以被解析
// 但一旦有字段为空,没有双引号的那种就会抛出异常

在提取json串中的某一个对象的时候,若想单独转换成一个json串,应该使用下面的方式

Map map = gson.fromJson(json, Map.class);

// 这种写法是错误的,转换完会是上面那种错误的json格式
String newjson = map.get("data").toString();

// 这种转换方式才是正确的,以为通过map取得的也是一个对象
// 需要反序列化一次才能得到json串,而不是直接toString()
String newjson = gson.toJson(map.get("data"));
变量名的对应

很多情况下Java中的成员变量是通过驼峰式命名的,例如userName,passWord。而json的串可能是通过数据库生成,数据库中字段的命名方式为user_name,pass_word。这两种命名方式在某些开源框架中是可以实现相互转换的,虽然Gson不支持自动转换,但可以通过下面的方式来映射Java中的成员变量名和json串中的key

@SerializedName("user_name")
private String userName;
如果Java的成员变量没有对应的json串中的key,则这个变量会被赋值为null,所以在成员变量的类型定义的时候,应避免使用基本数据类型,而使用对应的包装器类型去替代
控制变量是否序列化

和对应变量名的方法差不多,也是通过注解的方式来控制的,一个是@Expose注解,还有一个是@Since注解

  • @Expose注解有两个变量:serializedeserialize,默认值都是true

    public class User {
          @Expose
          private String userName;
          @Expose(serialize = false)
          private int age;
          @Expose(serialize = false, deserialize = false)
          private boolean admin;
    }
    

    这时序列化只会输出userName字段,反序列化只会给userName和age字段赋值
    需要注意的是,要想使@Expose这个注解生效,需要使用如下方法来构建Gson对象

     Gson gson = new GsonBuilder()
                      .excludeFieldsWithoutExposeAnnotation().create();
    
  • @Since注解主要用于进行版本的控制

    public class User {
         @Since(1.0)
         private String userName;
         @Since(1.1)
         private int age;
         @Since(1.1)
         private boolean admin;
    }
    
    Gson gson = new GsonBuilder().setVersion(1.0).create();
    

    在构建Gson对象的时候使用GsonBuilder的方式,指定一个版本号,成员变量的版本号高于指定的版本号的时候,在转换的时候将会被忽略,例如上述例子,只有userName字段会被序列化和反序列化

重写适配器

当一个json串的字段的值为"",且这个字段对应的成员变量的类型为int,由于空字符串无法转化成int类型,所以就会报错,这个时候多数情况下我们是希望其转化成0的,或者是某一个默认值,所以我们可以通过重写适配器的方式,来达到我们想要达到的效果,仅以重写int类型的适配器为例

public class IntegerDefaultAdapter 
        implements JsonSerializer<Integer>, JsonDeserializer<Integer> {
    @Override
    public Integer deserialize(JsonElement json, 
          Type typeOfT, JsonDeserializationContext context)
            throws JsonParseException {
        try {
            // 此处可自定义规则
            if (json.getAsString().equals("") || 
                json.getAsString().equals("null")) {
                return 0;
            }
        } catch (Exception ignore) {
            // catch error
        }
        try {
            return json.getAsInt();
        } catch (NumberFormatException e) {
            throw new JsonSyntaxException(e);
        }
    }

    @Override
    public JsonElement serialize(Integer src, Type typeOfSrc, 
          JsonSerializationContext context) {
        return new JsonPrimitive(src);
    }
}

// 构造Gson对象的方式
Gson gson = new GsonBuilder()
      .registerTypeAdapter(Integer.class, new IntegerDefaultAdapter())
      .create();

如果要写其他类型的适配器,只需要更改上面的Integer为对应的类型即可

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

推荐阅读更多精彩内容

  • 1.概述2.Gson的目标3.Gson的性能和扩展性4.Gson的使用者5.如何使用Gson 通过Maven来使用...
    人失格阅读 14,244评论 2 18
  • 为了更好的学习Gson,特将Gson User Guide翻译如下。由于本人英文水平有限,如有错误,还请指正,谢谢...
    WeberLisper阅读 6,823评论 0 6
  • Json 是一种文本形式的数据交换格式,比 xml 更为轻量。Json 的解析和生成的方式很多,在 Android...
    业志陈阅读 79,167评论 9 69
  • 来厦门这么多年,东奔西走,南来北往,这边风景,早已看够,唯那悠悠岁月,风云变幻,若即若离,不曾悟透。无出其右,读书...
    安言靜语阅读 190评论 0 1
  • 《再见,萤火虫小巷》读书笔记一 “我喜欢在晚上来这里,星星很亮。有时候如果一直看着天空,会觉得星星像萤火虫...
    Erina_li10阅读 275评论 2 2