正文 

当前位置： 首页 > java > java教程

你真的会用gson吗?gson使用指南

author author     2022-08-30     628

关键词：

JSON (官网) 是一种文本形式的数据交换格式，它比XML更轻量、比二进制容易阅读和编写，调式也更加方便。其重要性不言而喻。解析和生成的方式很多，Java中最常用的类库有：JSON-Java、Gson、Jackson、FastJson等。

注：此系列基于Gson 2.4。

对Gson使用很自信的大大可以点击关闭啦。

本篇文章的主要内容：

  • Gson的基本用法
  • 属性重命名 @SerializedName 注解的使用
  • Gson中使用泛型

一、Gson的基本用法

Gson提供了fromJson() 和toJson() 两个直接用于解析和生成的方法，前者实现反序列化，后者实现了序列化。同时每个方法都提供了重载方法，我常用的总共有5个。

基本数据类型的解析

1
2
3
4
5
Gson gson = new Gson();
int i = gson.fromJson("100", int.class);              //100
double d = gson.fromJson(""99.99"", double.class);  //99.99
boolean b = gson.fromJson("true", boolean.class);     // true
String str = gson.fromJson("String", String.class);   // String

注：不知道你是否注意到了第2、3行有什么不一样没

基本数据类型的生成

1
2
3
4
Gson gson = new Gson();
String jsonNumber = gson.toJson(100);       // 100
String jsonBoolean = gson.toJson(false);    // false
String jsonString = gson.toJson("String"); //"String"

POJO类的生成与解析

1
2
3
4
5
6
public class User {
    //省略其它
    public String name;
    public int age;
    public String emailAddress;
}

生成JSON：

1
2
3
Gson gson = new Gson();
User user = new User("怪盗kidou",24);
String jsonObject = gson.toJson(user); // {"name":"怪盗kidou","age":24}

解析JSON：

1
2
3
Gson gson = new Gson();
String jsonString = "{"name":"怪盗kidou","age":24}";
User user = gson.fromJson(jsonString, User.class);

二、属性重命名 @SerializedName 注解的使用

从上面POJO的生成与解析可以看出json的字段和值是的名称和类型是一一对应的，但也有一定容错机制(如第一个例子第3行将字符串的99.99转成double型，你可别告诉我都是字符串啊)，但有时候也会出现一些不和谐的情况，如：
期望的json格式

1
{"name":"怪盗kidou","age":24,"emailAddress":"[email protected]"}

实际

1
{"name":"怪盗kidou","age":24,"email_address":"[email protected]"}

这对于使用PHP作为后台开发语言时很常见的情况，php和js在命名时一般采用下划线风格，而Java中一般采用的驼峰法，让后台的哥们改吧 前端和后台都不爽，但要自己使用下划线风格时我会感到不适应，怎么办?难到没有两全齐美的方法么?

我们知道Gson在序列化和反序列化时需要使用反射，说到反射就不得不想到注解,一般各类库都将注解放到annotations包下，打开源码在com.google.gson包下果然有一个annotations，里面有一个SerializedName的注解类，这应该就是我们要找的。

那么对于json中email_address这个属性对应POJO的属性则变成：

1
2
@SerializedName("email_address")
public String emailAddress;

这样的话，很好的保留了前端、后台、Android/java各自的命名习惯。

你以为这样就完了么?

如果接中设计不严谨或者其它地方可以重用该类，其它字段都一样，就emailAddress 字段不一样，比如有下面三种情况那怎么?重新写一个?

1
{"name":"怪盗kidou","age":24,"emailAddress":"[email protected]"}
1
{"name":"怪盗kidou","age":24,"email_address":"[email protected]"}
1
{"name":"怪盗kidou","age":24,"email":"[email protected]"}

为POJO字段提供备选属性名
SerializedName注解提供了两个属性，上面用到了其中一个，别外还有一个属性alternate，接收一个String数组。
注：alternate需要2.4版本

1
2
@SerializedName(value = "emailAddress", alternate = {"email", "email_address"})
public String emailAddress;

当上面的三个属性(email_address、email、emailAddress)都中出现任意一个时均可以得到正确的结果。
注：当多种情况同时出时，以最后一个出现的值为准。

1
2
3
4
Gson gson = new Gson();
String json = "{"name":"怪盗kidou","age":24,"emailAddress":"[email protected]","email":"[email protected]","email_address":"[email protected]"}";
User user = gson.fromJson(json, User.class);
System.out.println(user.emailAddress); // [email protected]

三、Gson中使用泛型

上面了解的JSON中的Number、boolean、Object和String，现在说一下Array。

例：JSON字符串数组

1
["Android","Java","PHP"]

当我们要通过Gson解析这个json时，一般有两种方式：使用数组，使用List。而List对于增删都是比较方便的，所以实际使用是还是List比较多。

数组比较简单

1
2
3
Gson gson = new Gson();
String jsonArray = "["Android","Java","PHP"]";
String[] strings = gson.fromJson(jsonArray, String[].class);

