Java之Jackson的基本使用案例講解
更新時間：2021年08月11日 08:41:59 作者：縱碼萬水千山
這篇文章主要介紹了Java之Jackson的基本使用案例講解,本篇文章通過簡要的案例,講解了該項技術的了解與使用,以下就是詳細內容,需要的朋友可以參考下
Jackson 是當前用的比較廣泛的，用來序列化和反序列化 json 的 Java 的開源框架。Jackson 社 區(qū)相對比較活躍，更新速度也比較快， 從 Github 中的統(tǒng)計來看，Jackson 是最流行的 json 解析器之一 。 Spring MVC 的默認 json 解析器便是 Jackson。 Jackson 優(yōu)點很多。 Jackson 所依賴的 jar 包較少 ，簡單易用。與其他 Java 的 json 的框架 Gson 等相比， Jackson 解析大的 json 文件速度比較快；Jackson 運行時占用內存比較低，性能比較好；Jackson 有靈活的 API，可以很容易進行擴展和定制。
Jackson 的 1.x 版本的包名是 org.codehaus.jackson ，當升級到 2.x 版本時，包名變?yōu)?com.fasterxml.jackson，本文討論的內容是基于最新的 Jackson 的 2.9.1 版本。
Jackson 的核心模塊由三部分組成。
- jackson-core，核心包，提供基于"流模式"解析的相關 API，它包括 JsonPaser 和 JsonGenerator。 Jackson 內部實現(xiàn)正是通過高性能的流模式 API 的 JsonGenerator 和 JsonParser 來生成和解析 json。
- jackson-annotations，注解包，提供標準注解功能；
- jackson-databind ，數據綁定包， 提供基于"對象綁定" 解析的相關 API （ ObjectMapper ） 和"樹模型" 解析的相關 API （JsonNode）；基于"對象綁定" 解析的 API 和"樹模型"解析的 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，當添加 jackson-databind 之后， jackson-core 和 jackson-annotations 也隨之添加到 Java 項目工程中。在添加相關依賴包之后，就可以使用 Jackson。
ObjectMapper 的 使用
Jackson 最常用的 API 就是基于"對象綁定" 的 ObjectMapper。下面是一個 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 對 象序列化 為 json，并 將 json 存 儲成不同的格式，String（writeValueAsString），Byte Array（writeValueAsString），Writer， File，OutStream 和 DataOutput。
ObjectMapper 通過 readValue 系列方法從不同的數據源像 String ， Byte Array， Reader，F(xiàn)ile，URL， InputStream 將 json 反序列化為 java 對象。
信息配置
在調用 writeValue 或調用 readValue 方法之前，往往需要設置 ObjectMapper 的相關配置信息。這些配置信息應用 java 對象的所有屬性上。示例如下：
清單 3 . 配置信息使用示例
//在反序列化時忽略在 json 中存在但 Java 對象不存在的屬性 mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false); //在序列化時日期格式默認為 yyyy-MM-dd'T'HH:mm:ss.SSSZ mapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS,false) //在序列化時忽略值為 null 的屬性 mapper.setSerializationInclusion(Include.NON_NULL); //忽略值為默認值的屬性 mapper.setDefaultPropertyInclusion(Include.NON_DEFAULT);
更多配置信息可以查看 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 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; }
}
從Reader讀取對象
ObjectMapper objectMapper = new ObjectMapper();
String carJson =
"{ \"brand\" : \"Mercedes\", \"doors\" : 4 }";
Reader reader = new StringReader(carJson);
Car car = objectMapper.readValue(reader, Car.class);
從File中讀取對象
ObjectMapper objectMapper = new ObjectMapper();
File file = new File("data/car.json");
Car car = objectMapper.readValue(file, Car.class);
從URL中讀取對象
ObjectMapper objectMapper = new ObjectMapper();
URL url = new URL("file:data/car.json");
Car car = objectMapper.readValue(url, Car.class);
從InputStream讀取對象
ObjectMapper objectMapper = new ObjectMapper();
InputStream input = new FileInputStream("data/car.json");
Car car = objectMapper.readValue(input, Car.class);
從字節(jié)數組中讀取對象
ObjectMapper objectMapper = new ObjectMapper();
String carJson =
"{ \"brand\" : \"Mercedes\", \"doors\" : 5 }";
byte[] bytes = carJson.getBytes("UTF-8");
Car car = objectMapper.readValue(bytes, Car.class);
從JSON數組字符串中讀取對象數組
String jsonArray = "[{\"brand\":\"ford\"}, {\"brand\":\"Fiat\"}]";
ObjectMapper objectMapper = new ObjectMapper();
Car[] cars2 = objectMapper.readValue(jsonArray, Car[].class);
從JSON數組字符串中讀取對象列表
String jsonArray =“[{\”brand \“：\”ford \“}，{\”brand \“：\”Fiat \“}]”;
ObjectMapper objectMapper = new ObjectMapper（）;
List <Car> cars1 = objectMapper.readValue（jsonArray，new TypeReference <List <Car >>（）{}）;
從JSON字符串中讀取映射為map
String jsonObject =“{\”brand \“：\”ford \“，\”doors \“：5}”;
ObjectMapper objectMapper = new ObjectMapper（）;
Map <String，Object> jsonMap = objectMapper.readValue（jsonObject，
new TypeReference <Map <String，Object >>（）{}）;
樹模型
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對象而不是Car對象，只需將JsonNode.class第二個參數傳遞給readValue()方法而不是Car.class本教程前面的示例中使用的方法。
該ObjectMapper班也有一個特殊的readTree()，它總是返回一個方法 JsonNode。以下是JsonNode使用該ObjectMapper readTree()方法將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();
}
將Object轉換為JsonNode
ObjectMapper objectMapper = new ObjectMapper(); Car car = new Car(); car.brand = "Cadillac"; car.doors = 4; JsonNode carJsonNode = objectMapper.valueToTree(car);
將JsonNode轉換為Object
ObjectMapper objectMapper = new ObjectMapper();
String carJson = "{ \"brand\" : \"Mercedes\", \"doors\" : 5 }";
JsonNode carJsonNode = objectMapper.readTree(carJson);
Car car = objectMapper.treeToValue(carJsonNode);
使用Jackson ObjectMapper讀取和編寫YAML
1.示例1(只是yaml字符串和對象的互轉，不涉及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數據格式的對象。
以下是Employee再次將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.
}
try {
Employee employee2 = objectMapper.readValue(yamlString, Employee.class);
System.out.println("Done");
} catch (IOException e) {
e.printStackTrace();
}
}
}
2. 示例2 （yaml文件的讀取和寫入）
2.1定義Employee實體類
package com.example.jackjson;
import lombok.Data;
/**
* @author: GuanBin
* @date: Created in 上午10:18 2020/6/15
*/
@Data
public class Employee {
public Employee() {
}
public Employee(String name, String email) {
this.name = name;
this.email = email;
}
String name;
String email;
}
2.2創(chuàng)建要讀取的yml EmployeeYaml.yml文件，并初始化一條數據
name: test email: test@qq.com
2.3創(chuàng)建要寫入的yml文件,EmployeeYamlOutput.yml （空文件）
2.4 測試類
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;
/**
* @author: GuanBin
* @date: Created in 上午10:17 2020/6/15
*/
public class YamlJacksonExample {
public static void main(String[] args) {
try {
//從yaml文件讀取數據
reaedYamlToEmployee();
//寫入yaml文件
reaedEmployeeToYaml();
} catch (Exception e) {
e.printStackTrace();
}
}
/**
* 從yaml文件讀取數據
* @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());
}
/**
* 寫入yaml文件
* @throws IOException
*/
private static void reaedEmployeeToYaml() throws IOException {
//去掉三個破折號
ObjectMapper mapper = new ObjectMapper(new YAMLFactory().disable(YAMLGenerator.Feature.WRITE_DOC_START_MARKER));
//禁用掉把時間寫為時間戳
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
寫入文件的輸出
參考：
https://www.ibm.com/developerworks/cn/java/jackson-advanced-application/index.html
http://tutorials.jenkov.com/java-json/jackson-objectmapper.html
https://www.baeldung.com/jackson-yaml
到此這篇關于Java之Jackson的基本使用案例講解的文章就介紹到這了,更多相關Java之Jackson的基本使用內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！
相關文章
使用Java和Redis實現(xiàn)高效的短信防轟炸方案
在當今互聯(lián)網應用中,短信驗證碼已成為身份驗證的重要手段,然而,這也帶來了"短信轟炸"的安全風險?-?惡意用戶利用程序自動化發(fā)送大量短信請求,導致用戶被騷擾和企業(yè)短信成本激增,本文將詳細介紹如何使用Java和Redis實現(xiàn)高效的短信防轟炸解決方案,需要的朋友可以參考下2025-04-04
在Java中，創(chuàng)建對象可以使用多種方式，本文將詳細介紹以下六種創(chuàng)建對象的方式，文中的示例代碼講解詳細，感興趣的小伙伴可以跟隨小編一起了解一下2023-04-04
本文介紹了在Mac和Windows平臺上安裝Python環(huán)境的方法,并詳細講解了如何在IntelliJ IDEA中安裝Python插件、創(chuàng)建Python工程和運行Python文件,同時,還提到了一些常用的Python框架,如Django、Google App Engine和SQL支持2025-03-03
這篇文章主要介紹了解決@Value注解不能注入static修飾的屬性問題，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2022-07-07
這篇文章主要介紹了Java的MybatisPlus詳解,MyBatis-Plus是一個 MyBatis的增強工具，在MyBatis的基礎上只做增強不做改變，為簡化開發(fā)、提高效率而生,需要的朋友可以參考下2023-07-07
這篇文章主要介紹了淺談xml配置spring profiles的幾個注意點，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2019-07-07
這篇文章主要介紹了解決@Around對靜態(tài)方法不生效的問題，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2021-02-02
單體系統(tǒng)中，在高并發(fā)場景下想要訪問共享資源的時候，我們需要通過加鎖的方式來保證共享資源并發(fā)的安全性，確保在同一時刻只有一個線程對共享資源進行操作2022-02-02
這篇文章主要為大家詳細介紹了Java如何將文件按照指定格式切分成多個文件,文中的示例代碼簡潔易懂,有需要的小伙伴可以參考一下2025-03-03
SpringCloud LoadBalancer自定義負載均衡器使用解析
LoadBalancerClient 是 SpringCloud 提供的一種負載均衡客戶端，Ribbon 負載均衡組件內部也是集成了 LoadBalancerClient 來實現(xiàn)負載均衡，本文給大家深入解析 LoadBalancerClient 接口源碼，感興趣的朋友跟隨小編一起看看吧2023-04-04