讲师中心 微信公众号

工具推荐

视频效率加速
AniShort
AniShort

AI短剧协同制作平台

updream

一键生成高质量推广成片

立刻MV
立刻MV

低成本歌曲 MV、视频生成

Seko
Seko

AI短剧一键生成成片

Jackson处理多别名JSON字段时优先选择非空值的策略与实践

风萱同学_7472

风萱同学_7472

发布时间:2025-12-05 17:39:14

|

543人浏览过

|

来源于php中文网

原创

Jackson处理多别名JSON字段时优先选择非空值的策略与实践

本教程旨在解决jackson反序列化中,当json数据包含多个别名字段且需优先选择其中非空值的问题。文章详细介绍了两种有效的策略:一是通过定义多个智能setter方法,利用`@jsonsetter`注解实现按需更新;二是通过自定义converter结合辅助pojo,将数据转换逻辑与领域模型分离。这两种方法都能实现灵活且健壮的数据映射,有效处理冗余数据,确保数据解析的准确性。

在处理来自第三方系统或存在历史遗留问题的JSON数据时,我们经常会遇到同一个逻辑字段在JSON中以多种名称(别名)出现的情况。更复杂的是,这些别名字段中可能只有一个包含有效的非空值,而其他字段则为null或空字符串。Jackson的@JsonAlias注解虽然能识别多个别名,但它通常无法智能地优先选择非空值,导致反序列化结果不符合预期。本文将深入探讨两种解决方案,帮助开发者在Jackson中实现这种智能的非空值优先选择机制。

方案一:利用智能Setter方法处理多别名与非空值选择

此方案的核心思想是为每个可能的别名定义一个独立的setter方法,并通过@JsonSetter注解将其映射到相应的JSON字段。所有这些setter方法最终都将调用一个核心的setter逻辑,该逻辑负责判断当前字段是否已经存在有效值(非空且非空字符串),并仅在当前字段为空时才接受新的值。

实现原理

  1. 定义核心Setter: 创建一个标准的setter方法,例如setName(String name)。在该方法内部,添加一个条件判断,只有当当前name字段为null或空字符串时,才将其更新为传入的新值。
  2. 定义别名Setter: 为每个别名(如full_name、fullName)创建额外的setter方法,例如setName1(String name)、setName2(String name)。这些方法也使用@JsonSetter注解分别映射到对应的JSON字段。
  3. 委托调用: 别名setter方法不包含业务逻辑,它们直接调用核心setter方法,将接收到的值传递过去。

示例代码

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

import java.util.Arrays;
import java.util.Objects;
import java.util.function.Predicate;

public class MyPojo {
    // 定义一个谓词,用于检查字符串是否为null或空
    public static final Predicate<String> NULL_OR_EMPTY = s -> s == null || s.isEmpty();

    private String name;

    // 核心setter,负责判断并更新字段
    @JsonSetter("name") // 映射到JSON字段"name"
    public void setName(String name) {
        // 只有当当前name字段为null或空时,才更新
        if (NULL_OR_EMPTY.test(this.name)) {
            this.name = name;
        }
    }

    // 别名setter 1,映射到JSON字段"full_name"
    @JsonSetter("full_name")
    public void setName1(String name) {
        setName(name); // 委托给核心setter
    }

    // 别名setter 2,映射到JSON字段"fullName"
    @JsonSetter("fullName")
    public void setName2(String name) {
        setName(name); // 委托给核心setter
    }

    // Getter方法
    public String getName() {
        return name;
    }

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

