0

0

Jackson 2D JSON数组与多格式数据反序列化教程

DDD

DDD

发布时间:2025-11-03 12:33:14

|

495人浏览过

|

来源于php中文网

原创

Jackson 2D JSON数组与多格式数据反序列化教程

本教程详细探讨了如何使用jackson库处理复杂的json反序列化场景。首先,通过`@jsonformat(shape = jsonformat.shape.array)`注解,解决了将json数组直接映射到自定义java对象的问题。其次,针对同一java类需要支持多种json输入格式的情况,介绍了如何利用`@jsoncreator`工厂方法结合`jsonnode`进行条件式解析,实现灵活的数据映射,确保不同结构的数据都能被正确反序列化。

理解Jackson反序列化与JSON数组映射

在使用Jackson库进行JSON反序列化时,我们通常将JSON对象映射到Java对象,JSON数组映射到Java集合或数组。然而,当JSON数组的元素本身需要映射到具有多个字段的Java对象时,例如将[-3.1, 55.4]这样的二维数组元素映射到LngLat对象(包含lng和lat两个字段),传统的字段名匹配方式就会失效,导致MismatchedInputException。

为了解决这个问题,我们需要明确告诉Jackson如何将数组中的值映射到Java对象的字段。

1. 将JSON数组元素映射到自定义Java对象

假设我们有一个LngLat记录(或类),它包含经度(lng)和纬度(lat)两个double类型字段。如果JSON数据中LngLat的表示形式是[-3.1, 55.4]这样的数组,我们可以使用@JsonFormat(shape = JsonFormat.Shape.ARRAY)注解来指导Jackson进行反序列化。

LngLat 记录定义:

import com.fasterxml.jackson.annotation.JsonFormat;

@JsonFormat(shape = JsonFormat.Shape.ARRAY)
record LngLat(double lng, double lat) {}

通过@JsonFormat(shape = JsonFormat.Shape.ARRAY),Jackson会按照记录中字段的声明顺序,将JSON数组的第一个元素映射到lng,第二个元素映射到lat。

NoFlyZone 记录定义:

在此基础上,包含LngLat数组的NoFlyZone记录可以被简化。原先需要自定义构造函数来处理double[][]并转换为LngLat[]的逻辑不再需要,Jackson可以直接处理LngLat[]。

import com.fasterxml.jackson.annotation.JsonIgnoreProperties;

@JsonIgnoreProperties("name") // 忽略JSON中可能存在的"name"字段
record NoFlyZone(LngLat[] coordinates) {}

示例代码:

import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.core.type.TypeReference;
import java.util.List;

public class JacksonArrayDeserialization {

    public static void main(String[] args) throws Exception {
        String json = "[{\"name\":\"Random\"," +
            "\"coordinates\":[[-3.1,55.4],[-3.1,55.9],[-3.7,55.3],[-3.8,55.7],[-3.0,55.8]]}]";

        ObjectMapper mapper = new ObjectMapper();

        // 使用TypeReference处理泛型类型List
        List noFlyZones = mapper.readValue(json, new TypeReference>() {});
        System.out.println(noFlyZones);
    }
}

输出示例(假设NoFlyZone和LngLat有适当的toString()实现):

IBM Watson
IBM Watson

IBM Watson文字转语音

下载
[NoFlyZone{coordinates=[LngLat[lng=-3.1, lat=55.4], LngLat[lng=-3.1, lat=55.9], LngLat[lng=-3.7, lat=55.3], LngLat[lng=-3.8, lat=55.7], LngLat[lng=-3.0, lat=55.8]]}]

2. 处理同一Java类支持多种JSON输入格式

在实际应用中,我们可能需要一个Java类来反序列化两种或多种完全不同的JSON结构。例如,NoFlyZone可能有时包含coordinates数组,有时则包含单独的longitude和latitude字段。这时,仅仅依靠字段映射和@JsonFormat是不够的。我们需要更强大的机制来根据JSON的结构动态选择反序列化逻辑。

Jackson提供了@JsonCreator注解,允许我们定义一个静态工厂方法或构造函数来处理反序列化过程。通过将JSON的所有字段作为Map传入,我们可以在工厂方法中检查JSON结构并进行自定义处理。

更新后的NoFlyZone 记录定义:

LngLat记录的定义保持不变(带有@JsonFormat(shape = JsonFormat.Shape.ARRAY))。

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.ObjectReader;
import java.io.IOException;
import java.util.Map;

@JsonIgnoreProperties(ignoreUnknown = true) // 忽略JSON中未映射到Java对象的所有未知字段,如"name"
public record NoFlyZone(LngLat[] coordinates) {

    @JsonCreator
    public static NoFlyZone getInstance(Map fields) throws IOException {

        // 判断JSON结构:是否存在"coordinates"字段
        boolean isArrayFormat = fields.containsKey("coordinates");

        LngLat[] longLatArray;

        if (isArrayFormat) {
            // 如果存在"coordinates"字段,则按LngLat数组格式反序列化
            ObjectReader reader = new ObjectMapper().readerFor(LngLat[].class);
            longLatArray = reader.readValue(fields.get("coordinates")); // 反序列化"coordinates"对应的JsonNode
        } else {
            // 如果不存在"coordinates",则假设存在"longitude"和"latitude"字段
            // 手动构建一个包含单个LngLat对象的数组
            longLatArray = new LngLat[] { 
                new LngLat(
                    fields.get("longitude").asDouble(), // 从JsonNode获取double值
                    fields.get("latitude").asDouble()
                )
            };
        }
        return new NoFlyZone(longLatArray);
    }

