Jackson ObjectMapper 简介

2019-12-04 1956 words 4 minutes

Contents

1. 概述

本教程重点了解 Jackson ObjectMapper类以及如何将 Java 对象序列化为 JSON 并将 JSON 字符串反序列化为 Java 对象。

2. 依赖

让我们首先将以下依赖项添加到pom.xml：

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

此依赖项还会将以下库传递到类路径中：

jackson-annotations
jackson-core

始终为*jackson-databind *使用 Maven 中央存储库中的最新版本。

3. 使用ObjectMapper读写

让我们从基本的读写操作开始。 ObjectMapper的简单readValue API是一个很好的入口点。**我们可以使用它将 JSON 内容解析或反序列化为 Java 对象。此外，在编写方面，我们可以使用writeValue API 将任何 Java 对象序列化为 JSON 输出。 在本文中，我们将使用以下带有两个字段的Car类作为序列化或反序列化的对象：

public class Car {
    private String color;
    private String type;
    // standard getters setters
}

3.1.Java 对象到 JSON

让我们看一下使用ObjectMapper类的writeValue方法将Java 对象序列化为 JSON 的第一个示例：

ObjectMapper objectMapper = new ObjectMapper();
Car car = new Car("yellow", "renault");
objectMapper.writeValue(new File("target/car.json"), car);

文件中上述内容的输出将是：

{"color":"yellow","type":"renault"}

ObjectMapper类的writeValueAsString和writeValueAsBytes方法从 Java 对象生成 JSON，并将生成的 JSON 作为字符串或字节数组返回：

String carAsString = objectMapper.writeValueAsString(car);

3.2. JSON 到 Java 对象

下面是一个使用ObjectMapper类将 JSON 字符串转换为 Java 对象的简单示例：

String json = "{ \"color\" : \"Black\", \"type\" : \"BMW\" }";
Car car = objectMapper.readValue(json, Car.class);

*readValue()*函数还接受其他形式的输入，例如包含 JSON 字符串的文件：

Car car = objectMapper.readValue(new File("src/test/resources/json_car.json"), Car.class);

或网址：

Car car = 
  objectMapper.readValue(new URL("file:src/test/resources/json_car.json"), Car.class);

3.3. JSON 到Jackson JsonNode

或者，可以将 JSON 解析为JsonNode对象并用于从特定节点检索数据：

String json = "{ \"color\" : \"Black\", \"type\" : \"FIAT\" }";
JsonNode jsonNode = objectMapper.readTree(json);
String color = jsonNode.get("color").asText();
// Output: color -> Black

3.4. 从 JSON 数组字符串创建 Java 列表

我们可以使用TypeReference将数组形式的 JSON 解析为 Java 对象列表：

String jsonCarArray = 
  "[{ \"color\" : \"Black\", \"type\" : \"BMW\" }, { \"color\" : \"Red\", \"type\" : \"FIAT\" }]";
List<Car> listCar = objectMapper.readValue(jsonCarArray, new TypeReference<List<Car>>(){});

3.5. 从 JSON 字符串创建 Java 映射

同样，我们可以将 JSON 解析为 Java Map：

String json = "{ \"color\" : \"Black\", \"type\" : \"BMW\" }";
Map<String, Object> map 
  = objectMapper.readValue(json, new TypeReference<Map<String,Object>>(){});

4. 高级功能

Jackson 库的最大优势之一是高度可定制的序列化和反序列化过程。在本节中，我们将介绍一些高级功能，其中输入或输出 JSON 响应可能与生成或使用响应的对象不同。

4.1. 配置序列化或反序列化功能

在将 JSON 对象转换为 Java 类时，如果 JSON 字符串有一些新字段，默认过程会导致异常：

String jsonString 
  = "{ \"color\" : \"Black\", \"type\" : \"Fiat\", \"year\" : \"1970\" }";

上例中的 JSON 字符串在默认解析为Class Car的 Java 对象的过程中会导致UnrecognizedPropertyException异常。 通过configure方法，我们可以扩展默认流程以忽略新字段：

objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
Car car = objectMapper.readValue(jsonString, Car.class);
JsonNode jsonNodeRoot = objectMapper.readTree(jsonString);
JsonNode jsonNodeYear = jsonNodeRoot.get("year");
String year = jsonNodeYear.asText();

另一个选项基于FAIL_ON_NULL_FOR_PRIMITIVES，它定义是否允许原始值的null：

objectMapper.configure(DeserializationFeature.FAIL_ON_NULL_FOR_PRIMITIVES, false);

同样，FAIL_ON_NUMBERS_FOR_ENUM控制是否允许将枚举值序列化/反序列化为数字：

