Jackson反序列化嵌套JSON为空怎么解决

大家好，我们又见面了啊~本文《Jackson反序列化嵌套JSON属性为空解决方法》的内容中将会涉及到等等。如果你正在学习文章相关知识，欢迎关注我，以后会给大家带来更多文章相关文章，希望我们能一起进步！下面就开始本文的正式内容~

本文将探讨使用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类。

示例代码：

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反序列化的关键。

好了，本文到此结束，带大家了解了《Jackson反序列化嵌套JSON为空怎么解决》，希望本文对你有所帮助！关注golang学习网公众号，给大家分享更多文章知识！