但对于List将上面的代码中的 String[].class 直接改为 List<String>.class 是行不通的。对于Java来说List<String> 和List<User> 这俩个的字节码文件只一个那就是List.class，这是Java泛型使用时要注意的问题 泛型擦除。

为了解决的上面的问题，Gson为我们提供了TypeToken来实现对泛型的支持，所以当我们希望使用将以上的数据解析为List<String>时需要这样写。

1
2
3
4
Gson gson = new Gson();
String jsonArray = "["Android","Java","PHP"]";
String[] strings = gson.fromJson(jsonArray, String[].class);
List<String> stringList = gson.fromJson(jsonArray, new TypeToken<List<String>>() {}.getType());

注：TypeToken的构造方法是protected修饰的,所以上面才会写成new TypeToken<List<String>>() {}.getType() 而不是 new TypeToken<List<String>>().getType()

泛型解析对接口POJO的设计影响
泛型的引入可以减少无关的代码，如我现在所在公司接口返回的数据分为两类：

1
{"code":"0","message":"success","data":{}}
1
{"code":"0","message":"success","data":[]}

我们真正需要的data所包含的数据，而code只使用一次，message则几乎不用。如果Gson不支持泛型或不知道Gson支持泛型的同学一定会这么定义POJO。

1
2
3
4
5
public class UserResponse {
    public int code;
    public String message;
    public User data;
}

当其它接口的时候又重新定义一个XXResponse将data的类型改成XX，很明显code，和message被重复定义了多次，通过泛型的话我们可以将code和message字段抽取到一个Result的类中，这样我们只需要编写data字段所对应的POJO即可，更专注于我们的业务逻辑。如：

1
2
3
4
5
public class Result<T> {
    public int code;
    public String message;
    public T data;
}

那么对于data字段是User时则可以写为 Result<User> ,当是个列表的时候为 Result<List<User>>，其它同理。

PS：嫌每次 new TypeToken<Result<XXX> 和 new TypeToken<Result<List<XXX>> 太麻烦, 想进一步封装? 查看我的另一篇博客： 《搞定Gson泛型封装》

结语

本文主要通过代码向各位读者讲解了Gson的基本用法，以后还会更新更多更高级的用法，如果你还不熟悉 注解和泛型 那么你要多多努力啦。

如果你有其它的想了解的内容(不限于Gson)请给我留言评论，水平有限，欢迎拍砖。

4月6日补充
有说看不懂Result那段怎么个简化法，下面给个两个完整的例子，User和List<User> 。

没有引入泛型之前时写法：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
public class UserResult {
    public int code;
    public String message;
    public User data;
}
//=========
public class UserListResult {
    public int code;
    public String message;
    public List<User> data;
}
//=========
String json = "{..........}";
Gson gson = new Gson();
UserResult userResult = gson.fromJson(json,UserResult.class);
User user = userResult.data;
 
UserListResult userListResult = gson.fromJson(json,UserListResult.class);
List<User> users = userListResult.data;

上面有两个类UserResult和UserListResult，有两个字段重复，一两个接口就算了，如果有上百个怎么办?不得累死?所以引入泛型。

1
2
3
4
5
6
7
8
//不再重复定义Result类
Type userType = new TypeToken<Result<User>>(){}.getType();
Result<User> userResult = gson.fromJson(json,userType);
User user = userResult.data;
 
Type userListType = new TypeToken<Result<List<User>>>(){}.getType();
Result<List<User>> userListResult = gson.fromJson(json,userListType);
List<User> users = userListResult.data;

看出区别了么?引入了泛型之后虽然要多写一句话用于获取泛型信息，但是返回值类型很直观，也少定义了很多无关类。

 

from: http://www.importnew.com/23862.html

你真的会用gson吗?gson使用指南

JSON(官网)是一种文本形式的数据交换格式，它比XML更轻量、比二进制容易阅读和编写，调式也更加方便。其重要性不言而喻。解析和生成的方式很多，Java中最常用的类库有：JSON-Java、Gson、Jackson、FastJson等。注：此系列基于Gson2.4... 查看详情

你真的会用gson吗?gson使用指南

原文出处： 怪盗kidou注：此系列基于Gson2.4。本次的主要内容：字段过滤的几种方法基于@Expose注解基于版本基于访问修饰符基于策略（作者最常用）POJO与JSON的字段映射规则一、字段过滤的几种方法字段过滤Gson中比较常用的... 查看详情

导入了gson.jar为啥会用不了？

导入的gson.jar必须放在WEB-INF的lib下。。。。我也是刚刚才解决参考技术A看看buildpath设置的对不对。 参考技术B你试试Gsongson=newGson();不行吗？ 参考技术Cjar包确定放在WEB-INF下的lib里吗？ 查看详情

Gson 可以生成 XML 吗？ [关闭]

