0

0

如何将 JSON 对象正确绑定到遵循驼峰命名规范的 Java POJO

花韻仙語

花韻仙語

发布时间:2026-01-15 21:02:26

|

625人浏览过

|

来源于php中文网

原创

如何将 JSON 对象正确绑定到遵循驼峰命名规范的 Java POJO

本文详解 jackson 中 `@jsonproperty` 的双向作用机制,解决 json 下划线字段(如 `country_code`)与 java 驼峰属性(如 `countrycode`)在序列化与反序列化中的映射冲突问题,并提供零冗余、可维护的双 pojo 设计方案。

在使用 Jackson 处理 REST API 时,一个常见痛点是:服务端返回的 JSON 字段采用蛇形命名(snake_case),而团队 Java 代码规范强制要求驼峰命名(camelCase)。此时若仅靠 @JsonProperty 单向标注,极易导致「能反序列化却无法序列化」或反之的问题——正如你在示例中遇到的:将 @JsonProperty("countryCode") 错误地用于 country_code 字段,结果反序列化失败,值为 null。

根本原因在于:@JsonProperty("xxx") 是双向注解——它既指定该 Java 属性应从 JSON 的 "xxx" 字段读取(反序列化),也指定该属性在序列化为 JSON 时应写入 "xxx" 字段。因此:

  • 若你的 JSON 原文含 "country_code": "IN",而 POJO 写成:

    @JsonProperty("countryCode") // ❌ 期望读取 "countryCode",但实际是 "country_code"
    private String country_code;

    Jackson 将找不到匹配字段,赋值为 null。

    立即学习Java免费学习笔记(深入)”;

  • 正确做法是让 @JsonProperty 的值严格匹配 JSON 实际键名

    a0.dev
    a0.dev

    专为移动端应用开发设计的AI编程平台

    下载
    @JsonProperty("country_code") // ✅ 精确匹配输入 JSON
    private String countryCode;   // ✅ Java 属性名用 camelCase

但这样仍存在新问题:当你将该对象作为响应体返回时,Jackson 会输出 "country_code": "IN",而非符合 API 规范的 "countryCode"。

推荐解决方案:分离关注点,定义专用的入参(In)与出参(Out)POJO

// 公共基础字段(无 JSON 映射逻辑)
@Data
public class AirportInfoBase implements Serializable {
    private String icao;
    private String iata;
    private String name;
    private String location;
    private String country;
    private String longitude;
    private String latitude;
    private String link;
    private Integer status;
}

// 专用于接收 snake_case JSON 的入参类
@Data
public class AirportInfoIn extends AirportInfoBase {
    @JsonProperty("country_code")
    private String countryCode;

    @JsonProperty("latitude")
    private String latitudeStr; // 如需额外转换,可在此处理

    // 可选:提供便捷构造器
    public AirportInfoIn() {}
    public AirportInfoIn(AirportInfoOut out) {
        this.countryCode = out.getCountryCode();
        this.icao = out.getIcao();
        this.iata = out.getIata();
        // ... 其他字段复制
    }
}

// 专用于返回 camelCase JSON 的出参类
@Data
public class AirportInfoOut extends AirportInfoBase {
    @JsonProperty("countryCode")
    private String countryCode;

    // 构造器:从 AirportInfoIn 安全转换
    public AirportInfoOut(AirportInfoIn in) {
        this.countryCode = in.getCountryCode();
        this.icao = in.getIcao();
        this.iata = in.getIata();
        this.name = in.getName();
        this.location = in.getLocation();
        this.country = in.getCountry();
        this.longitude = in.getLongitude();
        this.latitude = in.getLatitude();
        this.link = in.getLink();
        this.status = in.getStatus();
    }
}

关键优势:

  • ✅ AirportInfoIn 精准消费第三方 API 的蛇形 JSON;
  • ✅ AirportInfoOut 精准输出符合内部规范的驼峰 JSON;
  • ✅ 通过继承复用公共字段,避免重复定义;
  • ✅ 转换逻辑集中可控,便于添加校验、格式化(如字符串转 BigDecimal、时间解析等);
  • ✅ 完全规避 @JsonProperty 双向语义引发的歧义。

⚠️ 注意事项:

  • 不要依赖 Jackson 的 PropertyNamingStrategies.SNAKE_CASE 全局配置来“自动转换”——它会对所有字段生效,易引发意外覆盖(如已有 userId 字段被转为 user_id);
  • Lombok 的 @Data 自动生成 getter/setter,确保 @JsonProperty 标注的字段名与生成方法名一致(如 countryCode → getCountryCode());
  • 若需深度嵌套或复杂转换,建议配合 @JsonCreator 和 @JsonProperty 构造器注入,提升不可变性与线程安全性。

总结:JSON 绑定不是“一次标注,处处适用”,而是“按需建模”。清晰区分数据流入(In)与流出(Out)契约,是构建健壮、可演进 API 集成层的基石。

相关专题

更多
java
java

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

832

2023.06.15

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

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

738

2023.07.05

java自学难吗
java自学难吗

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

734

2023.07.31

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

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

397

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基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

446

2023.08.02

java有什么用
java有什么用

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

430

2023.08.02

java在线网站
java在线网站

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

16926

2023.08.03

Golang gRPC 服务开发与Protobuf实战
Golang gRPC 服务开发与Protobuf实战

本专题系统讲解 Golang 在 gRPC 服务开发中的完整实践,涵盖 Protobuf 定义与代码生成、gRPC 服务端与客户端实现、流式 RPC(Unary/Server/Client/Bidirectional)、错误处理、拦截器、中间件以及与 HTTP/REST 的对接方案。通过实际案例,帮助学习者掌握 使用 Go 构建高性能、强类型、可扩展的 RPC 服务体系,适用于微服务与内部系统通信场景。

8

2026.01.15

热门下载

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

精品课程

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

共23课时 | 2.5万人学习

C# 教程
C# 教程

共94课时 | 6.8万人学习

Java 教程
Java 教程

共578课时 | 46.3万人学习

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

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