利用Gson完成json与java对象的转换

原文地址：http://www.studytrails.com/java/json/java-google-json-parse-json-to-java/，有删减。

利用Gson完成json与java对象的转换

Google开发的GSON库提供了一系列的方法，用于将json字符串转换成java对象。总的来讲，方法有两种：

使用com.google.gson.Gson类。你可以创建一个这个类的实例，并使用它的public方法<T> T fromJson(String json, Class<T> classOfT)来获取一个对象。参数classOfT对应将要被转换成的对象的类。

使用com.google.gson.GsonBuilder类。通过这个类，你可以设置一些附加特性，比如允许导出null值、设置自定义序列化策略等。配置完毕之后，你可以通过这个build对象获得需要的Gson对象。

下面进入实例讲解部分。

Albums类是这个案例中主要使用的类，它包含一个Dataset列表，每个Dateset对象代表一张唱片。下面我们将利用GSON将一个json字符串转换成一个Albums对象，然后再将这个Albums对象转换成一个json字符串，以此来研究GSON的序列化（serialization ）与反序列化（deserialization ）。下面是我们将要使用的json：

{
title: "Free Music Archive - Albums",
message: "",
errors: [ ],
total: "11259",
total_pages: 2252,
page: 1,
limit: "5",
dataset: [
{
......

在这里，我们先忽略掉dataset，构建一个简单的java类来存储根部信息。为了节约篇幅，我们会将类中的域都声明为public的。在实际使用中，你应当将它们都声明为private的，并提供相应的setter方法。

class Albums {
public String title;
public String message;
public String[] errors = new String[]{};
public String total;
public int total_pages;
public int page;
public String limit;
}

下面，让我们看看怎么把它转成一个json：

import com.google.gson.Gson;
import com.google.gson.GsonBuilder;

public class Albums {
public String title;
public String message;
public String[] errors = new String[]{};
public String total;
public int total_pages;
public int page;
public String limit;
public static void main(String[] args) {
Albums albums = new Albums();
albums.title = "Free Music Archive - Albums";
albums.message = "";
albums.total = "11259";
albums.total_pages = 2252;
albums.page = 1;
albums.limit = "5";
GsonBuilder builder = new GsonBuilder();
Gson gson = builder.create();
System.out.println(gson.toJson(albums));
}

}

输出结果为：

{"title":"Free Music Archive - Albums","message":"","errors":[],"total":"11259","total_pages":2252,"page":1,"limit":"5"}

这是一个好的开始！注意，这里我们将errors初始化成了一个空数组。如果不这么做的话，Gson会认为它的值为null并忽略它。如果事先设置了允许输出null，结果中会打印出一个null值。在这种情况下，或许将error声明为一个List更好：

public List<String> errors = new ArrayList<>();

在上面的例子中，我们使用了GsonBuilder类，因为它能够允许我们对转换过程进行自定义。在后面的例子中，我们会看到这么做的好处。下一步是为dataset创建一个类。dataset的json如下：

dataset: [
{
album_id: "7596",
album_title: "!!! - Live @ KEXP 7/24/2010",
......
album_images: [
{
image_id: "10574",
user_id: null,
.....
}
],
tags: [ ]

在这个案例中，我们只考虑dataset的一部分域以及album_images。dataset包含一个数组，数组中每个对象代表一个唱片。每个唱片除了一些域之外，还包含一个album_images数组。下面看看我们为它们创建的类：

class Dataset {
public String album_id;
public String album_title;
}

class AlbumImages {
public String image_id;
public String user_id;
}

下面，我们来创建一个Dataset对象：

Dataset dataset = new Dataset();
dataset.album_id = "7596";
dataset.album_title = "Album 1";
System.out.println(gson.toJson(dataset));

输出结果为：

{"album_id":"7596","album_title":"Album 1"}

再创建一个AlbumImages对象：

AlbumImages image = new AlbumImages();
image.image_id = "1";
System.out.println(gson.toJson(image));

输出结果为：

{"image_id":"1"}

结果中可以看到，Gson忽略了空的user_id。如果想要输出一个null值，可以作以下设置：

builder.serializeNulls();

此时，输出结果为：

{"image_id":"1","user_id":null}

下面看看如何将Dataset嵌入到Albums中，以及将AlbumImage嵌入到Dataset中。

在Albums类中添加dataset域：

public List<Dataset> dataset = new ArrayList<>();

在Dataset中添加images域：

public List<AlbumImages> images = new ArrayList<>();

在创建完各个对象后，加上如下代码：

dataset.images.add(image);
albums.dataset.add(dataset);

下面看看输出gson.toJson(albums)的结果：

{"title":"Free Music Archive - Albums","message":"","errors":[],"total":"11259","total_pages":2252,"page":1,"limit":"5","dataset":[{"album_id":"7596","album_title":"Album 1","images":[{"image_id":"1","user_id":null}]}]}

看起来可能不太美观。如果想要结果看起来整洁一些，可以这么设置：

builder.setPrettyPrinting().serializeNulls();

结果如下：

{
"title": "Free Music Archive - Albums",
"message": "",
"errors": [],
"total": "11259",
"total_pages": 2252,
"page": 1,
"limit": "5",
"dataset": [
{
"album_id": "7596",
"album_title": "Album 1",
"images": [
{
"image_id": "1",
"user_id": null
}
]
}
]
}

当然了，在进行网络传输时，发送的数据应当尽可能地小。因此上面的格式只应作为编程测试时的辅助，不应在正式版本中使用。

考虑到不同语言的命名规范不同（Java的驼峰式，php等的下划线风格），可以使用@SerializedName注解来改变输出时的属性名。比如将images改成album_images：

@SerializedName("album_images")
public List<AlbumImages> images = new ArrayList<>();

输出结果（部分）为：

"dataset": [
{
"album_id": "7596",
"album_title": "Album 1",
"album_images": [
{
"image_id": "1",
"user_id": null
}
]
}
]

事实上，我们可能不太愿意将自己的Java类与Gson绑定起来。这里还有一种方法——为GsonBuilder设置一个NamingStrategy：

builder.setFieldNamingStrategy(new FieldNamingStrategy() {

@Override
public String translateName(Field f) {
if(f.getName().equals("images")){
return "album_images";
}else{
return f.getName();
}
}
});

结果和上面的相同。

注：下面的部分是我自己写的，作者给的提供json的URL打不开。

将json转换成java对象同样非常容易，下面的代码展示了这一点：

String json = gson.toJson(albums);
Albums albums2 = gson.fromJson(json, Albums.class);
System.out.println(albums.title);
System.out.println(albums2.total_pages);

输出结果为：

Free Music Archive - Albums
2252