    // 为了方便输出,可以重写toString()方法
    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder("NoFlyZone{coordinates=[");
        if (coordinates != null) {
            for (int i = 0; i < coordinates.length; i++) {
                sb.append(coordinates[i]);
                if (i < coordinates.length - 1) {
                    sb.append(", ");
                }
            }
        }
        sb.append("]}");
        return sb.toString();
    }
}

@JsonCreator工厂方法的逻辑解析:

  1. @JsonCreator: 标记此静态方法为Jackson的反序列化入口。
  2. Map fields: Jackson会将当前JSON对象的所有顶级字段名和对应的JsonNode实例传入此Map。
  3. fields.containsKey("coordinates"): 通过检查Map中是否存在特定键,判断当前JSON是哪种结构。
  4. 条件反序列化:
    • 如果存在coordinates,则使用一个新的ObjectMapper的readerFor(LngLat[].class)来专门反序列化coordinates对应的JsonNode。这是因为JsonNode本身只是JSON树的一个节点,需要再次通过ObjectMapper进行具体类型转换。
    • 如果不存在coordinates,则从longitude和latitude对应的JsonNode中提取double值,并手动创建一个LngLat对象,然后将其放入一个单元素的LngLat数组中。
  5. @JsonIgnoreProperties(ignoreUnknown = true): 确保JSON中存在的但Java类中没有对应的字段(如name)不会导致反序列化失败。

示例代码:

import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.core.type.TypeReference;
import java.util.List;

public class JacksonMultiFormatDeserialization {

    public static void main(String[] args) throws Exception {
        String json1 = "[{\"name\":\"Random\"," +
            "\"coordinates\":[[-3.1,55.4],[-3.1,55.9],[-3.7,55.3],[-3.8,55.7],[-3.0,55.8]]}]";

        String json2 = "[{\"name\":\"Random\"," + "\"longitude\":-3.1, \"latitude\":55}]";

        ObjectMapper mapper = new ObjectMapper();

        List noFlyZones1 = mapper.readValue(json1, new TypeReference>() {});
        System.out.println("反序列化JSON1: " + noFlyZones1);

        List noFlyZones2 = mapper.readValue(json2, new TypeReference>() {});
        System.out.println("反序列化JSON2: " + noFlyZones2);
    }
}

输出示例:

反序列化JSON1: [NoFlyZone{coordinates=[LngLat[lng=-3.1, lat=55.4], LngLat[lng=-3.1, lat=55.9], LngLat[lng=-3.7, lat=55.3], LngLat[lng=-3.8, lat=55.7], LngLat[lng=-3.0, lat=55.8]]}]
反序列化JSON2: [NoFlyZone{coordinates=[LngLat[lng=-3.1, lat=55.0]]}]

注意事项与总结

  • @JsonFormat(shape = JsonFormat.Shape.ARRAY):此注解是处理JSON数组直接映射到Java对象(按字段声明顺序)的关键。它简化了原本需要自定义反序列化器或复杂构造函数的场景。
  • @JsonCreator工厂方法:当一个Java类需要支持多种截然不同的JSON结构时,@JsonCreator提供了极大的灵活性。通过接收Map,开发者可以完全控制反序列化逻辑,根据JSON内容动态构建Java对象。
  • @JsonIgnoreProperties(ignoreUnknown = true):在处理多格式JSON或部分字段不重要的情况下,此注解非常有用,可以避免因JSON中存在Java类未定义的字段而导致的错误。
  • TypeReference:在反序列化泛型集合(如List)时,应使用new TypeReference>() {}来提供完整的泛型类型信息给Jackson,否则可能导致类型擦除问题。
  • 错误处理:在@JsonCreator方法中,应考虑对JsonNode的空值检查(例如fields.get("longitude") != null)以及类型转换异常(例如asDouble()可能抛出的异常),以提高代码的健壮性。
  • 代码可读性:虽然@JsonCreator提供了灵活性,但过于复杂的逻辑可能会降低代码的可读性。在设计JSON结构时,尽量保持一致性可以简化反序列化过程。

通过掌握这些Jackson的高级特性,开发者可以有效地处理各种复杂的JSON反序列化需求,无论是将数组映射到对象,还是根据不同JSON结构进行动态解析,都能实现高效且健壮的数据处理。

相关专题

更多
java
java

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

844

2023.06.15

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

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

743

2023.07.05

java自学难吗
java自学难吗

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

740

2023.07.31

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

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

397

2023.08.01

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

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

400

2023.08.02

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

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

447

2023.08.02

java有什么用
java有什么用

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

431

2023.08.02

java在线网站
java在线网站

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

16926

2023.08.03

c++空格相关教程合集
c++空格相关教程合集

本专题整合了c++空格相关教程,阅读专题下面的文章了解更多详细内容。

0

2026.01.23

热门下载

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

精品课程

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

共23课时 | 2.8万人学习

C# 教程
C# 教程

共94课时 | 7.4万人学习

Java 教程
Java 教程

共578课时 | 50.2万人学习

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

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