【Java 进阶篇】揭秘 Jackson：Java 对象转 JSON 注解的魔法

繁依Fanyi

发布于 2023-11-22 10:38:04

2740

发布于 2023-11-22 10:38:04

嗨，亲爱的同学们！欢迎来到这篇关于 Jackson JSON 解析器中 Java 对象转 JSON 注解的详细解析指南。JSON（JavaScript Object Notation）是一种常用于数据交换的轻量级数据格式，而 Jackson 作为一款优秀的 JSON 解析库，通过注解提供了便捷而强大的方式，让我们能够更自由地掌控 Java 对象与 JSON 之间的转换。在这篇博客中，我将带你一探 Jackson 注解的奇妙世界，通过示例代码揭秘 Java 对象转 JSON 注解的魔法！

什么是 Jackson 注解？

在开始之前，让我们先简要了解一下 Jackson 注解是什么。

Jackson 注解是一组用于配置 Java 对象序列化和反序列化过程的注解。通过在 Java 类或字段上添加这些注解，我们可以指导 Jackson 如何处理 JSON 转换。这为我们提供了极大的灵活性，让我们能够通过注解方式定制化 JSON 转换过程，满足不同的需求。

基本注解：`@JsonProperty`

首先，让我们介绍最基本的注解之一：@JsonProperty。这个注解用于指定 JSON 字符串中的字段名与 Java 对象中的字段名之间的映射关系。

import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.databind.ObjectMapper;

public class JsonPropertyExample {
    public static void main(String[] args) throws Exception {
        // 创建一个 ObjectMapper 对象
        ObjectMapper objectMapper = new ObjectMapper();

        // 创建一个包含 @JsonProperty 注解的对象
        JsonPropertyObject jsonPropertyObject = new JsonPropertyObject("Alice", 25);

        // 将对象序列化为 JSON 字符串
        String jsonString = objectMapper.writeValueAsString(jsonPropertyObject);

        // 输出结果
        System.out.println(jsonString);
    }
}

在这个例子中，JsonPropertyObject 类的字段 name 被注解为 @JsonProperty("fullName")，这意味着在序列化为 JSON 字符串时，字段 name 将以 "fullName" 作为键。输出结果应该是类似于 {"fullName":"Alice","age":25} 的字符串。

定制化日期格式：`@JsonFormat`

在处理日期类型时，我们常常需要定制化日期的格式。这时，@JsonFormat 就派上用场了。

import com.fasterxml.jackson.annotation.JsonFormat;
import com.fasterxml.jackson.databind.ObjectMapper;

import java.util.Date;

public class JsonFormatExample {
    public static void main(String[] args) throws Exception {
        // 创建一个 ObjectMapper 对象
        ObjectMapper objectMapper = new ObjectMapper();

        // 创建包含 @JsonFormat 注解的对象
        JsonFormatObject jsonFormatObject = new JsonFormatObject(new Date());

        // 将对象序列化为 JSON 字符串
        String jsonString = objectMapper.writeValueAsString(jsonFormatObject);

        // 输出结果
        System.out.println(jsonString);
    }
}

在这个例子中，JsonFormatObject 类的字段 birthDate 被注解为 @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd")，这表示在序列化为 JSON 字符串时，birthDate 将以指定的日期格式呈现。输出结果应该是类似于 {"birthDate":"2023-01-01"} 的字符串。

忽略字段：`@JsonIgnore`

有时候，我们希望在序列化或反序列化过程中忽略某些字段，这时可以使用 @JsonIgnore 注解。

import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.databind.ObjectMapper;

public class JsonIgnoreExample {
    public static void main(String[] args) throws Exception {
        // 创建一个 ObjectMapper 对象
        ObjectMapper objectMapper = new ObjectMapper();

        // 创建包含 @JsonIgnore 注解的对象
        IgnoreFieldObject ignoreFieldObject = new IgnoreFieldObject("Sensitive Data", "Normal Data");

        // 将对象序列化为 JSON 字符串
        String jsonString = objectMapper.writeValueAsString(ignoreFieldObject);

        // 输出结果
        System.out.println(jsonString);
    }
}

在这个例子中，IgnoreFieldObject 类的字段 sensitiveData 被注解为 @JsonIgnore，这表示在序列化为 JSON 字符串时，sensitiveData 字段将被忽略。输出结果应该是类似于 {"normalData":"Normal Data"} 的字符串。

支持枚举：`@JsonEnumDefaultValue`

