0

0

Jackson高级教程:正确反序列化嵌套JSON结构到Java对象

心靈之曲

心靈之曲

发布时间:2025-12-03 23:35:00

|

893人浏览过

|

来源于php中文网

原创

Jackson高级教程:正确反序列化嵌套JSON结构到Java对象

本文深入探讨了在使用jackson库将嵌套json结构反序列化为java pojo时,常见字段为null的问题。我们将介绍两种有效的解决方案:一是通过jsonnode精确提取目标子节点后再进行映射;二是通过创建与json结构匹配的包装类(wrapper pojo)来直接反序列化整个json。这两种方法都能确保正确地将嵌套数据映射到java对象,避免数据丢失

理解嵌套JSON与POJO映射挑战

在使用Jackson库进行JSON到Java对象的反序列化时,一个常见的挑战是处理嵌套JSON结构。如果一个Java POJO只代表JSON结构中的一个内部嵌套对象,而开发者尝试将整个JSON字符串直接映射到这个POJO,那么POJO的字段很可能因为无法找到匹配的根级别属性而显示为null。

考虑以下JSON数据示例:

{
  "operation": "myoperation",
  "input": {
    "environment": "myEnv",
    "stage": "beta"
  }
}

以及一个旨在映射input对象内容的Java POJO:

import com.fasterxml.jackson.annotation.JsonIgnoreProperties;

@JsonIgnoreProperties(ignoreUnknown = true)
public class Input {
    private String environment;
    private String stage;

    // 默认构造函数是必需的,如果存在自定义构造函数,也需显式提供
    public Input() {}

    public String getEnvironment() {
        return environment; // 确保返回正确的字段
    }

    public void setEnvironment(String environment) {
        this.environment = environment;
    }

    public String getStage() {
        return stage;
    }

    public void setStage(String stage) {
        this.stage = stage;
    }
}

如果直接将整个JSON字符串解析为JsonNode,然后尝试将其映射到Input.class,例如:OBJECT_MAPPER.treeToValue(fullJsonNode, Input.class);,那么Input对象的environment和stage字段将为null。这是因为fullJsonNode的根节点包含operation和input,而Input POJO期望其自身就是JSON的根,直接拥有environment和stage属性。

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

解决方案一:通过JsonNode精确提取目标子节点

当你的POJO只代表JSON结构中的一个特定子部分,并且你不希望为整个JSON结构创建完整的POJO链时,可以通过JsonNode来精确提取目标子节点。这种方法首先将整个JSON解析为一棵JsonNode树,然后导航到包含目标数据的特定子节点,最后将该子节点映射到相应的POJO。

实现步骤:

  1. 使用ObjectMapper将完整的JSON字符串解析为根JsonNode。
  2. 通过根JsonNode的get("propertyName")方法获取到包含目标嵌套对象的子JsonNode。
  3. 将这个子JsonNode映射到你的目标POJO类。

示例代码:

ClipDrop
ClipDrop

Stability.AI出品的图片处理系列工具(背景移除、图片放大、打光)

下载
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;

public class NestedJsonDeserializationByNode {

    @JsonIgnoreProperties(ignoreUnknown = true)
    public static class Input {
        private String environment;
        private String stage;

        public Input() {} // 确保存在公共的无参构造函数

        public String getEnvironment() { return environment; }
        public void setEnvironment(String environment) { this.environment = environment; }
        public String getStage() { return stage; }
        public void setStage(String stage) { this.stage = stage; }
    }

    public static void main(String[] args) throws Exception {
        String jsonString = """
            {
              "operation": "myoperation",
              "input": {
                "environment": "myEnv",
                "stage": "beta"
              }
            }
            """;

        ObjectMapper mapper = new ObjectMapper();
        // 1. 解析整个JSON字符串为根JsonNode
        JsonNode rootNode = mapper.readTree(jsonString);
        // 2. 获取名为 "input" 的子节点
        JsonNode inputNode = rootNode.get("input");

        // 3. 将 "input" 子节点映射到 Input POJO
        Input myInput = mapper.treeToValue(inputNode, Input.class);

        System.out.println("Environment: " + myInput.getEnvironment());
        System.out.println("Stage: " + myInput.getStage());
    }
}

输出:

Environment: myEnv
Stage: beta

解决方案二:构建匹配的包装类(Wrapper POJO)

当你的Java应用程序需要完整地表示和处理整个JSON结构时,更推荐的做法是创建一系列POJO,它们完整地镜像了JSON的层级结构。这意味着如果JSON有一个顶层对象,其中包含一个嵌套对象,那么你的Java代码也应该有一个顶层POJO,其中包含一个嵌套POJO作为其属性。

