詳解Jackson的基本用法
一、前言
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 包較少 ,簡(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)正是通過高性能的流模式 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。
清單 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 通過 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 和 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、樹模型
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
使用該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(); }
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讀取和編寫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文件的讀取和寫入
定義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)建要寫入的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(); //寫入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()); } /** * 寫入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í)間寫為時(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
寫入文件的輸出
以上就是詳解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ù)的使用及其樹模型的入門學(xué)習(xí)教程
- 使用Jackson來實(shí)現(xiàn)Java對(duì)象與JSON的相互轉(zhuǎn)換的教程
相關(guān)文章
IDEA部署JavaWeb項(xiàng)目到Tomcat服務(wù)器的方法
這篇文章主要介紹了IDEA部署JavaWeb項(xiàng)目到Tomcat服務(wù)器的方法,本文給大家介紹的非常詳細(xì),感興趣的朋友跟隨腳本之家小編一起學(xué)習(xí)吧2018-06-06通過Java實(shí)現(xiàn)添加或刪除PDF中的附件
當(dāng)我們?cè)谥谱鱌DF文件或者PPT演示文稿的時(shí)候,為了讓自己的文件更全面詳細(xì),就會(huì)在文件中添加附件。本文為大家整理了Java實(shí)現(xiàn)添加或刪除PDF中的附件的方法,需要的可以參考下2023-01-01Java Websocket Canvas實(shí)現(xiàn)井字棋網(wǎng)絡(luò)游戲
這篇文章主要介紹了Java Websocket Canvas實(shí)現(xiàn)井字棋網(wǎng)絡(luò)游戲,文中示例代碼介紹的非常詳細(xì),具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2021-08-08Spring session實(shí)現(xiàn)共享單點(diǎn)登錄案例過程解析
這篇文章主要介紹了Spring session實(shí)現(xiàn)共享單點(diǎn)登錄案例過程解析,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-07-07java計(jì)算兩點(diǎn)間的距離方法總結(jié)
小編給大家總結(jié)了在java中計(jì)算兩點(diǎn)之家距離的方法以及相關(guān)實(shí)例代碼分享,有需要的讀者參考下。2018-02-02java實(shí)現(xiàn)銀行ATM管理系統(tǒng)
這篇文章主要為大家詳細(xì)介紹了java實(shí)現(xiàn)銀行ATM管理系統(tǒng),文中示例代碼介紹的非常詳細(xì),具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2022-05-05springboot項(xiàng)目攔截前端請(qǐng)求中的特殊字符串(解決方案)
springboot項(xiàng)目中,需要對(duì)前端請(qǐng)求數(shù)據(jù)進(jìn)行過濾,攔截特殊字符,本文通過實(shí)例代碼給大家分享完美解決方案,感興趣的朋友一起看看吧2023-10-10springboot整合xxl-job實(shí)現(xiàn)分布式定時(shí)任務(wù)的過程
XXL-JOB是一個(gè)分布式任務(wù)調(diào)度平臺(tái),其核心設(shè)計(jì)目標(biāo)是開發(fā)迅速、學(xué)習(xí)簡(jiǎn)單、輕量級(jí)、易擴(kuò)展,這篇文章主要介紹了springboot整合xxl-job分布式定時(shí)任務(wù),需要的朋友可以參考下2022-08-08解決mybatis使用char類型字段查詢oracle數(shù)據(jù)庫(kù)時(shí)結(jié)果返回null問題
這篇文章主要介紹了mybatis使用char類型字段查詢oracle數(shù)據(jù)庫(kù)時(shí)結(jié)果返回null問題的解決方法,本文給大家介紹的非常詳細(xì),具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2018-06-06