詳解Jackson的基本用法
更新時(shí)間：2021年06月25日 11:47:06 作者：縱碼萬(wàn)水千山
Java生態(tài)圈中有很多處理JSON和XML格式化的類庫(kù)，Jackson是其中比較著名的一個(gè)。雖然JDK自帶了XML處理類庫(kù)，但是相對(duì)來(lái)說(shuō)比較低級(jí)，使用本文介紹的Jackson等高級(jí)類庫(kù)處理起來(lái)會(huì)方便很多
一、前言
Jackson 是當(dāng)前用的比較廣泛的，用來(lái)序列化和反序列化 json 的 Java 的開(kāi)源框架。Jackson 社 區(qū)相對(duì)比較活躍，更新速度也比較快， 從 Github 中的統(tǒng)計(jì)來(lái)看，Jackson 是最流行的 json 解析器之一 。 Spring MVC 的默認(rèn) json 解析器便是 Jackson。Jackson 優(yōu)點(diǎn)很多。Jackson 所依賴的 jar 包較少 ，簡(jiǎn)單易用。與其他 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)正是通過(guò)高性能的流模式 API 的 JsonGenerator 和 JsonParser 來(lái)生成和解析 json。
- jackson-annotations，注解包，提供標(biāo)準(zhǔn)注解功能；
- jackson-databind ，數(shù)據(jù)綁定包， 提供基于"對(duì)象綁定" 解析的相關(guān) API （ ObjectMapper ） 和"樹(shù)模型" 解析的相關(guān) API （JsonNode）；基于"對(duì)象綁定" 解析的 API 和"樹(shù)模型"解析的 API 依賴基于"流模式"解析的 API。
清單 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 的使用的簡(jiǎn)單示例。
清單 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 通過(guò) writeValue 系列方法 將 java 對(duì) 象序列化 為 json，并 將 json 存 儲(chǔ)成不同的格式，String（writeValueAsString），Byte Array（writeValueAsString），Writer， File，OutStream 和 DataOutput。
ObjectMapper 通過(guò) 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 和 I nclude。
五、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示例
6.1、Jackson ObjectMapper Example
ObjectMapper objectMapper = new ObjectMapper();
String carJson =
"{ \"brand\" : \"Mercedes\", \"doors\" : 5 }";
try {
Car car = objectMapper.readValue(carJson, Car.class);
System.out.println("car brand = " + car.getBrand());
System.out.println("car doors = " + car.getDoors());
} catch (IOException e) {
e.printStackTrace();
}
public class Car {
private String brand = null;
private int doors = 0;
public String getBrand() { return this.brand; }
public void setBrand(String brand){ this.brand = brand;}
public int getDoors() { return this.doors; }
public void setDoors (int doors) { this.doors = doors; }
}
6.2、從Reader讀取對(duì)象
ObjectMapper objectMapper = new ObjectMapper();
String carJson =
"{ \"brand\" : \"Mercedes\", \"doors\" : 4 }";
Reader reader = new StringReader(carJson);
Car car = objectMapper.readValue(reader, Car.class);
6.3、從File中讀取對(duì)象
ObjectMapper objectMapper = new ObjectMapper();
File file = new File("data/car.json");
Car car = objectMapper.readValue(file, Car.class);
6.4、從URL中讀取對(duì)象
ObjectMapper objectMapper = new ObjectMapper();
URL url = new URL("file:data/car.json");
Car car = objectMapper.readValue(url, Car.class);
6.5、從InputStream讀取對(duì)象
ObjectMapper objectMapper = new ObjectMapper();
InputStream input = new FileInputStream("data/car.json");
Car car = objectMapper.readValue(input, Car.class);
6.6、從字節(jié)數(shù)組中讀取對(duì)象
ObjectMapper objectMapper = new ObjectMapper();
String carJson =
"{ \"brand\" : \"Mercedes\", \"doors\" : 5 }";
byte[] bytes = carJson.getBytes("UTF-8");
Car car = objectMapper.readValue(bytes, Car.class);
6.7、從JSON數(shù)組字符中讀取對(duì)象數(shù)組
String jsonArray = "[{\"brand\":\"ford\"}, {\"brand\":\"Fiat\"}]";
ObjectMapper objectMapper = new ObjectMapper();
Car[] cars2 = objectMapper.readValue(jsonArray, Car[].class);
6.8、從JSON數(shù)組字符中讀取對(duì)象列表
String jsonArray =“[{\”brand \“：\”ford \“}，{\”brand \“：\”Fiat \“}]”;
ObjectMapper objectMapper = new ObjectMapper（）;
List <Car> cars1 = objectMapper.readValue（jsonArray，new TypeReference <List <Car >>（）{}）;
6.9、從JSON字符串中讀取映射為map
String jsonObject =“{\”brand \“：\”ford \“，\”doors \“：5}”;
ObjectMapper objectMapper = new ObjectMapper（）;
Map <String，Object> jsonMap = objectMapper.readValue（jsonObject，
new TypeReference <Map <String，Object >>（）{}）;
6.10、樹(shù)模型
String carJson =
"{ \"brand\" : \"Mercedes\", \"doors\" : 5 }";
ObjectMapper objectMapper = new ObjectMapper();
try {
JsonNode jsonNode = objectMapper.readValue(carJson, JsonNode.class);
} catch (IOException e) {
e.printStackTrace();
}
JSON字符串被解析為JsonNode對(duì)象而不是Car對(duì)象，只需將JsonNode.class第二個(gè)參數(shù)傳遞給readValue()方法而不是Car.class本教程前面的示例中使用的方法。
該ObjectMapper班也有一個(gè)特殊的readTree()，它總是返回一個(gè)方法JsonNode。以下是JsonNode使用該ObjectMapperreadTree()方法將JSON解析為a的示例：
String carJson =
"{ \"brand\" : \"Mercedes\", \"doors\" : 5 }";
ObjectMapper objectMapper = new ObjectMapper();
try {
JsonNode jsonNode = objectMapper.readTree(carJson);
} catch (IOException e) {
e.printStackTrace();
}
JsonNode類
String carJson =
"{ \"brand\" : \"Mercedes\", \"doors\" : 5," +
" \"owners\" : [\"John\", \"Jack\", \"Jill\"]," +
" \"nestedObject\" : { \"field\" : \"value\" } }";
ObjectMapper objectMapper = new ObjectMapper();
try {
JsonNode jsonNode = objectMapper.readValue(carJson, JsonNode.class);
JsonNode brandNode = jsonNode.get("brand");
String brand = brandNode.asText();
System.out.println("brand = " + brand);
JsonNode doorsNode = jsonNode.get("doors");
int doors = doorsNode.asInt();
System.out.println("doors = " + doors);
JsonNode array = jsonNode.get("owners");
JsonNode jsonNode = array.get(0);
String john = jsonNode.asText();
System.out.println("john = " + john);
JsonNode child = jsonNode.get("nestedObject");
JsonNode childField = child.get("field");
String field = childField.asText();
System.out.println("field = " + field);
} catch (IOException e) {
e.printStackTrace();
}
6.11、將Object轉(zhuǎn)換為JsonNode
ObjectMapper objectMapper = new ObjectMapper(); Car car = new Car(); car.brand = "Cadillac"; car.doors = 4; JsonNode carJsonNode = objectMapper.valueToTree(car);
6.12、將JsonNode轉(zhuǎn)換為Object
ObjectMapper objectMapper = new ObjectMapper();
String carJson = "{ \"brand\" : \"Mercedes\", \"doors\" : 5 }";
JsonNode carJsonNode = objectMapper.readTree(carJson);
Car car = objectMapper.treeToValue(carJsonNode);
6.13、使用Jackson ObjectMapper讀取和編寫(xiě)YAML
6.13.1、示例1
只是yaml字符串和對(duì)象的互轉(zhuǎn)，不涉及yaml文件的處理
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.dataformat.yaml.YAMLFactory;
import java.io.IOException;
public class YamlJacksonExample {
public static void main(String[] args) {
ObjectMapper objectMapper = new ObjectMapper(new YAMLFactory());
Employee employee = new Employee("John Doe", "john@doe.com");
String yamlString = null;
try {
yamlString = objectMapper.writeValueAsString(employee);
} catch (JsonProcessingException e) {
e.printStackTrace();
// normally, rethrow exception here - or don't catch it at all.
}
}
}
該yamlString變量包含Employee在執(zhí)行此代碼后序列化為YAML數(shù)據(jù)格式的對(duì)象。
以下是Employee再次將YAML文本讀入對(duì)象的示例：
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.dataformat.yaml.YAMLFactory;
import java.io.IOException;
public class YamlJacksonExample {
public static void main(String[] args) {
ObjectMapper objectMapper = new ObjectMapper(new YAMLFactory());
Employee employee = new Employee("John Doe", "john@doe.com");
String yamlString = null;
try {
yamlString = objectMapper.writeValueAsString(employee);
} catch (JsonProcessingException e) {
e.printStackTrace();
// normally, rethrow exception here - or don't catch it at all.
}
try {
Employee employee2 = objectMapper.readValue(yamlString, Employee.class);
System.out.println("Done");
} catch (IOException e) {
e.printStackTrace();
}
}
}
6.13.2、示例2
yaml文件的讀取和寫(xiě)入
定義Employee實(shí)體類
package com.example.jackjson;
import lombok.Data;
@Data
public class Employee {
public Employee() {
}
public Employee(String name, String email) {
this.name = name;
this.email = email;
}
String name;
String email;
}
創(chuàng)建要讀取的yml EmployeeYaml.yml文件，并初始化一條數(shù)據(jù)
name: test
email: test@qq.com
創(chuàng)建要寫(xiě)入的yml文件,EmployeeYamlOutput.yml （空文件）
測(cè)試類
package com.example.jackjson;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;
import com.fasterxml.jackson.dataformat.yaml.YAMLFactory;
import com.fasterxml.jackson.dataformat.yaml.YAMLGenerator;
import java.io.File;
import java.io.IOException;
public class YamlJacksonExample {
public static void main(String[] args) {
try {
//從yaml文件讀取數(shù)據(jù)
reaedYamlToEmployee();
//寫(xiě)入yaml文件
reaedEmployeeToYaml();
} catch (Exception e) {
e.printStackTrace();
}
}
/**
* 從yaml文件讀取數(shù)據(jù)
* @throws IOException
*/
private static void reaedYamlToEmployee() throws IOException {
ObjectMapper mapper = new ObjectMapper(new YAMLFactory());
Employee employee = mapper.readValue(new File("src/test/java/com/example/jackjson/EmployeeYaml.yml"), Employee.class);
System.out.println(employee.getName() + "********" + employee.getEmail());
}
/**
* 寫(xiě)入yaml文件
* @throws IOException
*/
private static void reaedEmployeeToYaml() throws IOException {
//去掉三個(gè)破折號(hào)
ObjectMapper mapper = new ObjectMapper(new YAMLFactory().disable(YAMLGenerator.Feature.WRITE_DOC_START_MARKER));
//禁用掉把時(shí)間寫(xiě)為時(shí)間戳
mapper.disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS);
Employee employee = new Employee("test2", "999@qq.com");
mapper.writeValue(new File("src/test/java/com/example/jackjson/EmployeeYamlOutput.yml"), employee);
}
}
讀取文件的打印輸出
test********test@qq.com
Process finished with exit code 0
寫(xiě)入文件的輸出
以上就是詳解Jackson的基本用法的詳細(xì)內(nèi)容，更多關(guān)于Java Jackson的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！
您可能感興趣的文章:
- java如何利用FastJSON、Gson、Jackson三種Json格式工具自定義時(shí)間序列化
- Java下利用Jackson進(jìn)行JSON解析和序列化示例
- java的Jackson將json字符串轉(zhuǎn)換成泛型List
- java的Jackson框架實(shí)現(xiàn)輕易轉(zhuǎn)換JSON
- Java的Jackson庫(kù)中復(fù)雜對(duì)象集合的幾種簡(jiǎn)單轉(zhuǎn)換
- 舉例講解Java的Jackson庫(kù)中ObjectMapper類的使用
- 解析Java的Jackson庫(kù)中對(duì)象的序列化與數(shù)據(jù)泛型綁定
- 實(shí)例解析Java的Jackson庫(kù)中的數(shù)據(jù)綁定
- Java的Jackson庫(kù)的使用及其樹(shù)模型的入門學(xué)習(xí)教程
- 使用Jackson來(lái)實(shí)現(xiàn)Java對(duì)象與JSON的相互轉(zhuǎn)換的教程
相關(guān)文章
import java和javax區(qū)別小結(jié)
Java包和javax包在Java編程語(yǔ)言中都起著至關(guān)重要的作用,本文就來(lái)介紹一下import java和javax區(qū)別小結(jié),具有一定的參考價(jià)值,感興趣的可以了解一下2024-10-10
java操作excel導(dǎo)入導(dǎo)出的3種方式
項(xiàng)目需要,要實(shí)現(xiàn)一個(gè)導(dǎo)入導(dǎo)出excel的功能,于是任務(wù)驅(qū)動(dòng)著我學(xué)習(xí)到了POI、easypoi和easyexcel這3個(gè)java操作Excel的工具,下面這篇文章主要給大家介紹了關(guān)于java操作excel導(dǎo)入導(dǎo)出的3種方式,需要的朋友可以參考下2023-05-05
Springboot 在普通類型注入Service或mapper
這篇文章主要介紹了Springboot 在普通類型注入Service或mapper，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2021-11-11
SpringSecurity頁(yè)面授權(quán)與登錄驗(yàn)證實(shí)現(xiàn)(內(nèi)存取值與數(shù)據(jù)庫(kù)取值)
Spring Security是一個(gè)能夠?yàn)榛赟pring的企業(yè)應(yīng)用系統(tǒng)提供聲明式的安全訪問(wèn)控制解決方案的安全框架，本文主要介紹了SpringSecurity頁(yè)面授權(quán)與登錄驗(yàn)證實(shí)現(xiàn)，文中通過(guò)示例代碼介紹的非常詳細(xì)，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2022-06-06
JDK動(dòng)態(tài)代理原理:只能代理接口,不能代理類問(wèn)題
這篇文章主要介紹了JDK動(dòng)態(tài)代理原理：只能代理接口，不能代理類問(wèn)題。具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2022-11-11
獲取JPEGImageEncoder和JPEGCode這兩個(gè)類的方法
下面小編就為大家?guī)?lái)一篇獲取JPEGImageEncoder和JPEGCode這兩個(gè)類的方法。小編覺(jué)得挺不錯(cuò)的，現(xiàn)在就分享給大家，也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2017-07-07
SpringBoot使用MyBatis實(shí)現(xiàn)數(shù)據(jù)的CRUD
MyBatis是一個(gè)輕量級(jí)的對(duì)象關(guān)系映射（Object-Relational Mapping,ORM）框架,它允許開(kāi)發(fā)者通過(guò)編寫(xiě)SQL動(dòng)態(tài)查詢數(shù)據(jù)庫(kù),而無(wú)需顯式地操作JDBC,對(duì)于增刪改查操作,MyBatis提供了一種基于XML或注解的方式來(lái)進(jìn)行,本文介紹了SpringBoot使用MyBatis實(shí)現(xiàn)數(shù)據(jù)的CRUD2024-11-11
springboot中@ConfigurationProperties無(wú)效果的解決方法
本文主要介紹了springboot中@ConfigurationProperties無(wú)效果,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2024-06-06
SpringCloud之@FeignClient()注解的使用方式
這篇文章主要介紹了SpringCloud之@FeignClient()注解的使用方式，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2021-09-09
elasticsearch索引index之put?mapping的設(shè)置分析
這篇文章主要為大家介紹了elasticsearch索引index之put?mapping的設(shè)置分析，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪2022-04-04