    public static void main(String[] args) throws Exception {
        // 示例JSON数据,其中"name"为null,"full_name"为空字符串,"fullName"为有效值
        String json = "{ \"name\" : null, \"full_name\" : \"\", \"fullName\" : \"name\"}";

        ObjectMapper mapper = new ObjectMapper();
        MyPojo myPojo = mapper.readValue(json, MyPojo.class);
        System.out.println(myPojo);

        // 示例2:第一个有效值
        json = "{ \"name\" : \"first\", \"full_name\" : \"\", \"fullName\" : \"name\"}";
        myPojo = mapper.readValue(json, MyPojo.class);
        System.out.println(myPojo);

        // 示例3:所有都为空或null
        json = "{ \"name\" : null, \"full_name\" : \"\", \"fullName\" : null}";
        myPojo = mapper.readValue(json, MyPojo.class);
        System.out.println(myPojo);
    }
}

输出:

MyPojo{name='name'}
MyPojo{name='first'}
MyPojo{name='null'}

注意事项与优缺点

  • 优点: 实现直接,易于理解和调试,无需引入额外的类。
  • 缺点:
    • 代码污染: 领域模型(POJO)中会增加多个冗余的setter方法,使得领域模型不再纯粹,可能违反单一职责原则。
    • 逻辑耦合: Setter方法中包含了数据校验和选择逻辑,而不是简单的赋值操作。
    • 扩展性差: 如果需要处理的别名数量很多,或者有多个字段需要类似处理,POJO会变得非常庞大和难以维护。

方案二:利用自定义Converter实现数据转换

为了保持领域模型的简洁和职责分离,我们可以采用自定义Converter的方式。这种方法将JSON解析为一个辅助POJO,该辅助POJO能够捕获所有别名字段的值。然后,通过一个Converter将这个辅助POJO转换为最终的领域POJO,并在转换过程中实现非空值的选择逻辑。

Json To Jianying Description
Json To Jianying Description

将包含oralBroadcastingList、materialList、bgmInfo等字段的JSON视频素材转换为剪映API可用的自然语言描述,用于生成视频制作指令,包括素材匹配、时间轴计算、字幕同步、特殊效果处理等。

下载

实现原理

  1. 创建辅助POJO: 定义一个临时的POJO(或Java Record),它包含所有可能的别名字段,并使用@JsonProperty将它们映射到JSON中的相应字段。这个POJO的任务仅仅是接收原始JSON数据。
  2. 创建自定义Converter: 继承StdConverter,其中SOURCE是辅助POJO,TARGET是最终的领域POJO。在convert方法中,实现从辅助POJO到目标POJO的转换逻辑,包括遍历所有别名字段并选择第一个非空/非空字符串的值。
  3. 关联Converter: 在最终的领域POJO上,使用@JsonDeserialize(converter = YourConverter.class)注解,告诉Jackson在反序列化时使用这个自定义Converter。

示例代码

import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.fasterxml.jackson.databind.util.StdConverter;

import lombok.Builder;
import lombok.Getter;
import lombok.ToString;

import java.util.Arrays;
import java.util.function.Predicate;

// 辅助POJO,用于接收所有可能的别名值
// 使用record可以简化代码
record AuxiliaryPojo(
    @JsonProperty("name") String name,
    @JsonProperty("full_name") String name1,
    @JsonProperty("fullName") String name2
) {}

// 自定义Converter,负责将AuxiliaryPojo转换为MyPojo
class AuxiliaryPojoToMyPojo extends StdConverter<AuxiliaryPojo, MyPojo> {
    // 定义一个谓词,用于检查字符串是否非null且非空
    public static final Predicate<String> NOT_NULL_OR_EMPTY = s -> s != null && !s.isEmpty();

    @Override
    public MyPojo convert(AuxiliaryPojo v) {
        // 从辅助POJO中找到第一个非null且非空的name值
        String selectedName = findMatching(v.name(), v.name1(), v.name2());
        // 构建最终的MyPojo实例
        return MyPojo.builder()
                .name(selectedName)
                .build();
    }

    // 辅助方法,用于从多个字符串中找到第一个非null且非空的字符串
    private String findMatching(String... args) {
        return Arrays.stream(args)
                .filter(NOT_NULL_OR_EMPTY)
                .findFirst() // 找到第一个匹配的
                .orElse(null); // 如果都没有匹配,则返回null
    }
}

