Jackson JSON 属性序列化详解：注解、规则与最佳实践

Jackson 库是 Java 中广泛使用的 JSON 处理工具。它遵循 JavaBeans 约定，并提供丰富的注解来控制 JSON 的序列化和反序列化过程。理解 Jackson 如何处理 JSON 属性名称至关重要，可以避免配置错误，编写出更简洁、高效的代码。

Jackson 的 JavaBeans 约定

Jackson 默认遵循 JavaBeans 约定。这意味着它会根据 getter 和 setter 方法来推断 JSON 属性名称。例如，如果一个类有一个 getName() 方法，Jackson 会认为对应的 JSON 属性是 name。 如果没有无参构造函数，Jackson会寻找使用@JsonCreator注解的构造函数，并使用@JsonProperty注解来匹配JSON属性名。

常用注解详解

Jackson 提供了多种注解来控制序列化和反序列化的行为。以下是一些常用的注解：

• @JsonAlias: 用于在反序列化时指定属性的别名。例如，如果 JSON 中属性名为 isbn-10，但 Java 类中的字段名为 isbn，可以使用 @JsonAlias({"isbn", "isbn-10"}) 来将 isbn-10 映射到 isbn 字段。 该注解只影响反序列化。
• @JsonProperty: 用于指定属性的名称。可以用于构造函数参数、getter 方法或 setter 方法。例如，@JsonProperty("ISBN") 会将属性名称指定为 ISBN。
• @JsonGetter: 用于指定 getter 方法对应的 JSON 属性名称。如果 getter 方法名不符合 JavaBeans 约定，可以使用 @JsonGetter 来显式指定属性名称。
• @JsonSetter: 用于指定 setter 方法对应的 JSON 属性名称。与 @JsonGetter 类似，用于处理不符合 JavaBeans 约定的 setter 方法。
• @JsonCreator: 用于指定用于创建对象的构造函数或工厂方法。通常与 @JsonProperty 结合使用，将 JSON 属性映射到构造函数参数。

示例代码

以下是一个使用 Jackson 注解的示例：

import com.fasterxml.jackson.annotation.JsonAlias;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;

public class Book {
    private String title;
    private String author;

    @JsonAlias({"isbn", "isbn-10"})
    private String isbn;

    @JsonCreator
    public Book(@JsonProperty("title") String title,
                @JsonProperty("author") String author,
                @JsonProperty("isbn-10") String isbn) {
        this.title = title;
        this.author = author;
        this.isbn = isbn;
    }

    public String getTitle() {
        return title;
    }

    public String getAuthor() {
        return author;
    }

    public String getIsbn() {
        return isbn;
    }
}

在这个例子中，@JsonAlias({"isbn", "isbn-10"}) 注解告诉 Jackson，在反序列化时，可以将 JSON 中的 isbn 或 isbn-10 属性映射到 isbn 字段。 @JsonCreator注解指定了构造函数，@JsonProperty将构造函数参数与json的属性名关联。

最佳实践与注意事项

• 避免冗余注解: 如果 getter 和 setter 方法符合 JavaBeans 约定，并且属性名称与字段名称一致，则可以省略 @JsonProperty 和 @JsonGetter 注解。
• 使用 @JsonAlias 处理别名: 当 JSON 属性名称与 Java 字段名称不一致时，使用 @JsonAlias 来指定别名。
• 明确指定构造函数: 使用 @JsonCreator 和 @JsonProperty 明确指定用于创建对象的构造函数，可以提高代码的可读性和可维护性。
• 理解序列化和反序列化的区别: @JsonAlias 主要用于反序列化，而 @JsonProperty 和 @JsonGetter 可以用于序列化和反序列化。
• 处理复杂类型: 对于 List、Map 等复杂类型，可以使用 Jackson 的泛型支持，并结合 @JsonDeserialize 和 @JsonSerialize 注解来定制序列化和反序列化行为。

总结

Jackson 是一个功能强大的 JSON 处理库，通过理解 JavaBeans 约定和合理使用注解，可以灵活地控制 JSON 的序列化和反序列化过程。 避免冗余注解，明确指定构造函数，并充分利用 Jackson 的泛型支持，可以编写出更简洁、高效的 JSON 处理代码。