Gson是目前功能最强的JSON解析器,并且不需要依赖额外jar包,能够直接运行在java平台。与另一款优秀的JSON解析器FastJson相比Gson的优势是可以准确顺利的转换复杂Bean,而FastJson对一些复杂Bean的转换就会出现一些问题。所以让我们一起来学学这款神器吧!

第一步:导入依赖。

目前,Gson最新版是2.8.6,我们就用这个版本演示。在pom文件中添加Maven的Gson依赖,Gson是不依赖其它jar包的。

com.google.code.gson

gson

2.8.6

第二步:开始使用

在开发中,Json转换的场景往往也就是那么几个。

将JavaBean转换为json,或将json字符串转换为JavaBean。将List集合转换为json,或将json转换为List集合。将Map集合转换为json,或将json转换为Map集合。

使用场景一:转换普通对象(Bean)。

将普通的JavaBean转换为Json字符串是最常用的操作了,首先创建一个简单的类,例如:Person。

public class Person

{

private String name;

private int age;

private boolean isMale;

private List hobbies;

// 省略构造器和getter/setter方法,注意重写toString方法,便于查看控制台输出。

@Override

public String toString()

{

final StringBuilder sb = new StringBuilder("Person{");

sb.append("name='").append(name).append('\'');

sb.append(", age=").append(age);

sb.append(", isMale=").append(isMale);

sb.append(", hobbies=").append(hobbies);

sb.append('}');

return sb.toString();

}

}

使用Gson解析Person的实例。

先创建Person对象。在创建Gson对象。调用Gson的String toJson(Object)方法,来将对象转换为json字符串。

@Test

public void testBeanToJson()

{

// 创建Bean

Person p = new Person("艾伦·耶格尔", 16, true, Arrays.asList("自由", "迫害莱纳"));

// 创建Gson对象

Gson gson = new Gson();

// 调用Gson的String toJson(Object)方法将Bean转换为json字符串

String pJson = gson.toJson(p);

System.out.println(pJson);

// {"name":"艾伦·耶格尔","age":16,"isMale":true,"hobbies":["自由","迫害莱纳"]}

}

将Person实例的json字符串转换为Person对象。

调用Gson的 t fromJson(String, Class)方法,将Json串转换为对象

// 调用Gson的 t fromJson(String, Class)方法,将Json串转换为对象

Person person = gson.fromJson(pJson, Person.class);

System.out.println(person);

// Person{name='艾伦·耶格尔', age=16, isMale=true, hobbies=[自由, 迫害莱纳]}

使用场景二:转换List集合。

大致步骤和转换普通JavaBean一样。

@Test

public void testListToJson()

{

// 先准备一个List集合

List list = new ArrayList();

list.add(new Person("三笠·阿克曼", 16, false, Arrays.asList("砍巨人", "保护艾伦")));

list.add(new Person("阿明·阿诺德", 16, true, Arrays.asList("看书", "玩海螺")));

System.out.println(list);

// 创建Gson实例

Gson gson = new Gson();

// 调用Gson的toJson方法

String listJson = gson.toJson(list);

System.out.println(listJson);

// [{"name":"三笠·阿克曼","age":16,"isMale":false,"hobbies":["砍巨人","保护艾伦"]},{"name":"阿明·阿诺德","age":16,"isMale":true,"hobbies":["看书","玩海螺"]}]

}

但是,将Json字符串转换为List对象的时候,就有一点不同了。

由于List接口带泛型,如果还调用 t fromJson(String, Class)方法,那么返回的虽然还是个List集合,但是集合里面的数据却不是Person对象,而是Map对象,并将Person属性以键值对的形式存放在Map的实例中。让我们来验证一下。

......// 此处延续以上代码

List fromJson = gson.fromJson(listJson, List.class);

System.out.println(fromJson.get(0).getClass());

// class com.google.gson.internal.LinkedTreeMap

要想获取的List还和之前的一毛一样,那么我们需要调用Gson的 T fromJson(String, Type) 方法。如下:

此方法参数中的Type类型可以通过Gson包提供TypeToken<>类获取。这个类带有泛型,且这个泛型就是Json串转换成为对象后的类型(此处是List)我们不需要重写这个类中的任何方法,只需要创建这个类的一个匿名内部类并调用getTpye()方法即可。

注意:一定要将这个匿名内部类的泛型写为Json字符串解析后生成的对象类型。

......// 此处延续以上代码

// 调用Gson的 T fromJson(String, Type)将List集合的json串反序列化为List对象

List plist = gson.fromJson(listJson, new TypeToken>(){}.getType());

System.out.println(plist);

// [Person{name='三笠·阿克曼', age=16, isMale=false, hobbies=[砍巨人, 保护艾伦]}, Person{name='阿明·阿诺德', age=16, isMale=true, hobbies=[看书, 玩海螺]}]

使用场景三:转换Map集合。

转换Map的步骤就和转换List的步骤一模一样了,代码如下。详解请看List转换。

@Test

public void testMapToJson()

{

Map map = new HashMap<>();

map.put("p1", new Person("利威尔·阿克曼", 35, true, Arrays.asList("砍猴儿", "打扫卫生")));

map.put("p2", new Person("韩吉·佐耶", 33, false, Arrays.asList("研究巨人", "讲故事")));

Gson gson = new Gson();

String mapJson = gson.toJson(map);

System.out.println(mapJson);

// {"p1":{"name":"利威尔·阿克曼","age":35,"isMale":true,"hobbies":["砍猴儿","打扫卫生"]},"p2":{"name":"韩吉·佐耶","age":33,"isMale":false,"hobbies":["研究巨人","讲故事"]}}

Map jsonMap = gson.fromJson(mapJson, new TypeToken>() { }.getType());

System.out.println(jsonMap);

}