// 最终的领域POJO,使用Lombok简化代码
@Getter
@Builder
@ToString
@JsonDeserialize(converter = AuxiliaryPojoToMyPojo.class) // 指定自定义Converter
public class MyPojo {
    private String name;

    public static void main(String[] args) throws Exception {
        // 示例JSON数据
        String json = "{ \"name\" : null, \"full_name\" : \"\", \"fullName\" : \"name\"}";

        ObjectMapper mapper = new ObjectMapper();
        MyPojo myPojo = mapper.readValue(json, MyPojo.class);
        System.out.println(myPojo);

        // 示例2:第一个有效值
        json = "{ \"name\" : \"first\", \"full_name\" : \"\", \"fullName\" : \"name\"}";
        myPojo = mapper.readValue(json, MyPojo.class);
        System.out.println(myPojo);

        // 示例3:所有都为空或null
        json = "{ \"name\" : null, \"full_name\" : \"\", \"fullName\" : null}";
        myPojo = mapper.readValue(json, MyPojo.class);
        System.out.println(myPojo);
    }
}

输出:

MyPojo(name=name)
MyPojo(name=first)
MyPojo(name=null)

注意事项与优缺点

  • 优点:
    • 职责分离: 领域POJO保持纯净,不包含任何与JSON解析或数据选择相关的逻辑。
    • 代码整洁: 转换逻辑集中在Converter中,易于管理和测试。
    • 可扩展性: 如果需要处理多个字段的别名选择,可以为每个字段创建独立的findMatching逻辑,或者将通用逻辑抽象出来。
  • 缺点:
    • 引入额外类: 需要额外定义一个辅助POJO和一个Converter类,增加了项目的类数量。
    • 概念开销: 对于初学者来说,理解Converter的工作机制可能需要一定时间。
    • 性能考量: 相比直接的setter方法,Converter会引入额外的对象创建(辅助POJO)和方法调用,但在大多数应用场景中,这种性能开销通常可以忽略不计。

总结

在Jackson处理多别名JSON字段并优先选择非空值的问题上,两种方案各有优势:

  • 智能Setter方法 简单直接,适用于别名数量不多、对领域模型侵入性要求不高的场景。它的缺点是可能导致POJO代码冗余和职责不清。
  • 自定义Converter 提供了更清晰的职责分离和更强的可维护性,特别适合于复杂的转换逻辑、别名字段较多或对领域模型纯净度有高要求的项目。虽然引入了额外的类,但从长远来看,它能使代码结构更优。

开发者应根据项目的具体需求、团队编码规范以及对代码整洁度的要求,选择最适合的解决方案。对于大型或复杂的系统,自定义Converter通常是更推荐的做法。

热门AI工具

更多
蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

小橡皮AI

一款AI工具,主要用于小橡皮一键去AI味,将机器味重的内容改得更有活人感,防止因为 AI 内容被平台打上 AI 标签,以及限流,适合需要提升相关任务效率的用户。

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

2375

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

3962

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

1316

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

4599

2025.09.10

string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

7719

2023.08.02

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

569

2023.09.22

java中null的用法
java中null的用法

在Java中,null表示一个引用类型的变量不指向任何对象。可以将null赋值给任何引用类型的变量,包括类、接口、数组、字符串等。想了解更多null的相关内容,可以阅读本专题下面的文章。

1698

2024.03.01

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

1958

2023.08.03

GoFrame框架Web开发与路由中间件
GoFrame框架Web开发与路由中间件

本专题聚焦GoFrame框架的Web开发,拆解路由注册与匹配规则、请求参数获取、参数校验与中间件执行顺序,说明统一响应、JWT鉴权、文件上传与接口文档生成的落地方式,并补充优雅重启与测试实践。

0

2026.11.17

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn