0

0

解决Jackson反序列化嵌套JSON到POJO时属性为空的问题

DDD

DDD

发布时间:2025-12-03 21:53:27

|

305人浏览过

|

来源于php中文网

原创

解决jackson反序列化嵌套json到pojo时属性为空的问题

本文将探讨使用Jackson库将嵌套JSON结构反序列化为Java POJO时,内部对象属性可能出现空值的问题。我们将介绍两种有效的解决方案:一是通过JsonNode精确提取目标JSON子树进行映射;二是设计一个与完整JSON结构匹配的包装类(Wrapper POJO)进行整体反序列化,确保数据正确绑定。

在Java开发中,我们经常需要将JSON数据映射到对应的POJO(Plain Old Java Object)中。然而,当JSON结构包含嵌套对象时,如果POJO设计不当,可能会导致反序列化后内部属性为null。考虑以下JSON结构:

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

以及一个用于映射input对象的POJO类:

import com.fasterxml.jackson.annotation.JsonIgnoreProperties;

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

    // 必须包含setter方法,Jackson才能注入值
    public void setEnvironment(String environment) {
        this.environment = environment;
    }

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

    public String getEnvironment() {
        return environment;
    }

    public String getStage() {
        return stage;
    }
}

如果直接尝试将整个JSON树映射到Input.class,例如通过OBJECT_MAPPER.treeToValue(inputJson, Input.class),environment和stage属性将返回null。这是因为Input POJO期望其自身就是JSON的根对象,但实际上它被包裹在顶层的input字段中。

解决方案一:精确提取目标JSON节点进行映射

这种方法适用于你只关心JSON中某个特定嵌套对象的数据,而不关心整个JSON结构的情况。核心思想是首先解析整个JSON字符串为JsonNode树,然后使用get()方法定位到你想要反序列化的目标节点,最后再将这个子节点映射到对应的POJO。

实现步骤:

  1. 使用ObjectMapper将完整的JSON字符串读取为JsonNode。
  2. 通过JsonNode.get("propertyName")方法获取到包含目标对象的子节点。
  3. 将获取到的子节点映射到对应的POJO类。

示例代码:

薏米AI
薏米AI

YMI.AI-快捷、高效的人工智能创作平台

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

// 确保Input类包含setter方法
@JsonIgnoreProperties(ignoreUnknown = true)
class Input {
    private String environment;
    private String stage;

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

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

    public String getEnvironment() {
        return environment;
    }

    public String getStage() {
        return stage;
    }

    @Override
    public String toString() {
        return "Input{" +
               "environment='" + environment + '\'' +
               ", stage='" + stage + '\'' +
               '}';
    }
}

public class NestedJsonDeserializationExample1 {
    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. 将inputNode映射到Input POJO
        Input myInput = mapper.treeToValue(inputNode, Input.class);

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

输出:

Environment: myEnv
Stage: beta
Mapped Input object: Input{environment='myEnv', stage='beta'}

解决方案二:设计匹配JSON结构的包装类

当你需要完整地反序列化整个JSON结构,而不仅仅是其中的一个嵌套对象时,更推荐使用此方法。通过创建一个或多个包装类(Wrapper POJO),使其结构完全匹配JSON的层级关系,Jackson就能自动完成整个JSON的反序列化过程。

实现步骤:

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

示例代码:

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

// 确保POJO类包含setter方法
@JsonIgnoreProperties(ignoreUnknown = true)
class Input {
    private String environment;
    private String stage;

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

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

    public String getEnvironment() {
        return environment;
    }

    public String getStage() {
        return stage;
    }

    @Override
    public String toString() {
        return "Input{" +
               "environment='" + environment + '\'' +
               ", stage='" + stage + '\'' +
               '}';
    }
}

@JsonIgnoreProperties(ignoreUnknown = true)
class InputWrapper {
    private String operation;
    private Input input; // 嵌套对象

    public void setOperation(String operation) {
        this.operation = operation;
    }

    public void setInput(Input input) {
        this.input = input;
    }

    public String getOperation() {
        return operation;
    }

    public Input getInput() {
        return input;
    }

    @Override
    public String toString() {
        return "InputWrapper{" +
               "operation='" + operation + '\'' +
               ", input=" + input +
               '}';
    }
}

public class NestedJsonDeserializationExample2 {
    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());
        System.out.println("Mapped InputWrapper object: " + inputWrapper);
    }
}

输出:

Operation: myoperation
Environment: myEnv
Stage: beta
Mapped InputWrapper object: InputWrapper{operation='myoperation', input=Input{environment='myEnv', stage='beta'}}

注意事项

  1. POJO中的Setter方法: Jackson在反序列化时,默认通过调用POJO的setter方法来注入JSON属性值。因此,确保你的POJO类为每个需要映射的属性都提供了公共的setter方法。如果使用Lombok等库,@Setter注解可以自动生成这些方法。
  2. @JsonIgnoreProperties(ignoreUnknown = true): 这个注解告诉Jackson在JSON中遇到POJO中没有定义的属性时,忽略它们而不是抛出异常。这在处理只关心部分JSON字段,或者JSON结构可能随时间变化的情况下非常有用。
  3. 选择合适的策略:
    • 如果你只需要JSON中某个深层嵌套的子对象,并且不关心其父级或同级属性,那么方案一(提取JsonNode) 更简洁高效。
    • 如果你需要处理整个JSON结构,或者JSON的层级相对复杂且你希望有一个完整的对象模型来表示它,那么方案二(设计包装类) 是更清晰和可维护的选择。它提供了一个完整的对象图,便于后续的数据访问和操作。

总结

当使用Jackson将嵌套JSON对象反序列化为Java POJO时,遇到属性为空的问题通常是由于POJO结构与JSON层级不匹配所致。通过本文介绍的两种方法——精确提取目标JSON节点或设计匹配JSON结构的包装类——可以有效地解决这一问题。在实际开发中,根据具体需求和JSON结构的复杂性,选择最适合的策略,并确保POJO包含必要的setter方法,是实现正确JSON反序列化的关键。

相关专题

更多
java
java

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

835

2023.06.15

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

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

740

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

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

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

43

2026.01.16

热门下载

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

精品课程

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

共23课时 | 2.6万人学习

C# 教程
C# 教程

共94课时 | 6.9万人学习

Java 教程
Java 教程

共578课时 | 47.2万人学习

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

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