使用 Jackson 解析 JSON 和序列化

发布： 分类： 阅读： 评论：
本文字数： 1.8k 阅读时长 ≈ 9 分钟

在 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 中加入如下依赖即可：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
<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，代码如下：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
//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 字符串，代码如下：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
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("Jeffrey");
        user.setEmail("xxx@xxx.com");
        user.setAge(20);
        user.setBirthday(new SimpleDateFormat("yyyy-MM-dd").parse("1995-08-23"));

        
        ObjectMapper mapper = new ObjectMapper();
        //User类转JSON
        //输出结果：{"name":"Jeffrey","age":20,"birthday":809107200000,"email":"xxx@xxx.com"}
        String json = mapper.writeValueAsString(user);
        System.out.println(json);

        //Java集合转JSON
        //输出结果：[{"name":"Jeffrey","age":20,"birthday":809107200000,"email":"xxx@xxx.com"}]
        List<User> users = new ArrayList<User>();
        users.add(user);
        String jsonlist = mapper.writeValueAsString(users);
        System.out.println(jsonlist);
    }

}

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

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

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
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":"Jeffrey","age":20,"birthday":809107200000,"email":"xxx@xxx.com"}";
        ObjectMapper mapper = new ObjectMapper();
        User user = mapper.readValue(json,User.class);
        // 输出结果：User{name='Jeffrey', age=20, birthday=Wed Aug 23 00:00:00 CST 1995, email='xxx@xxx.com'}
        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 类进行一些修改，修改部分代码如下：

1
2
3
4
5
6
7
8
9
10
11
//序列化时忽略此属性
@JsonIgnore
private Integer age;

//将日期进行格式化
@JsonFormat(pattern = "yyyy-MM-dd")
private Date birthday;

//将email序列化为e-mail
@JsonProperty("e-mail")
private String email;

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

1
{"name":"Jeffrey","birthday":"1995-08-22","e-mail":"xxx@xxx.com"}

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

总结

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

相关文章