Jackson 是當(dāng)前用的比較廣泛的，用來序列化和反序列化 JSON 的 Java 的開源框架。Jackson 社 區(qū)相對(duì)比較活躍，更新速度也比較快， 從 Github 中的統(tǒng)計(jì)來看，Jackson 是最流行的 JSON 解析器之一 。 Spring MVC 的默認(rèn) JSON 解析器便是 Jackson。 Jackson 優(yōu)點(diǎn)很多。 Jackson 所依賴的 jar 包較少 ，簡單易用。與其他 Java 的 JSON 的框架 Gson 等相比， Jackson 解析大的 JSON 文件速度比較快；Jackson 運(yùn)行時(shí)占用內(nèi)存比較低，性能比較好；Jackson 有靈活的 API，可以很容易進(jìn)行擴(kuò)展和定制。

Jackson 的 1.x 版本的包名是 org.codehaus.jackson ，當(dāng)升級(jí)到 2.x 版本時(shí)，包名變?yōu)?com.fasterxml.jackson，本文討論的內(nèi)容是基于最新的 Jackson 的 2.9.1 版本。

Jackson 的核心模塊由三部分組成。

jackson-core，核心包，提供基于"流模式"解析的相關(guān) API，它包括 JsonPaser 和 JsonGenerator。 Jackson 內(nèi)部實(shí)現(xiàn)正是通過高性能的流模式 API 的 JsonGenerator 和 JsonParser 來生成和解析 JSON。
jackson-annotations，注解包，提供標(biāo)準(zhǔn)注解功能；
jackson-databind ，數(shù)據(jù)綁定包， 提供基于"對(duì)象綁定" 解析的相關(guān) API （ ObjectMapper ） 和"樹模型" 解析的相關(guān) API （JsonNode）；基于"對(duì)象綁定" 解析的 API 和"樹模型"解析的 API 依賴基于"流模式"解析的 API。

在了解 Jackson 的概要情況之后，下面介紹 Jackson 的基本用法。

Jackson 的 基本用法

若想在 Java 代碼中使用 Jackson 的核心模塊的 jar 包 ，需要在 pom.xml 中添加如下信息。

清單 1.在 pom.xml 的 Jackson 的配置信息

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

jackson-databind 依賴 jackson-core 和 jackson-annotations，當(dāng)添加 jackson-databind 之后， jackson-core 和 jackson-annotations 也隨之添加到 Java 項(xiàng)目工程中。在添加相關(guān)依賴包之后，就可以使用 Jackson。

ObjectMapper 的使用

Jackson 最常用的 API 就是基于"對(duì)象綁定" 的 ObjectMapper。下面是一個(gè) ObjectMapper 的使用的簡單示例。

清單 2 . ObjectMapper 使用示例

ObjectMapper mapper = new ObjectMapper();
Person person = new Person();
person.setName("Tom");
person.setAge(40);
String JSONString = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(person);
Person deserializedPerson = mapper.readValue(JSONString, Person.class);

ObjectMapper 通過 writeValue 系列方法 將 Java 對(duì) 象序列化 為 JSON，并 將 JSON 存 儲(chǔ)成不同的格式，String（writeValueAsString），Byte Array（writeValueAsString），Writer， File，OutStream 和 DataOutput。

ObjectMapper 通過 readValue 系列方法從不同的數(shù)據(jù)源像 String ， Byte Array， Reader，F(xiàn)ile，URL， InputStream 將 JSON 反序列化為 Java 對(duì)象。

信息配置

在調(diào)用 writeValue 或調(diào)用 readValue 方法之前，往往需要設(shè)置 ObjectMapper 的相關(guān)配置信息。這些配置信息應(yīng)用 Java 對(duì)象的所有屬性上。示例如下：

清單 3 . 配置信息使用示例

//在反序列化時(shí)忽略在 JSON 中存在但 Java 對(duì)象不存在的屬性
mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES,false);
//在序列化時(shí)日期格式默認(rèn)為 yyyy-MM-dd'T'HH:mm:ss.SSSZ
mapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS,false)
//在序列化時(shí)忽略值為 null 的屬性
mapper.setSerializationInclusion(Include.NON_NULL);
//忽略值為默認(rèn)值的屬性
mapper.setDefaultPropertyInclusion(Include.NON_DEFAULT);

更多配置信息可以查看 Jackson 的 DeserializationFeature，SerializationFeature 和 Include。

Jackson 的注解的使用

Jackson 根據(jù)它的默認(rèn)方式序列化和反序列化 Java 對(duì)象，若根據(jù)實(shí)際需要，靈活的調(diào)整它的默認(rèn)方式，可以使用 Jackson 的注解。常用的注解及用法如下。

