如何为 Jackson 配置 Pair 类型的序列化与反序列化支持

雨晨君_3948

雨晨君_3948

2026-04-17

958人浏览

原创

如何为 Jackson 配置 Pair 类型的序列化与反序列化支持

本文详解如何解决 Jackson 反序列化 org.apache.commons.lang3.tuple.Pair 时因抽象类型无法实例化导致的 InvalidDefinitionException,通过自定义 JsonSerializer 和 JsonDeserializer 实现对 Pair 的完整 JSON 映射支持。

本文详解如何解决 jackson 反序列化 `org.apache.commons.lang3.tuple.pair` 时因抽象类型无法实例化导致的 `invaliddefinitionexception`,通过自定义 `jsonserializer` 和 `jsondeserializer` 实现对 `pair` 的完整 json 映射支持。

Jackson 默认不支持直接反序列化 org.apache.commons.lang3.tuple.Pair(其为抽象类且无默认构造器),因此在将 JSON 映射到含 Map> 字段的 POJO(如 Npd 类)时会抛出 InvalidDefinitionException。核心问题在于:Jackson 无法凭空构造 Pair 实例,必须显式指定具体实现类(如 MutablePair)并提供对应的序列化/反序列化逻辑。

✅ 正确解决方案:注册自定义 Serializer + Deserializer

需分别实现 PairSerializer(用于序列化 Pair 为 JSON 对象)和 PairDeserializer(用于将 JSON 解析为 MutablePair 实例),并通过 SimpleModule 注册至 ObjectMapper。

1. 自定义序列化器(PairSerializer)

将 Pair 序列化为标准 JSON 对象格式(含 "left" 和 "right" 字段):

public final class PairSerializer extends JsonSerializer<pair> {
    @Override
    public void serialize(Pair value, JsonGenerator gen, SerializerProvider serializers) 
            throws IOException {
        gen.writeStartObject();
        gen.writeObjectField("left", value.getLeft());
        gen.writeObjectField("right", value.getRight());
        gen.writeEndObject();
    }
}</pair>

2. 自定义反序列化器(PairDeserializer)

⚠️ 注意:原始答案中的 PairDeserializer 存在严重缺陷——它错误假设输入 JSON 是扁平结构(如 { "1": 4 }),但实际 leafDistribution 中的值是 嵌套的 Map(例如 "D_a": { "1": 4 }),而 Pair 的语义应为 (key, value) 对。因此,真实场景中 Pair 并不适合作为该字段类型;更合理的建模应为 Map> 或使用专用 DTO。

AI舌诊面诊问诊医疗系统+诊疗商城系统源码
AI舌诊面诊问诊医疗系统+诊疗商城系统源码

AI 舌诊面诊问诊医疗系统 + 诊疗商城系统源码是一套结合 AI 辅助诊断与商品转化的健康类程序,基于浩创云、ThinkPHP(PHP)开发,支持微信服务号与 H5 端,适合做中医舌诊面诊问答、健康建议推送以及配套诊疗商品的运营。

下载

但若坚持使用 Pair 表示单个键值对(如 "1": 4 → Pair.of("1", 4)),则反序列化器需正确解析 JSON Object 的首个键值对:

public final class PairDeserializer extends JsonDeserializer<pair integer>> {
    @Override
    public Pair<string integer> deserialize(JsonParser p, DeserializationContext ctxt) 
            throws IOException {
        JsonNode node = p.getCodec().readTree(p);
        if (node.isObject() && node.size() == 1) {
            Iterator<map.entry jsonnode>> fields = node.fields();
            if (fields.hasNext()) {
                Map.Entry<string jsonnode> entry = fields.next();
                String key = entry.getKey();
                Integer value = entry.getValue().asInt();
                return MutablePair.of(key, value);
            }
        }
        throw new JsonParseException(p, "Expected single-entry object for Pair<string>");
    }
}</string></string></map.entry></string></pair>

✅ 提示:泛型建议明确为 Pair,避免原始类型擦除带来的类型安全风险。

3. 注册到 ObjectMapper

ObjectMapper objectMapper = new ObjectMapper();
SimpleModule module = new SimpleModule();
module.addSerializer(Pair.class, new PairSerializer());
module.addDeserializer(Pair.class, new PairDeserializer());
objectMapper.registerModule(module);

⚠️ 关键注意事项

  • Pair 不是 JSON 原生结构:它本质是内存中的二元组,强制映射易引发歧义(如 JSON Object 多键时如何处理?)。生产环境推荐改用明确语义的 POJO,例如:
    public class LeafEntry {
        private String key;
        private Integer value;
        // constructor, getters...
    }
    // 对应字段改为:Map<string list>> leafDistribution;</string>
  • Mixin 不适用于抽象基类:为 Pair 定义 Mixin 无效,因其无运行时类型信息,Jackson 无法自动绑定;必须通过 @JsonDeserialize(as=...) 在具体使用位置(如字段或 getter)标注,或全局注册 deserializer。
  • 线程安全:ObjectMapper 实例应复用(它是线程安全的),避免每次请求新建。

✅ 总结

解决 Pair 的 Jackson 反序列化问题,本质是补全 Jackson 的类型绑定链:声明目标类型 → 指定具体实现类 → 提供序列化/反序列化逻辑 → 注册到 ObjectMapper。尽管技术上可行,但应优先评估是否真需引入第三方元组类型;清晰、可读、可维护的领域模型(POJO)永远优于“巧用”通用工具类。

相关专题

更多
java
java

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

2023.06.15

12237

6

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

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

2023.07.05

9322

9

java自学难吗
java自学难吗

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

2023.07.31

7952

8

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

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

2023.08.01

1284

3

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

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

2023.08.02

1028

3

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

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

2023.08.02

1536

5

java有什么用
java有什么用

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

2023.08.02

3209

5

java在线网站
java在线网站

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

2023.08.03

20451

3

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

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1395

8

热门下载

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

精品课程

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