实现步骤:

  1. 定义一个顶层POJO(例如InputWrapper),包含JSON根级别的所有属性,其中嵌套对象属性的类型是其对应的POJO(例如Input)。
  2. 定义嵌套POJO(例如Input),包含嵌套对象内部的所有属性。
  3. 直接使用ObjectMapper将整个JSON字符串反序列化为顶层POJO的实例。

示例代码:

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

// 实际项目中,通常会使用Lombok的@Getter和@Setter注解来简化POJO代码
// import lombok.Getter;
// import lombok.Setter;

public class NestedJsonDeserializationWithWrapper {

    @JsonIgnoreProperties(ignoreUnknown = true)
    // @Setter @Getter // 如果使用Lombok,可直接添加此注解
    public static class InputWrapper {
        private String operation;
        private Input input; // 嵌套对象

        public InputWrapper() {} // 默认构造函数

        public String getOperation() { return operation; }
        public void setOperation(String operation) { this.operation = operation; }
        public Input getInput() { return input; }
        public void setInput(Input input) { this.input = input; }
    }

    @JsonIgnoreProperties(ignoreUnknown = true)
    // @Setter @Getter // 如果使用Lombok
    public static class Input {
        private String environment;
        private String stage;

        public Input() {} // 默认构造函数

        public String getEnvironment() { return environment; }
        public void setEnvironment(String environment) { this.environment = environment; }
        public String getStage() { return stage; }
        public void setStage(String stage) { this.stage = stage; }
    }

    public static void main(String[] args) throws Exception {
        String jsonString = """
            {
              "operation": "myoperation",
              "input": {
                "environment": "myEnv",
                "stage": "beta"
              }
            }
            """;

        ObjectMapper mapper = new ObjectMapper();
        // 直接将整个JSON字符串反序列化为 InputWrapper 对象
        InputWrapper inputWrapper = mapper.readValue(jsonString, InputWrapper.class);

        // 通过包装类访问嵌套的 Input 对象
        Input myInput = inputWrapper.getInput();

        System.out.println("Operation: " + inputWrapper.getOperation());
        System.out.println("Environment: " + myInput.getEnvironment());
        System.out.println("Stage: " + myInput.getStage());
    }
}

输出:

Operation: myoperation
Environment: myEnv
Stage: beta

这种方法提供了更清晰、更面向对象的JSON数据模型,尤其适合处理复杂的、多层嵌套的JSON结构,因为它将JSON的结构直接映射到了Java对象的结构。

注意事项与最佳实践

  • POJO的Getter和Setter方法: 确保所有需要反序列化的字段都拥有公共的getter和setter方法。Jackson在反序列化时通过setter方法注入值,在序列化时通过getter方法获取值。
  • 无参构造函数: 默认情况下,Jackson需要一个公共的无参构造函数来实例化POJO。如果自定义了构造函数,请务必手动添加一个公共的无参构造函数,否则可能导致反序列化失败。
  • @JsonIgnoreProperties(ignoreUnknown = true): 这个注解非常有用,它告诉Jackson忽略JSON中存在但POJO中没有定义的字段,从而避免在JSON结构发生变化时导致反序列化失败。
  • 选择合适的方案:
    • 当你只需要JSON中某个特定子对象的数据,且不关心其他部分时,解决方案一(提取JsonNode)更为简洁高效。
    • 当你需要完整地表示和操作整个JSON结构时,解决方案二(构建包装类)提供了更健壮、更易于维护的代码结构。
  • 使用Lombok: 对于POJO,可以使用Lombok库的@Getter和@Setter注解自动生成getter和setter方法,大大减少样板代码,提高开发效率。

总结

正确地将嵌套JSON结构反序列化为Java POJO是使用Jackson库时的常见需求。通过本文介绍的两种方法——精确提取JsonNode子节点或构建匹配的包装类——开发者可以有效地解决嵌套字段为null的问题。理解JSON结构与POJO结构之间的一致性是成功进行数据映射的关键。根据具体的业务需求和JSON的复杂程度,选择最适合的策略,能够确保数据的准确解析和应用程序的健壮性。

相关专题

更多
java
java

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

837

2023.06.15

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

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

741

2023.07.05

java自学难吗
java自学难吗

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

736

2023.07.31

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

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

397

2023.08.01

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

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

399

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

高德地图升级方法汇总
高德地图升级方法汇总

本专题整合了高德地图升级相关教程,阅读专题下面的文章了解更多详细内容。

72

2026.01.16

热门下载

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

精品课程

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

共23课时 | 2.6万人学习

C# 教程
C# 教程

共94课时 | 7万人学习

Java 教程
Java 教程

共578课时 | 47.6万人学习

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

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