表 1. Jackson 的 常用注解

注解	用法
@JsonProperty	用于屬性，把屬性的名稱序列化時(shí)轉(zhuǎn)換為另外一個(gè)名稱。示例： @JsonProperty("birth_ d ate") private Date birthDate;
@JsonFormat	用于屬性或者方法，把屬性的格式序列化時(shí)轉(zhuǎn)換成指定的格式。示例： @JsonFormat(timezone = "GMT+8", pattern = "yyyy-MM-dd HH:mm") public Date getBirthDate()
@JsonPropertyOrder	用于類， 指定屬性在序列化時(shí) JSON 中的順序 ， 示例： @JsonPropertyOrder({ "birth_Date", "name" }) public class Person
@JsonCreator	用于構(gòu)造方法，和 @JsonProperty 配合使用，適用有參數(shù)的構(gòu)造方法。 示例： @JsonCreator public Person(@JsonProperty("name")String name) {…}
@JsonAnySetter	用于屬性或者方法，設(shè)置未反序列化的屬性名和值作為鍵值存儲(chǔ)到 map 中 @JsonAnySetter public void set(String key, Object value) { map.put(key, value); }
@JsonAnyGetter	用于方法 ，獲取所有未序列化的屬性 public Map<String, Object> any() { return map; }

在了解 Jackson 的基本用法后，下面詳細(xì)地介紹它的一些高階應(yīng)用。

Jackson 的高階應(yīng)用

格式處理（含日期格式）

不同類型的日期類型，Jackson 的處理方式也不同。

對(duì)于日期類型為 Java.util.Calendar,Java.util.GregorianCalendar,Java.sql.Date,Java.util.Date,Java.sql.Timestamp，若不指定格式， 在 JSON 文件中將序列化 為 long 類型的數(shù)據(jù)。顯然這種默認(rèn)格式，可讀性差，轉(zhuǎn)換格式是必要的。Jackson 有 很多方式轉(zhuǎn)換日期格式。
注解方式，請參照" Jackson 的注解的使用"的@ JsonFormat 的示例。
ObjectMapper 方式，調(diào)用 ObjectMapper 的方法 setDateFormat，將序列化為指定格式的 string 類型的數(shù)據(jù)。
對(duì)于日期類型為 Java.time.LocalDate，還需要添加代碼 mapper.registerModule(new JavaTimeModule())，同時(shí)添加相應(yīng)的依賴 jar 包

清單 4 . JSR310 的配置信息

<dependency>
<groupId>com.fasterxml.jackson.datatype</groupId>
<artifactId>jackson-datatype-jsr310</artifactId>
<version>2.9.1</version>
</dependency>

對(duì)于 Jackson 2.5 以下版本，需要添加代碼 objectMapper.registerModule(new JSR310Module ())

對(duì)于日期類型為 org.joda.time.DateTime，還需要添加代碼 mapper.registerModule(new JodaModule())，同時(shí)添加相應(yīng)的依賴 jar 包

清單 5. joda 的 配置信息

<dependency>
<groupId>com.fasterxml.jackson.datatype</groupId>
<artifactId>jackson-datatype-joda</artifactId>
<version>2.9.1</version>
</dependency>

泛型反序列化

Jackson 對(duì)泛型反序列化也提供很好的支持。

對(duì)于 List 類型 ，可以調(diào)用 constructCollectionType 方法來序列化，也可以構(gòu)造 TypeReference 來序列化。

清單 6 . List 泛 型使用示例

CollectionType JavaType = mapper.getTypeFactory().constructCollectionType(List.class, Person.class);
List<Person> personList = mapper.readValue(JSONInString, JavaType); 
List<Person> personList = mapper.readValue(JSONInString, new TypeReference<List<Person>>(){});

對(duì)于 map 類型， 與 List 的實(shí)現(xiàn)方式相似。

清單 7 . Map 泛型使用示例

//第二參數(shù)是 map 的 key 的類型，第三參數(shù)是 map 的 value 的類型
 MapType JavaType = mapper.getTypeFactory().constructMapType(HashMap.class,String.class,Person.class);
 Map<String, Person> personMap = mapper.readValue(JSONInString,JavaType);
 Map<String, Person> personMap = mapper.readValue(JSONInString, new TypeReference<Map<String, Person>>() {});

Array 和 Collection 的處理與 List，Map 相似，這里不再詳述。

屬性可視化

是 Java 對(duì)象的所有的屬性都被序列化和反序列化，換言之，不是所有屬性都可視化，默認(rèn)的屬性可視化的規(guī)則如下：

