0

0

使用Jackson TypeFactory实现Java泛型列表反序列化

碧海醫心

碧海醫心

发布时间:2025-11-17 12:30:31

|

376人浏览过

|

来源于php中文网

原创

使用Jackson TypeFactory实现Java泛型列表反序列化

本文旨在解决java中利用jackson库进行泛型列表反序列化时遇到的类型擦除问题。通过深入探讨`typereference`的局限性,我们引入了`typefactory`,特别是`constructcollectiontype`方法,来动态构建运行时类型信息。文章提供了详细的示例代码,展示了如何创建一个通用的方法,能够灵活地将json数据反序列化为任何指定类型的对象列表,并建议使用`inputstream`以增强方法的通用性。

在Java开发中,我们经常需要将JSON数据反序列化为特定类型的对象列表。当面对多种不同的对象类型(例如List和List)时,为每种类型编写一个单独的反序列化方法会导致代码重复和维护困难。理想情况下,我们希望创建一个泛型方法来处理所有类型的列表反序列化。

问题分析:泛型擦除与TypeReference的局限性

考虑以下场景:我们有两个模型类A和B,并希望将对应的JSON文件反序列化为List和List

class A {}
class B {}

public class MainClass {
    public static void main(String[] args) throws IOException {
        String aJsonPath = "path/to/a.json";
        List aList = readAJsonAsList(aJsonPath);

        String bJsonPath = "path/to/b.json";
        List bList = readBJsonAsList(bJsonPath);
    }

    // 方法 for A
    private static List readAJsonAsList(String jsonAFile) throws IOException {
        ObjectMapper omA = new ObjectMapper();
        List aList = omA.readValue(new File(jsonAFile), new TypeReference>() {});
        return aList;
    }

    // 方法 for B
    private static List readBJsonAsList(String jsonBFile) throws IOException {
        ObjectMapper omB = new ObjectMapper();
        List bList = omB.readValue(new File(jsonBFile), new TypeReference>() {});
        return bList;
    }
}

上述代码中,readAJsonAsList和readBJsonAsList方法结构高度相似,仅泛型参数不同。为了实现代码复用,我们可能会尝试创建一个泛型方法:

// 尝试的泛型方法
private static  List readJsonAsList(String jsonFile) throws IOException {
    ObjectMapper objectMapper = new ObjectMapper();
    // 这种方式不会生效
    List list = objectMapper.readValue(new File(jsonFile), new TypeReference>() {});
    return list;
}

然而,上述尝试的泛型方法并不能正确工作。其核心原因在于Java的类型擦除机制。在运行时,泛型类型参数T的信息会被擦除,TypeReference>在运行时无法获取到T的具体类型。TypeReference的工作原理是利用匿名内部类来捕获泛型类型信息,但这要求泛型参数在编译时是确定的具体类型(例如A或B),而不是一个泛型类型参数T。因此,Jackson无法在运行时知道T到底代表什么类型,从而导致反序列化失败或行为异常。

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

解决方案:利用Jackson TypeFactory动态构建类型

要解决类型擦除问题,我们需要在运行时向Jackson提供泛型类型T的具体Class对象。Jackson提供了TypeFactory类,用于在运行时动态构建JavaType。TypeFactory.constructCollectionType()方法能够将集合类型和元素类型结合起来,形成一个完整的类型描述。

Type Studio
Type Studio

一个视频编辑器,提供自动转录、自动生成字幕、视频翻译等功能

下载

具体步骤如下:

  1. 传入元素类型: 修改泛型方法,使其接受一个Class类型的参数,该参数代表列表中元素的具体类型。
  2. 使用TypeFactory构建JavaType: 通过TypeFactory.defaultInstance().constructCollectionType(collectionClass, elementClass)方法,传入集合类型(例如List.class)和元素的Class对象,动态构建出完整的JavaType。

此外,为了增强方法的通用性,建议将文件路径参数替换为InputStream。这样,该方法不仅可以处理文件,还可以处理网络流、内存中的字节数组流等多种输入源。

下面是经过优化的泛型反序列化方法:

import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.type.TypeFactory;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.List;
import java.util.ArrayList;

public class GenericJacksonDeserializer {

    // 示例模型类
    private static class A {
        public String name;
        public int id;