objectMapper.configure(DeserializationFeature.FAIL_ON_NUMBERS_FOR_ENUMS, false);

您可以在官方网站上找到序列化和反序列化功能的完整列表。

4.2. 创建自定义序列化器或反序列化器

ObjectMapper类的另一个基本特性是能够注册自定义序列化器和反序列化器。自定义序列化器和反序列化器在输入或输出 JSON 响应的结构与必须序列化或反序列化的 Java 类不同的情况下非常有用。 以下是自定义 JSON 序列化程序的示例：

public class CustomCarSerializer extends StdSerializer<Car> {
    
    public CustomCarSerializer() {
        this(null);
    }
    public CustomCarSerializer(Class<Car> t) {
        super(t);
    }
    @Override
    public void serialize(
      Car car, JsonGenerator jsonGenerator, SerializerProvider serializer) {
        jsonGenerator.writeStartObject();
        jsonGenerator.writeStringField("car_brand", car.getType());
        jsonGenerator.writeEndObject();
    }
}

可以像这样调用此自定义序列化程序：

ObjectMapper mapper = new ObjectMapper();
SimpleModule module = 
  new SimpleModule("CustomCarSerializer", new Version(1, 0, 0, null, null, null));
module.addSerializer(Car.class, new CustomCarSerializer());
mapper.registerModule(module);
Car car = new Car("yellow", "renault");
String carJson = mapper.writeValueAsString(car);

这是Car在客户端的样子（作为 JSON 输出）：

var carJson = {"car_brand":"renault"}

这是一个自定义 JSON 反序列化器的示例：

public class CustomCarDeserializer extends StdDeserializer<Car> {
    
    public CustomCarDeserializer() {
        this(null);
    }
    public CustomCarDeserializer(Class<?> vc) {
        super(vc);
    }
    @Override
    public Car deserialize(JsonParser parser, DeserializationContext deserializer) {
        Car car = new Car();
        ObjectCodec codec = parser.getCodec();
        JsonNode node = codec.readTree(parser);
        
        // try catch block
        JsonNode colorNode = node.get("color");
        String color = colorNode.asText();
        car.setColor(color);
        return car;
    }
}

可以通过以下方式调用此自定义反序列化程序：

String json = "{ \"color\" : \"Black\", \"type\" : \"BMW\" }";
ObjectMapper mapper = new ObjectMapper();
SimpleModule module =
  new SimpleModule("CustomCarDeserializer", new Version(1, 0, 0, null, null, null));
module.addDeserializer(Car.class, new CustomCarDeserializer());
mapper.registerModule(module);
Car car = mapper.readValue(json, Car.class);

4.3. 处理日期格式

java.util.Date的默认序列化生成一个数字，即纪元时间戳（自 1970 年 1 月 1 日以来的毫秒数，UTC）。但这不是人类可读的，需要进一步转换才能以人类可读的格式显示。让我们用datePurchased属性将我们目前使用的Car实例包装在Request类中：

public class Request 
{
    private Car car;
    private Date datePurchased;
    // standard getters setters
}

要控制日期的字符串格式并将其设置为例如yyyy-MM-dd HH:mm az，请考虑以下代码段：

ObjectMapper objectMapper = new ObjectMapper();
DateFormat df = new SimpleDateFormat("yyyy-MM-dd HH:mm a z");
objectMapper.setDateFormat(df);
String carAsString = objectMapper.writeValueAsString(request);
// output: {"car":{"color":"yellow","type":"renault"},"datePurchased":"2016-07-03 11:43 AM CEST"}

要了解有关使用 Jackson 序列化日期的更多信息，请阅读我们更深入的文章。

4.4. 处理集合

DeserializationFeature类提供的另一个小但有用的功能是能够从 JSON 数组响应生成我们想要的集合类型。例如，我们可以将结果生成为数组：

String jsonCarArray = 
  "[{ \"color\" : \"Black\", \"type\" : \"BMW\" }, { \"color\" : \"Red\", \"type\" : \"FIAT\" }]";
ObjectMapper objectMapper = new ObjectMapper();
objectMapper.configure(DeserializationFeature.USE_JAVA_ARRAY_FOR_JSON_ARRAY, true);
Car[] cars = objectMapper.readValue(jsonCarArray, Car[].class);
// print cars

或作为List：

String jsonCarArray = 
  "[{ \"color\" : \"Black\", \"type\" : \"BMW\" }, { \"color\" : \"Red\", \"type\" : \"FIAT\" }]";
ObjectMapper objectMapper = new ObjectMapper();
List<Car> listCar = objectMapper.readValue(jsonCarArray, new TypeReference<List<Car>>(){});
// print cars

有关与 Jackson 处理集合的更多信息，请单击此处。