若該屬性修飾符是 public，該屬性可序列化和反序列化。
若屬性的修飾符不是 public，但是它的 getter 方法和 setter 方法是 public，該屬性可序列化和反序列化。因?yàn)?getter 方法用于序列化， 而 setter 方法用于反序列化。
若屬性只有 public 的 setter 方法，而無 public 的 getter 方 法，該屬性只能用于反序列化。

若想更改默認(rèn)的屬性可視化的規(guī)則，需要調(diào)用 ObjectMapper 的方法 setVisibility。

下面的示例使修飾符為 protected 的屬性 name 也可以序列化和反序列化。

清單 8 . 屬性可視化示例

mapper.setVisibility(PropertyAccessor.FIELD, Visibility.ANY);
public class Person {
　　public int age;
　　protected String name;
}
PropertyAccessor 支持的類型有 ALL,CREATOR,FIELD,GETTER,IS_GETTER,NONE,SETTER 
Visibility 支持的類型有 ANY,DEFAULT,NON_PRIVATE,NONE,PROTECTED_AND_PUBLIC,PUBLIC_ONLY

屬性過濾

在將 Java 對(duì)象序列化為 JSON 時(shí) ，有些屬性需要過濾掉，不顯示在 JSON 中 ， Jackson 有多種實(shí)現(xiàn)方法。

注解方式， 可以用 @JsonIgnore 過濾單個(gè)屬性或用 @JsonIgnoreProperties 過濾多個(gè)屬性，示例如下：

清單 9 . 屬性過濾示例一

@JsonIgnore
public int getAge()
@JsonIgnoreProperties(value = { "age","birth_date" }) 
public class Person

addMixIn 方法加注解方式@JsonIgnoreProperties。

addMixIn 方法簽名如下：

public ObjectMapper addMixIn(Class<?> target, Class<?> mixinSource);

addMixIn 方法的作用是用 mixinSource 接口或類的注解會(huì)重寫 target 或 target 的子類型的注解。 用ixIn 設(shè)置

Person peixIn 的 @JsonIgnoreProperties("name")所重寫，最終忽略的屬性為 name，最終生成的 JSON 如下：

{"birthDate":"2017/09/13","age":40}

SimpleBeanPropertyFilter 方式。這種方式比前兩種方式更加靈活，也更復(fù)雜一些。

首先需要設(shè)置@JsonFilter 類或接口，其次設(shè)置 addMixIn，將@JsonFilter 作用于 Java 對(duì)象上，最后調(diào)用 SimpleBeanPropertyFilter 的 serializeAllExcept 方法或重寫 S impleBeanPropertyFilter 的 serializeAsField 方法來過濾相關(guān)屬性。示例如下：

清單 11 . 屬性過濾示例三

//設(shè)置 Filter 類或接口
@JsonFilter("myFilter")
public interface MyFilter {}
//設(shè)置 addMixIn
mapper.addMixIn(Person.class, MyFilter.class);
//調(diào)用 SimpleBeanPropertyFilter 的 serializeAllExcept 方法
SimpleBeanPropertyFilter newFilter =
SimpleBeanPropertyFilter.serializeAllExcept("age");
//或重寫 SimpleBeanPropertyFilter 的 serializeAsField 方法
SimpleBeanPropertyFilter newFilter = new SimpleBeanPropertyFilter() { 
　　@Override
　　public void serializeAsField(Object pojo, JsonGenerator jgen, SerializerProvider provider, PropertyWriter writer) throws Exception {
　　　　if (!writer.getName().equals("age")) {
 　　　　　　writer.serializeAsField(pojo, jgen, provider);
 　　　　}
　　}
};
//設(shè)置 FilterProvider
FilterProvider filterProvider = new SimpleFilterProvider().addFilter("myFilter", newFilter);
mapper.setFilterProvider(filterProvider).writeValueAsString(person);

自定義序列化和反序列化

當(dāng) Jackson 默認(rèn)序列化和反序列化的類不能滿足實(shí)際需要，可以自定義新的序列化和反序列化的類。

自定義序列化類。自定義的序列化類需要直接或間接繼承 StdSerializer 或 JsonSerializer，同時(shí)需要利用 JsonGenerator 生成 JSON，重寫方法 serialize，示例如下：

清單 12 . 自定義序列化

public class CustomSerializer extends StdSerializer<Person> { 
　　@Override
　　public void serialize(Person person, JsonGenerator jgen, SerializerProvider provider) throws IOException {
　　　　jgen.writeStartObject();
　　　　jgen.writeNumberField("age", person.getAge());
　　　　jgen.writeStringField("name", person.getName());
　　　　jgen.writeEndObject();
　　}
}