在处理枚举类型时，我们可能会遇到枚举值新增但尚未在代码中处理的情况。这时，@JsonEnumDefaultValue 注解可以帮助我们处理未知的枚举值。

import com.fasterxml.jackson.annotation.JsonEnumDefaultValue;
import com.fasterxml.jackson.databind.ObjectMapper;

public class JsonEnumDefaultValueExample {
    public static void main(String[] args) throws Exception {
        // 创建一个 ObjectMapper 对象
        ObjectMapper objectMapper = new ObjectMapper();

        // 创建包含 @JsonEnumDefaultValue 注解的对象
        EnumDefaultValueObject enumDefaultValueObject = new EnumDefaultValueObject(EnumWithDefault.UNKNOWN);

        // 将对象序列化为 JSON 字符串
        String jsonString = objectMapper.writeValueAsString(enumDefaultValueObject);

        // 输出结果
        System.out.println(jsonString);
    }
}

在这个例子中，EnumDefaultValueObject 类的字段 enumValue 被注解为 @JsonEnumDefaultValue，并且指定了默认值为 EnumWithDefault.UNKNOWN。这意味着在序列化为 JSON 字符串时，如果枚举值未知，将使用默认值 UNKNOWN。

定制化序列化与反序列化：`@JsonSerialize` 与 `@JsonDeserialize`

有时候，我们可能需要对字段进行更复杂的序列化或反序列化操作，这时可以使用 @JsonSerialize 和 @JsonDeserialize 注解。

import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;

public class JsonSerializeDeserializeExample {
    public static void main(String[] args) throws Exception {
        // 创建一个 ObjectMapper 对象
        ObjectMapper objectMapper = new ObjectMapper();

        // 创建包含 @JsonSerialize 和 @JsonDeserialize 注解的对象
        SerializeDeserializeObject serializeDeserializeObject = new SerializeDeserializeObject("customValue");

        // 将对象序列化为 JSON 字符串
        String jsonString = objectMapper.writeValueAsString(serializeDeserializeObject);

        // 输出结果
        System.out.println(jsonString);

        // 将 JSON 字符串反序列化为对象
        SerializeDeserializeObject deserializedObject = objectMapper.readValue(jsonString, SerializeDeserializeObject.class);

        // 输出反序列化结果
        System.out.println(deserializedObject.getCustomValue());
    }
}

在这个例子中，SerializeDeserializeObject 类的字段 customValue 被注解为 @JsonSerialize(using = CustomSerializer.class) 和 @JsonDeserialize(using = CustomDeserializer.class)。这意味着在序列化时将使用自定义的序列化器 CustomSerializer，而在反序列化时将使用自定义的反序列化器 CustomDeserializer。

嵌套对象处理：`@JsonManagedReference` 与 `@JsonBackReference`

当对象之间存在双向关系时，为了防止无限递归的序列化问题，我们可以使用 @JsonManagedReference 和 @JsonBackReference 注解。

import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.annotation.JsonBackReference;
import com.fasterxml.jackson.databind.annotation.JsonManagedReference;

public class JsonReferenceExample {
    public static void main(String[] args) throws Exception {
        // 创建一个 ObjectMapper 对象
        ObjectMapper objectMapper = new ObjectMapper();

        // 创建包含 @JsonManagedReference 和 @JsonBackReference 注解的对象
        ReferenceParent parent = new ReferenceParent("Parent");
        ReferenceChild child = new ReferenceChild("Child", parent);

        // 设置对象间的关系
        parent.setChild(child);

        // 将对象序列化为 JSON 字符串
        String jsonString = objectMapper.writeValueAsString(parent);

        // 输出结果
        System.out.println(jsonString);
    }
}

在这个例子中，ReferenceParent 类的字段 child 被注解为 @JsonManagedReference，而 ReferenceChild 类的字段 parent 被注解为 @JsonBackReference。这样，序列化时将优先处理 @JsonManagedReference，而忽略 @JsonBackReference，从而避免了无限递归的问题。

小结

通过本文的介绍，我们深入探讨了 Jackson JSON 解析器中 Java 对象转 JSON 注解的强大功能。从基本的 @JsonProperty 到复杂的 @JsonSerialize 与 @JsonDeserialize，再到处理对象间关系的 @JsonManagedReference 与 @JsonBackReference，Jackson 提供了丰富的注解来满足各种需求。希望本文能够帮助你更好地理解和使用 Jackson 注解，让 JSON 转换变得更加得心应手！