        // 默认构造函数是Jackson反序列化所必需的
        public A() {} 

        public A(String name, int id) {
            this.name = name;
            this.id = id;
        }

        @Override
        public String toString() {
            return "A{name='" + name + "', id=" + id + "}";
        }
    }

    private static class B {
        public String description;
        public double value;

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

        public B(String description, double value) {
            this.description = description;
            this.value = value;
        }

        @Override
        public String toString() {
            return "B{description='" + description + "', value=" + value + "}";
        }
    }

    /**
     * 通用的JSON列表反序列化方法
     *
     * @param inputStream 包含JSON数据的输入流
     * @param elementType 列表中元素的Class对象
     * @param  列表元素的类型
     * @return 反序列化后的对象列表
     * @throws IOException 如果读取或解析JSON时发生错误
     */
    private static  List readJsonAsList(InputStream inputStream, Class elementType) throws IOException {
        ObjectMapper mapper = new ObjectMapper();
        TypeFactory factory = TypeFactory.defaultInstance();
        // 动态构建JavaType,指定集合类型为List.class,元素类型为elementType
        return mapper.readValue(inputStream, factory.constructCollectionType(List.class, elementType));
    }

    public static void main(String[] args) {
        // 假设我们有以下JSON文件
        // a.json: [{"name":"Item A1","id":1},{"name":"Item A2","id":2}]
        // b.json: [{"description":"Desc B1","value":10.5},{"description":"Desc B2","value":20.0}]

        // 为了示例,我们先创建模拟的JSON文件
        createDummyJsonFiles();

        try (InputStream aStream = new FileInputStream("a.json")) {
            List aList = readJsonAsList(aStream, A.class);
            System.out.println("Deserialized A List: " + aList);
        } catch (IOException exc) {
            System.err.println("Error reading A list: " + exc.getMessage());
            exc.printStackTrace();
        }

        try (InputStream bStream = new FileInputStream("b.json")) {
            List bList = readJsonAsList(bStream, B.class);
            System.out.println("Deserialized B List: " + bList);
        } catch (IOException exc) {
            System.err.println("Error reading B list: " + exc.getMessage());
            exc.printStackTrace();
        }
    }

    // 辅助方法:创建模拟的JSON文件
    private static void createDummyJsonFiles() {
        ObjectMapper mapper = new ObjectMapper();
        try {
            List dummyAList = new ArrayList<>();
            dummyAList.add(new A("Item A1", 1));
            dummyAList.add(new A("Item A2", 2));
            mapper.writeValue(new File("a.json"), dummyAList);

            List dummyBList = new ArrayList<>();
            dummyBList.add(new B("Desc B1", 10.5));
            dummyBList.add(new B("Desc B2", 20.0));
            mapper.writeValue(new File("b.json"), dummyBList);

            System.out.println("Dummy JSON files created: a.json, b.json");
        } catch (IOException e) {
            System.err.println("Failed to create dummy JSON files: " + e.getMessage());
        }
    }
}

注意事项与总结

  1. 默认构造函数: 确保所有将被Jackson反序列化的类(如A和B)都包含一个无参的默认构造函数,Jackson需要它来实例化对象。
  2. InputStream的优势: 使用InputStream作为输入源,使得readJsonAsList方法具有更高的灵活性和通用性。无论是从文件、网络连接还是内存中的字符串读取JSON,都可以方便地适配。
  3. TypeFactory的核心作用: TypeFactory是Jackson处理复杂泛型类型反序列化的关键。当TypeReference因类型擦除而无法满足需求时,TypeFactory提供了一种在运行时动态构建类型信息的方法。

通过上述方法,我们成功创建了一个通用的Java泛型方法,能够利用Jackson库灵活地将JSON数据反序列化为任何指定类型的对象列表,极大地提高了代码的复用性和可维护性。理解并正确运用TypeFactory是掌握Jackson高级泛型操作的重要一步。

相关专题

更多
java
java

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

834

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

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

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

9

2026.01.16

热门下载

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

精品课程

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

共23课时 | 2.6万人学习

C# 教程
C# 教程

共94课时 | 6.8万人学习

Java 教程
Java 教程

共578课时 | 46.7万人学习

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

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