Jackson 是当前用的比较广泛的，用来序列化和反序列化 json 的 Java 的开源框架。Jackson 社 区相对比较活跃，更新速度也比较快， 从 Github 中的统计来看，Jackson 是最流行的 json 解析器之一 。 Spring MVC 的默认 json 解析器便是 Jackson。 Jackson 优点很多。 Jackson 所依赖的 jar 包较少 ，简单易用。与其他 Java 的 json 的框架 Gson 等相比， Jackson 解析大的 json 文件速度比较快；Jackson 运行时占用内存比较低，性能比较好；Jackson 有灵活的 API，可以很容易进行扩展和定制。
Jackson 的 1.x 版本的包名是 org.codehaus.jackson ，当升级到 2.x 版本时，包名变为 com.fasterxml.jackson，本文讨论的内容是基于最新的 Jackson 的 2.9.1 版本。
Jackson 的核心模块由三部分组成。
- jackson-core，核心包，提供基于"流模式"解析的相关 API，它包括 JsonPaser 和 JsonGenerator。 Jackson 内部实现正是通过高性能的流模式 API 的 JsonGenerator 和 JsonParser 来生成和解析 json。
- jackson-annotations，注解包，提供标准注解功能；
- jackson-databind ，数据绑定包， 提供基于"对象绑定" 解析的相关 API （ ObjectMapper ） 和"树模型" 解析的相关 API （JsonNode）；基于"对象绑定" 解析的 API 和"树模型"解析的 API 依赖基于"流模式"解析的 API。
在了解 Jackson 的概要情况之后，下面介绍 Jackson 的基本用法。
Jackson 的 基本用法
若想在 Java 代码中使用 Jackson 的核心模块的 jar 包 ，需要在 pom.xml 中添加如下信息。
清单 1.在 pom.xml 的 Jackson 的配置信息
| 1 2 3 4 5 |
|
jackson-databind 依赖 jackson-core 和 jackson-annotations，当添加 jackson-databind 之后， jackson-core 和 jackson-annotations 也随之添加到 Java 项目工程中。在添加相关依赖包之后，就可以使用 Jackson。
ObjectMapper 的 使用
Jackson 最常用的 API 就是基于"对象绑定" 的 ObjectMapper。下面是一个 ObjectMapper 的使用的简单示例。
清单 2 . ObjectMapper 使用示例
| 1 2 3 4 5 6 7 |
|
ObjectMapper 通过 writeValue 系列方法 将 java 对 象序列化 为 json，并 将 json 存 储成不同的格式，String（writeValueAsString），Byte Array（writeValueAsString），Writer， File，OutStream 和 DataOutput。
ObjectMapper 通过 readValue 系列方法从不同的数据源像 String ， Byte Array， Reader，File，URL， InputStream 将 json 反序列化为 java 对象。
信息配置
在调用 writeValue 或调用 readValue 方法之前，往往需要设置 ObjectMapper 的相关配置信息。这些配置信息应用 java 对象的所有属性上。示例如下：
清单 3 . 配置信息使用示例
| 1 2 3 4 5 6 7 8 9 |
|
更多配置信息可以查看 Jackson 的 DeserializationFeature，SerializationFeature 和 I nclude。
Jackson 的 注解的使用
Jackson 根据它的默认方式序列化和反序列化 java 对象，若根据实际需要，灵活的调整它的默认方式，可以使用 Jackson 的注解。常用的注解及用法如下。
表 1. Jackson 的 常用注解
| 注解 | 用法 |
|---|---|
| @JsonProperty | 用于属性，把属性的名称序列化时转换为另外一个名称。示例： @JsonProperty("birth_ d ate") private Date birthDate; |
| @JsonFormat | 用于属性或者方法，把属性的格式序列化时转换成指定的格式。示例： @JsonFormat(timezone = "GMT+8", pattern = "yyyy-MM-dd HH:mm") public Date getBirthDate() |
| @JsonPropertyOrder | 用于类， 指定属性在序列化时 json 中的顺序 ， 示例： @JsonPropertyOrder({ "birth_Date", "name" }) public class Person |
| @JsonCreator | 用于构造方法，和 @JsonProperty 配合使用，适用有参数的构造方法。 示例： @JsonCreator public Person(@JsonProperty("name")String name) {…} |
| @JsonAnySetter | 用于属性或者方法，设置未反序列化的属性名和值作为键值存储到 map 中 @JsonAnySetter public void set(String key, Object value) { map.put(key, value); } |
| @JsonAnyGetter | 用于方法 ，获取所有未序列化的属性 public Map<String, Object> any() { return map; } |
在了解 Jackson 的基本用法后，下面详细地介绍它的一些高阶应用。
Jackson 的 高阶应用
格式处理（含日期格式）
不同类型的日期类型，Jackson 的处理方式也不同。
- 对于日期类型为 java.util.Calendar,java.util.GregorianCalendar,java.sql.Date,java.util.Date,java.sql.Timestamp，若不指定格式， 在 json 文件中将序列化 为 long 类型的数据。显然这种默认格式，可读性差，转换格式是必要的。Jackson 有 很多方式转换日期格式。
- 注解方式，请参照" Jackson 的注解的使用"的@ JsonFormat 的示例。
- ObjectMapper 方式，调用 ObjectMapper 的方法 setDateFormat，将序列化为指定格式的 string 类型的数据。
- 对于日期类型为 java.time.LocalDate，还需要添加代码 mapper.registerModule(new JavaTimeModule())，同时添加相应的依赖 jar 包
清单 4 . JSR31 0 的配置信息
| 1 2 3 4 5 |
|
对于 Jackson 2.5 以下版本，需要添加代码 objectMapper.registerModule(new JSR310Module ())
- 对于日期类型为 org.joda.time.DateTime，还需要添加代码 mapper.registerModule(new JodaModule())，同时添加相应的依赖 jar 包
清单 5. joda 的 配置信息
| 1 2 3 4 5 |
|
package com.ldd.domain;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import lombok.*;
import lombok.experimental.Accessors;
import lombok.extern.slf4j.Slf4j;
/**
* @author ldd
* @version 1.0.0
* */
@Data
@Accessors(chain = true)
@JsonPropertyOrder({"id","name"}) //指定顺序
public class User {
@Generated
@JsonProperty("id")
private Long id;
@JsonProperty("name")
private String name;
@JsonProperty("age")
private Integer age;
}
package com.ldd.TestMethod;
import com.fasterxml.jackson.annotation.JsonFormat;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.datatype.jdk8.Jdk8Module;
import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
import com.fasterxml.jackson.module.paramnames.ParameterNamesModule;
import com.ldd.domain.User;
import java.io.IOException;
import java.time.LocalDate;
import java.util.ArrayList;
import java.util.List;
import static java.lang.StrictMath.random;
public class JacksonTest {
public void test() throws IOException {
ObjectMapper mapper = new ObjectMapper();
//Method for registering a module that can extend functionality provided by this mapper
// ; for example, by adding providers for custom serializers and deserializers.
mapper.registerModule(new ParameterNamesModule())
.registerModule(new Jdk8Module())
.registerModule(new JavaTimeModule());
ClassA a = new ClassA();
a.setName("name1");
a.setLocalDate(LocalDate.now());
String json = mapper.writeValueAsString(a);
System.out.println(json);
ClassA a2 = mapper.readValue(json, ClassA.class);
System.out.println(a2.toString());
User user;
StringBuilder stringBuilder=new StringBuilder();
for(int i=0;i<100;i++)
{
Integer age=(int)(random()*30);
String name="liud"+age;
user=new User();
user.setId(new Long(i)).setName(name).setAge(age);
json = mapper.writeValueAsString(user);
stringBuilder.append(json);
System.out.println(json);
}
List<User> list=new ArrayList<>();
// user=mapper.reader()
//System.out.println(stringBuilder.toString());
}
static class ClassA {
private String name;
@JsonFormat(pattern = "yyyy-MM-dd")
private LocalDate localDate;
public LocalDate getLocalDate() {
return localDate;
}
public void setLocalDate(LocalDate localDate) {
this.localDate = localDate;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
@Override
public String toString() {
return "ClassA{" +
"name='" + name + '\'' +
", localDate=" + localDate +
'}';
}
}
public static void main(String args[]) throws IOException {
new JacksonTest().test();
}
}
泛型反序列化
Jackson 对泛型反序列化也提供很好的支持。
- 对于 List 类型 ，可以调用 constructCollectionType 方法来序列化，也可以构造 TypeReference 来序列化。
清单 6 . List 泛 型使用示例
| 1 2 3 4 5 |
|
- 对于 map 类型， 与 List 的实现方式相似。
清单 7 . Map 泛型使用示例
| 1 2 3 4 5 6 7 8 |
|
Array 和 Collection 的处理与 List，Map 相似，这里不再详述。
属性可视化
是 java 对象的所有的属性都被序列化和反序列化，换言之，不是所有属性都可视化，默认的属性可视化的规则如下：
- 若该属性修饰符是 public，该属性可序列化和反序列化。
- 若属性的修饰符不是 public，但是它的 getter 方法和 setter 方法是 public，该属性可序列化和反序列化。因为 getter 方法用于序列化， 而 setter 方法用于反序列化。
- 若属性只有 public 的 setter 方法，而无 public 的 getter 方 法，该属性只能用于反序列化。
若想更改默认的属性可视化的规则，需要调用 ObjectMapper 的方法 setVisibility。
下面的示例使修饰符为 protected 的属性 name 也可以序列化和反序列化。
清单 8 . 属性可视化示例
| 1 2 3 4 5 6 7 8 |
|
属性过滤
在将 Java 对象序列化为 json 时 ，有些属性需要过滤掉，不显示在 json 中 ， Jackson 有多种实现方法。
- 注解方式， 可以用 @JsonIgnore 过滤单个属性或用 @JsonIgnoreProperties 过滤多个属性，示例如下：
清单 9 . 属性过滤示例一
| 1 2 3 4 |
|
- addMixIn 方法加注解方式@JsonIgnoreProperties。
addMixIn 方法签名如下：
public ObjectMapper addMixIn(Class<?> target, Class<?> mixinSource);
addMixIn 方法的作用是用 mixinSource 接口或类的注解会重写 target 或 target 的子类型的注解。 用ixIn 设置
Person peixIn 的 @JsonIgnoreProperties("name")所重写，最终忽略的属性为 name，最终生成的 json 如下：
{"birthDate":"2017/09/13","age":40}
- SimpleBeanPropertyFilter 方式。这种方式比前两种方式更加灵活，也更复杂一些。
首先需要设置@JsonFilter 类或接口，其次设置 addMixIn，将@JsonFilter 作用于 java 对象上，最后调用 SimpleBeanPropertyFilter 的 serializeAllExcept 方法或重写 S impleBeanPropertyFilter 的 serializeAsField 方法来过滤相关属性。示例如下：
清单 11 . 属性过滤示例三
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 |
|
自定义序列化和反序列化
当 Jackson 默认序列化和反序列化的类不能满足实际需要，可以自定义新的序列化和反序列化的类。
- 自定义序列化类。自定义的序列化类需要直接或间接继承 StdSerializer 或 JsonSerializer，同时需要利用 JsonGenerator 生成 json，重写方法 serialize，示例如下：
清单 12 . 自定义序列化
| 1 2 3 4 5 6 7 8 9 10 |
|
JsonGenerator 有多种 write 方法以支持生成复杂的类型的 json，比如 writeArray，writeTree 等 。若想单独创建 JsonGenerator，可以通过 JsonFactory() 的 createGenerator。
- 自定义反序列化类。自定义的反序列化类需要直接或间接继承 StdDeserializer 或 StdDeserializer，同时需要利用 JsonParser 读取 json，重写方法 deserialize，示例如下：
清单 13 . 自定义序列化
| 1 2 3 4 5 6 7 8 9 10 11 12 13 |
|
JsonParser 提供很多方法来读取 json 信息， 如 isClosed(), nextToken(), getValueAsString()等。若想单独创建 JsonParser，可以通过 JsonFactory() 的 createParser。
- 定义好自定义序列化类和自定义反序列化类，若想在程序中调用它们，还需要注册到 ObjectMapper 的 Module，示例如下：
清单 14 . 注 册 M odule 示例
| 1 2 3 4 5 6 7 8 |
|
树模型处理
Jackson 也提供了树模型(tree model)来生成和解析 json。若想修改或访问 json 部分属性，树模型是不错的选择。树模型由 JsonNode 节点组成。程序中常常使用 ObjectNode，ObjectNode 继承于 JsonNode，示例如下：
清单 15 . ObjectNode 生成和解析 json 示例
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 |
|
转载：https://www.ibm.com/developerworks/cn/java/jackson-advanced-application/index.html