JsonGenerator 有多種 write 方法以支持生成復(fù)雜的類型的 JSON，比如 writeArray，writeTree 等 。若想單獨(dú)創(chuàng)建 JsonGenerator，可以通過 JsonFactory() 的 createGenerator。

自定義反序列化類。自定義的反序列化類需要直接或間接繼承 StdDeserializer 或 StdDeserializer，同時(shí)需要利用 JsonParser 讀取 JSON，重寫方法 deserialize，示例如下：

清單 13 . 自定義序列化

public class CustomDeserializer extends StdDeserializer<Person> {
　　@Override
　　public Person deserialize(JsonParser jp, DeserializationContext ctxt)  throws IOException, JsonProcessingException {
　　　　JsonNode node = jp.getCodec().readTree(jp);
　　　　Person person = new Person();
　　　　int age = (Integer) ((IntNode) node.get("age")).numberValue();
　　　　String name = node.get("name").asText();
　　　　person.setAge(age);
　　　　person.setName(name);
　　　　return person;
　　}
}

JsonParser 提供很多方法來讀取 JSON 信息， 如 isClosed(), nextToken(), getValueAsString()等。若想單獨(dú)創(chuàng)建 JsonParser，可以通過 JsonFactory() 的 createParser。

定義好自定義序列化類和自定義反序列化類，若想在程序中調(diào)用它們，還需要注冊到 ObjectMapper 的 Module，示例如下：

清單 14 . 注 冊 Module 示例

SimpleModule module = new SimpleModule("myModule");
module.addSerializer(new CustomSerializer(Person.class));
module.addDeserializer(Person.class, new CustomDeserializer()); 
mapper.registerModule(module);
也可通過注解方式加在 Java 對(duì)象的屬性，方法或類上面來調(diào)用它們，
@JsonSerialize(using = CustomSerializer.class)
@JsonDeserialize(using = CustomDeserializer.class)
public class Person

樹模型處理

Jackson 也提供了樹模型(tree model)來生成和解析 JSON。若想修改或訪問 JSON 部分屬性，樹模型是不錯(cuò)的選擇。樹模型由 JsonNode 節(jié)點(diǎn)組成。程序中常常使用 ObjectNode，ObjectNode 繼承于 JsonNode，示例如下：

清單 15 . ObjectNode 生成和解析 JSON 示例

ObjectMapper mapper = new ObjectMapper();
//構(gòu)建 ObjectNode
ObjectNode personNode = mapper.createObjectNode();
//添加/更改屬性
personNode.put("name","Tom");
personNode.put("age",40);
ObjectNode addressNode = mapper.createObjectNode();
addressNode.put("zip","000000");
addressNode.put("street","Road NanJing");
//設(shè)置子節(jié)點(diǎn)
personNode.set("address",addressNode);
//通過 path 查找節(jié)點(diǎn)
JsonNode searchNode = personNode.path("street ")；
//刪除屬性
((ObjectNode) personNode).remove("address");
//讀取 JSON
JsonNode rootNode = mapper.readTree(personNode.toString());
//JsonNode 轉(zhuǎn)換成 Java 對(duì)象
Person person = mapper.treeToValue(personNode, Person.class); 
//Java 對(duì)象轉(zhuǎn)換成 JsonNode
JsonNode node = mapper.valueToTree(person);

總結(jié)

本文首先通過與其他 Java 的 JSON 的框架比較，介紹了 Jackson 的優(yōu)點(diǎn)，并且描述了 Jackson 的 核心模塊的組成，以及每個(gè)部分的作用。然后， 本文通過示例，講解 Jackson 的基本用法，介紹了 ObjectMapper 的 write 和 read 方法，ObjectMapper 的配置信息設(shè)定，以及 jackson-annotations 包下注釋的運(yùn)用。最后，本文詳細(xì)的介紹了 Jackson 的高階用法，這也是本文的重點(diǎn)。這些高階用法包括不同類型的日期格式處理（普通日期的類型，JDK 8 的日期類型，joda 的日期類型），List 和 Map 等泛型的反序列化，屬性的可視化管理，Jackson 的 三種屬性過濾方式，自定義序列化和反序列化的實(shí)現(xiàn)以及樹模型的使用。通過本文的系統(tǒng)地講解，相信讀者對(duì) Jackson 會(huì)有更深刻而全面的掌握。

參考：

Jenkov.com 的Jackson - ObjectMapper部分，介紹 Jackson 的 ObjectMapper 的各種 write 和 read 方法 。

https://www.ibm.com/developerworks/cn/java/jackson-advanced-application/index.html（以上內(nèi)容轉(zhuǎn)自此篇文章）

總結(jié)

以上是生活随笔為你收集整理的Jackson的高级应用（转）的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。