詳解Jackson的基本用法

阿新 • • 發佈：2021-06-28

一、前言

Jackson 是當前用的比較廣泛的，用來序列化和反序列化 on 的的開源框架。Jackson 社區相對比較活躍，更新速度也比較快，從中的統計來看，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。

清單 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，File，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示例

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讀取物件

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中讀取物件

ObjectMapper objectMapper = new ObjectMapper();

File file = new File("data/car.json");

Car car = objectMapper.readValue(file,Car.class);

6.4、從URL中讀取物件

ObjectMapper objectMapper = new ObjectMapper();

URL url = new URL("file:data/car.json");

Car car = objectMapper.readValue(url,Car.class);

6.5、從InputStream讀取物件

ObjectMapper objectMapper = new ObjectMapper();

InputStream input = new FileInputStream("data/car.json");

Car car = objectMapper.readValue(input,Car.class);

6.6、從位元組陣列中讀取物件

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陣列字元中讀取物件陣列

String jsonArray = "[{\"brand\":\"ford\"},{\"brand\":\"Fiat\"}]";

ObjectMapper objectMapper = new ObjectMapper();

Car[] cars2 = objectMapper.readValue(jsonArray,Car[].class);

6.8、從JSON陣列字元中讀取物件列表

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物件而不是Car物件，只需將JsonNode.class第二個引數傳遞給readValue()方法而不是Car.class本教程前面的示例中使用的方法。

該ObjectMapper班也有一個特殊的readTree()，它總是返回一個方法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轉換為JsonNode

ObjectMapper objectMapper = new ObjectMapper();

Car car = new Car();
car.brand = "Cadillac";
car.doors = 4;

JsonNode carJsonNode = objectMapper.valueToTree(car);

6.12、將JsonNode轉換為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字串和物件的互轉，不涉及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","[email protected]");

        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在執行此程式碼後序列化為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",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實www.cppcns.com體類

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;
}

建立要讀取的yml EmployeeYaml.yml檔案，並初始化一條資料

name: test

email: [email protected]

建立要寫入的yml檔案,EmployeeYamlOutput.yml （空檔案）

測試類

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檔案讀取資料
            reaedYamlToEmployee();
            //寫入yaml檔案
            reaedEmployeeToYaml()www.cppcns.com;
        } 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/jackwww.cppcns.comjson/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","[email protected]");
        mapper.writeValue(new File("src/test/java/com/example/jackjson/EmployeeYamlOutput.yml"),employee);
    }
}

讀取檔案的列印輸出

test********[email protected]

Process finished with exit code 0

寫入檔案的輸出

詳解Jackson的基本用法

以上就是詳解Jackson的基本用法的詳細內容，更多關於Java Jackson的資料請關注gRzqTgoZ我們其它相關文章！

詳解Jackson的基本用法

一、前言

二、Jackson的核心模組

三、ObjectMapper的使用

四、資訊配置

五、Jackson註解的使用

六、Jackson示例

6.1、Jackson ObjectMapper Example

6.2、從Reader讀取物件

6.3、從File中讀取物件

6.4、從URL中讀取物件

6.5、從InputStream讀取物件

6.6、從位元組陣列中讀取物件

6.7、從JSON陣列字元中讀取物件陣列

6.8、從JSON陣列字元中讀取物件列表

6.9、從JSON字串中讀取對映為map

6.10、樹模型

6.11、將Object轉換為JsonNode

6.12、將JsonNode轉換為Object

6.13、使用Jackson ObjectMapper讀取和編寫YAML

6.13.1、示例1

6.13.2、示例2

相關推薦