使用Jackson解析JSON和序列化

在Web开发过程中，利用JSON可以帮助我们更加方便的开发我们的应用。那么在Java语言中，如何实现Java实例与JSON之间的相互转换（序列化与反序列化）呢？目前流行的JSON第三方类库有Jackson、Gson、Fastjson等，本文将简单介绍如何使用Jackson进行JSON的解析与序列化。

一、获取Jackson

获取Jackson可以通过Maven或直接下载jar包两种方式，通常我们只需要下载Jackson的jackson-core核心包即可，如果希望使用更多功能（例如注解），还需要下载另外的jar包。Jackson为我们提供了以下jar包：

1. jackson-core.jar——核心包（必须），提供基于“流模式”解析的API。
2. jackson-databind——数据绑定包（可选），提供基于“对象绑定”和“树模型”相关API。
3. jackson-annotations——注解包（可选），提供注解功能。

目前Jackson的最新版本为2.8.2。

1、通过Maven获取

使用Maven获取Jackson十分方便，只需要在pom.xml中加入如下依赖即可：

        <dependency>            <groupId>com.fasterxml.jackson.core</groupId>            <artifactId>jackson-core</artifactId>            <version>2.8.2</version>        </dependency>        <dependency>            <groupId>com.fasterxml.jackson.core</groupId>            <artifactId>jackson-annotations</artifactId>            <version>2.8.2</version>        </dependency>        <dependency>            <groupId>com.fasterxml.jackson.core</groupId>            <artifactId>jackson-databind</artifactId>            <version>2.8.2</version>        </dependency>

2、直接下载jar包

官方为我们提供了两种直接下载jar包的途径：

1. Central Maven repository：http://repo1.maven.org/maven2/com/fasterxml/jackson/core/
2. Wiki：https://github.com/FasterXML/jackson-core/wiki

二、用于测试的Java类

为了方便我们学习和测试Jackson，我们首先准备一个Java类User，代码如下：

//JSON序列化和反序列化使用的User类import java.util.Date;public class User {private String name;private Integer age;private Date birthday;private String email;public String getName() {return name;}public void setName(String name) {this.name = name;}public Integer getAge() {return age;}public void setAge(Integer age) {this.age = age;}public Date getBirthday() {return birthday;}public void setBirthday(Date birthday) {this.birthday = birthday;}public String getEmail() {return email;}public void setEmail(String email) {this.email = email;}}

三、JSON序列化（Java对象转JSON）

在使用Jackson之前，我们先来了解一下Jackson中的一个核心类：ObjectMapper，我们几乎所有的操作都在使用该类的API。

ObjectMapper有多个JSON序列化的方法，可以把JSON字符串保存File、OutputStream等不同的介质中。

• writeValue(File arg0, Object arg1)把arg1转成json序列，并保存到arg0文件中。
• writeValue(OutputStream arg0, Object arg1)把arg1转成json序列，并保存到arg0输出流中。
• writeValueAsBytes(Object arg0)把arg0转成json序列，并把结果输出成字节数组。
• writeValueAsString(Object arg0)把arg0转成json序列，并把结果输出成字符串。

这些方法使用起来都十分简单，为了简洁直观的介绍Jackson的使用方法，我们只介绍writeValueAsString(Object obj)的使用方法，用于将Java对象转换为一个JSON字符串，代码如下：

package cn.javacodes.jackson.test;import com.fasterxml.jackson.core.JsonProcessingException;import com.fasterxml.jackson.databind.ObjectMapper;import java.text.ParseException;import java.text.SimpleDateFormat;import java.util.ArrayList;import java.util.List;/** * Created by huzha on 2016-09-07. */public class JacksonTest {    public static void main(String[] args) throws JsonProcessingException, ParseException {        User user = new User();        user.setName("Eric");        user.setEmail("[e-mail]");        user.setAge(20);        user.setBirthday(new SimpleDateFormat("yyyy-MM-dd").parse("1995-08-23"));                ObjectMapper mapper = new ObjectMapper();        //User类转JSON        //输出结果：{"name":"Eric","age":20,"birthday":809107200000,"email":"[e-mail]"}        String json = mapper.writeValueAsString(user);        System.out.println(json);        //Java集合转JSON        //输出结果：[{"name":"Eric","age":20,"birthday":809107200000,"email":"[e-mail]"}]        List<User> users = new ArrayList<User>();        users.add(user);        String jsonlist = mapper.writeValueAsString(users);        System.out.println(jsonlist);    }}

四、JSON反序列化（JSON转Java对象）

Jackson为我们提供了许多JSON反序列化的方法，其中比较常用的方法如下：

我们可以将文件、URL、字符串、流、字节数组等作为数据源进行解析，废话不多说，看例子：

package cn.javacodes.jackson.test;import com.fasterxml.jackson.databind.ObjectMapper;import java.io.IOException;import java.text.ParseException;/** * Created by huzha on 2016-09-07. */public class JacksonTest {    public static void main(String[] args) throws IOException, ParseException {        String json = "{\"name\":\"Eric\",\"age\":20,\"birthday\":809107200000,\"email\":\"[e-mail]\"}";        ObjectMapper mapper = new ObjectMapper();        User user = mapper.readValue(json,User.class);        // 输出结果：User{name='Eric', age=20, birthday=Wed Aug 23 00:00:00 CST 1995, email='[e-mail]'}        System.out.println(user.toString());    }}

五、JSON注解

Jackson提供了一系列注解，方便对JSON序列化和反序列化进行控制，下面介绍一些常用的注解。

@JsonIgnore 此注解用于属性上，作用是进行JSON操作时忽略该属性。

@JsonFormat 此注解用于属性上，作用是把Date类型直接转化为想要的格式，如@JsonFormat(pattern = "yyyy-MM-dd HH-mm-ss")。

@JsonProperty 此注解用于属性上，作用是把该属性的名称序列化为另外一个名称，如把trueName属性序列化为name，@JsonProperty("name")。

例如我们对User类进行一些修改，修改部分代码如下：

    //序列化时忽略此属性    @JsonIgnore    private Integer age;    //将日期进行格式化    @JsonFormat(pattern = "yyyy-MM-dd")    private Date birthday;    //将email序列化为e-mail    @JsonProperty("e-mail")    private String email;

再次通过上述序列化方法进行转换，查看输出结果为：

{"name":"Eric","birthday":"1995-08-22","e-mail":"[e-mail]"}

可以看到注解已经起了效果。

总结

在Java中使用Jackson解析和序列化JSON是十分方便的，而且Jackson在性能上也是十分出色的。使用Jackson操作JSON的核心是ObjectMapper类，我们几乎所有的操作都是通过这个类的实例来进行的。当然，如果你有兴趣，也可以尝试使用Gson或FastJson操作JSON，他们的使用方法大致上是相同的。

本文为博主独立博客（https://javacodes.cn）同步发表，转载请注明出处：

原文链接：https://javacodes.cn/310.html