...ed]【发布时间】：2014-03-1612:34:09【问题描述】：是否可以使用Gson库来生成XML？我知道gson-xml可以将XML读入Gson。有没有图书馆可以让你走另一条路？我的动机是我有一个复杂的应用程序，它需要同时序列化为JSON和XML，我希望使用... 查看详情

你真的会用postman吗？(代码片段)

1.场景提到Postman，大部分的人可能只停留在使用Postman「模拟网络请求」这单一功能上面。事实上，Postman的功能很强大，下面将罗列出几个比较少用，但实用的功能。2.抓包及拦截器除了Fiddler和Charles，Postman也可以用来抓包，而... 查看详情

gson中文指南(代码片段)

...很多Gson的文章介绍的比较琐碎，于是干脆把GitHub上的使用介绍给翻译了出来。原文地址：https://github.com/google/gson/blob/master/UserGuide.mdGson库中最重要的类是Gson，你可以通过调用newGson()来创建一个Gson对象。同时也提供一... 查看详情

gson用户指南

...，包括你没有源代码的现有对象。Gson的目标提供简单的使用方式，例 查看详情

genson和gson，fastjson比有啥优势吗

gson和fastjson我都在项目使用过了，相比较而言，gson对字段的处理更细腻一些，有版本号的概念，相对更灵活，值得注意是，gson直接入侵字段，则不是setget方法；fastjson速度更快，但字段的处理不够灵活，特别是处理同一个Javabean... 查看详情

gson中文指南(代码片段)

...很多Gson的文章介绍的比较琐碎，于是干脆把GitHub上的使用介绍给翻译了出来。原文地址：https://github.com/google/gson/blob/master/UserGuide.mdGson库中最重要的类是Gson，你可以通过调用newGson()来创建一个Gson对象。同时也提供一... 查看详情

都2022年了，你真的会用python的pip吗？(代码片段)

...常会使用pip命令去安装第三方模块，但细细琢磨下来，我真的掌握这款工具了吗？本文为你全面揭示一下pip包管理工具的使用！⛳️pip简介pip是Python默认集成的包管理工具，而其本质就是Python标准库中的一个包，只是比较特殊一... 查看详情

使用 GSON 的 JsonReader 流式传输 Json 文件时，您可以将对象转储为字符串吗？

】使用GSON的JsonReader流式传输Json文件时，您可以将对象转储为字符串吗？【英文标题】：WhenstreamingaJsonfilewithGSON\'sJsonReader,canyoudumpanobjecttostring?【发布时间】：2020-05-0614:31:13【问题描述】：我正在使用Java使用GSON库来处理一个巨... 查看详情

gson转换日期会失真吗

...日期类型（WedDec2517:25:57CST2019）首先定义的实体bean，必须使用Date类型，之后使用JsonDeserializer处理。2、将日期（WedDec2517:25:57CST2019）类型转为时间戳（1577265957000）。3、将时间戳格式化为我们想要的格式如（YYYY-MM-dd）与2的思路一... 查看详情

couldnotfindclasscom.google.gson.gson

在Android开发中使用gson解析json字符串，出现异常：java.lang.classnotfoundexception:com.google.gson.Gson。解决方案如下： 这个异常的怪异之处在于，你可能已经将google的gson包导入了项目，但是为什么应用程序仍然报错，说找不到这个类... 查看详情

都2022年了，你真的会用python的pip吗？(代码片段)

...pip命令去安装第三方模块，但细细琢磨下来，我真的掌握这款工具了吗？本文为你全面揭示一下pip包管理工具的使用！⛳️pip简介pip是Python默认集成的包管理工具，而其本质就是Pyt 查看详情

都2022年了，你真的会用python的pip吗？(代码片段)

...pip命令去安装第三方模块，但细细琢磨下来，我真的掌握这款工具了吗？本文为你全面揭示一下pip包管理工具的使用！⛳️pip简介pip是Python默认集成的包管理工具，而其本质就是Pyt 查看详情

如何使用 gson 解析 json？

】如何使用gson解析json？【英文标题】：Howtoparsejsonusinggson?【发布时间】：2017-06-1016:37:12【问题描述】：我怎样才能得到时间或文字这个jsonhttp://www.mocky.io/v2/58889af52600007c1d966456有人可以帮助我吗？？？【问题讨论】：如果你足够... 查看详情

使用 Gson 将 XML 文件转换为 Json

】使用Gson将XML文件转换为Json【英文标题】：ConvertanXMLfiletoJsonusingusingGson【发布时间】：2015-02-2306:32:35【问题描述】：我发现网上和这里的许多教程也参考net.sf.json库来将xml文件转换为json对象。但是，我想要一个最好使用Gson的替... 查看详情

kotlin基础从入门到进阶系列讲解（入门篇）android之gson的使用(代码片段)

Kotlin基础从入门到进阶系列讲解（入门篇）Android之GSON的使用Android之GSON的使用Android之GSON的使用->返回总目录<-Google提供的GSON开源库可以让解析JSON数据的工作简单到让你不敢想象的地步项目中需要添加GSON库的依赖。编辑app/b... 查看详情