Java中 类的字段 field 怎么在 Jackson 序列化中用 @JsonProperty 重命名

夏芳吖_1678

夏芳吖_1678

2026-08-01

516人浏览

原创

jackson中可用@jsonproperty注解重命名字段:加在字段上指定新键名,使序列化和反序列化均使用该名称;也可通过access属性控制单向生效,或结合@jsonunwrapped实现扁平化嵌套。

java中 类的字段 field 怎么在 jackson 序列化中用 @jsonproperty 重命名

在 Jackson 中,用 @JsonProperty 注解给字段重命名非常直接:把它加在字段声明上方,并指定新名称即可。Jackson 默认会把字段名作为 JSON 键,而 @JsonProperty("xxx") 会覆盖这个默认行为,让序列化和反序列化都使用你指定的键名。

基础用法:字段上直接加注解

这是最常用的方式。只要字段是 public、protected、package-private 或 private(配合默认 getter/setter 或开启字段访问),Jackson 都能识别。

  • 字段必须有 getter/setter(或开启 Visibility 配置支持直接访问私有字段)
  • 注解写在字段声明行,不是 getter 方法上(除非你只希望影响序列化/反序列化中的某一方)
  • 例如:
public class User {
    @JsonProperty("user_name")
    private String username;

    @JsonProperty("full_name")
    private String name;

    // 构造函数、getter、setter 省略
}

序列化结果:{"user_name":"alice","full_name":"Alice Smith"}

只控制序列化或反序列化方向

如果只想改输出(序列化)的字段名,但保留原名用于输入(反序列化),可以用 @JsonProperty 的 value 和 access 属性组合:

deep-java-review
deep-java-review

Java项目代码review工具。分析Git变更+完整调用链路上下文,推断业务需求,进行多维度评分和分类汇总,生成完整PRD文档。包含细粒度Java代码审查清单(Null安全、异常处理、Streams、并发、equals/hashCode、资源管理、API设计、性能、MyBatis/ORM、事务边界、SQL/DD...

下载
  • @JsonProperty(value = "id", access = JsonProperty.Access.READ_ONLY) → JSON 输出用 "id",但反序列化时仍接受原字段名(如 userId)或不处理该字段
  • @JsonProperty(value = "input_code", access = JsonProperty.Access.WRITE_ONLY) → 只在反序列化时认 "input_code",序列化时不出现

配合 @JsonUnwrapped 实现嵌套扁平化

当字段类型本身是 POJO,且你想把它“展开”到外层 JSON 中,可以结合 @JsonUnwrapped 和 @JsonProperty:

public class Order {
    @JsonProperty("order_id")
    private Long id;

    @JsonUnwrapped(prefix = "customer_")
    @JsonProperty("customer")
    private Person customer; // 假设 Person 有 name/email 字段
}

序列化后变成:{"order_id":123,"customer_name":"Bob","customer_email":"bob@example.com"}

注意点:避免和 getter/setter 上的注解冲突

如果字段和对应的 getter 都加了 @JsonProperty,Jackson 优先采用 getter 上的注解(对序列化),setter 上的优先用于反序列化。所以建议统一放在字段上,或统一放在 getter/setter 上,不要混用。

  • 字段级注解更简洁,适合字段名和 JSON 键差异大的场景
  • 如果用了 Lombok,确保 @Data / @Getter / @Setter 不会意外覆盖你的注解(Lombok 生成的方法默认不带注解)
  • 字段名含下划线、驼峰不一致、或想兼容旧 API 接口时,这种重命名特别实用

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

java js json

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

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

2023.06.15

9557

6

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

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

2023.07.05

6722

9

java自学难吗
java自学难吗

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

2023.07.31

5952

8

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

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

2023.08.01

1044

3

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

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

2023.08.02

868

3

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

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

2023.08.02

1256

5

java有什么用
java有什么用

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

2023.08.02

2509

5

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

2023.08.03

19851

3

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

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1135

8

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习