0

0

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

DDD

DDD

发布时间:2025-08-15 18:02:16

|

1112人浏览过

|

来源于php中文网

原创

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 注解的示例:

火山写作
火山写作

字节跳动推出的中英文AI写作、语法纠错、智能润色工具,是一款集成创作、润色、纠错、改写、翻译等能力的中英文 AI 写作助手。

下载
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 处理代码。

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

651

2023.06.15

java流程控制语句有哪些
java流程控制语句有哪些

java流程控制语句:1、if语句;2、if-else语句;3、switch语句;4、while循环;5、do-while循环;6、for循环;7、foreach循环;8、break语句;9、continue语句;10、return语句。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

453

2024.02.23

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

722

2023.07.05

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

725

2023.07.31

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

394

2023.08.01

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

398

2023.08.02

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

441

2023.08.02

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

426

2023.08.02

苹果官网入口直接访问
苹果官网入口直接访问

苹果官网直接访问入口是https://www.apple.com/cn/,该页面具备0.8秒首屏渲染、HTTP/3与Brotli加速、WebP+AVIF双格式图片、免登录浏览全参数等特性。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

10

2025.12.24

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
React 教程
React 教程

共58课时 | 2.9万人学习

Pandas 教程
Pandas 教程

共15课时 | 0.8万人学习

ASP 教程
ASP 教程

共34课时 | 2.8万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号