0

0

如何在 Jackson 中实现 Set 的空值与空集合双向转换

霞舞

霞舞

发布时间:2026-01-09 19:13:34

|

521人浏览过

|

来源于php中文网

原创

如何在 Jackson 中实现 Set 的空值与空集合双向转换

本文介绍如何通过自定义序列化器和反序列化转换器,使 jackson 将 null set 序列化为 [],并将空数组 [] 反序列化为 null,同时保持非空集合的默认行为。

在 Jackson 中统一处理集合类(如 Set、List)的空值语义是一个常见但易被误解的需求:业务上常需将 null 集合序列化为 JSON 空数组 [](提升 API 兼容性与前端友好性),而将接收到的空数组 [] 显式还原为 null(以区分“未提供”与“明确提供空集合”)。直接继承 StdDeserializer> 并不可行——因为 JsonNode 不支持 asSet(),且标准反序列化流程在进入 deserialize() 前已将 JSON 数组解析为具体集合实例,无法在“集合容器层”拦截。

正确解法是分层协作

  • 序列化层:使用 JsonSerializer 拦截所有 null Collection,强制输出 [];
  • 反序列化层:不重写 Deserializer,而是通过 StdConverter 在反序列化完成后对结果做后处理(将空集合转为 null);
  • 注册机制:利用 JacksonAnnotationIntrospector 全局生效,或通过 @JsonSerialize / @JsonDeserialize 注解按字段定制。

以下为完整可运行示例(基于 Jackson 2.15+ 和 Spring Boot 常用工具类):

// 全局空集合处理器:自动为所有 Collection 类型启用 null ↔ []
public class EmptyAsNullCollectionJacksonAnnotationIntrospector extends JacksonAnnotationIntrospector {
    @Override
    public Object findNullSerializer(Annotated a) {
        if (Collection.class.isAssignableFrom(a.getRawType())) {
            return NullAsEmptyCollectionJsonSerializer.INSTANCE;
        }
        return super.findNullSerializer(a);
    }

    @Override
    public Object findDeserializationConverter(Annotated a) {
        if (List.class.isAssignableFrom(a.getRawType())) {
            return EmptyListAsNullConverter.INSTANCE;
        }
        if (Set.class.isAssignableFrom(a.getRawType())) {
            return EmptySetAsNullConverter.INSTANCE;
        }
        return super.findDeserializationConverter(a);
    }
}

// 序列化器:所有 null 集合 → []
class NullAsEmptyCollectionJsonSerializer extends JsonSerializer {
    public static final NullAsEmptyCollectionJsonSerializer INSTANCE = new NullAsEmptyCollectionJsonSerializer();
    @Override
    public void serialize(Object value, JsonGenerator gen, SerializerProvider serializers) throws IOException {
        gen.writeStartArray();
        gen.writeEndArray();
    }
}

// 转换器:空 Set → null(反序列化后调用)
class EmptySetAsNullConverter extends StdConverter, Set> {
    public static final EmptySetAsNullConverter INSTANCE = new EmptySetAsNullConverter();
    @Override
    public Set convert(Set value) {
        return CollectionUtils.isEmpty(value) ? null : value;
    }
}

// 同理支持 List(可选)
class EmptyListAsNullConverter extends StdConverter, List> {
    public static final EmptyListAsNullConverter INSTANCE = new EmptyListAsNullConverter();
    @Override
    public List convert(List value) {
        return CollectionUtils.isEmpty(value) ? null : value;
    }
}

使用方式一:全局配置(推荐)

var mapper = JsonMapper.builder()
    .enable(SerializationFeature.INDENT_OUTPUT)
    .annotationIntrospector(new EmptyAsNullCollectionJacksonAnnotationIntrospector())
    .build();

使用方式二:字段级注解(更灵活)

堆友
堆友

Alibaba Design打造的设计师全成长周期服务平台,旨在成为设计师的好朋友

下载
public class CollectionsPojo {
    @JsonSerialize(nullsUsing = NullAsEmptyCollectionJsonSerializer.class)
    @JsonDeserialize(converter = EmptySetAsNullConverter.class)
    private Set tags;

    @JsonSerialize(nullsUsing = NullAsEmptyCollectionJsonSerializer.class)
    @JsonDeserialize(converter = EmptyListAsNullConverter.class)
    private List ids;
}

效果验证

  • nullSet → "nullSet": [](序列化)→ 反序列化后为 null;
  • emptySet = Set.of() → "emptySet": [] → 反序列化后为 null;
  • setOfOne = Set.of("A") → "setOfOne": ["A"] → 反序列化后仍为 ["A"]。

⚠️ 注意事项

  • StdConverter 是反序列化后置处理,不影响原始解析逻辑,因此安全可靠;
  • findNullSerializer 仅作用于 null 值,不干扰非空集合的默认序列化;
  • 若项目中已存在自定义 AnnotationIntrospector,需合并逻辑而非直接替换;
  • CollectionUtils.isEmpty() 同时兼容 null 和空集合,是安全判断首选。

此方案兼顾简洁性、可维护性与扩展性,无需侵入业务代码,即可统一治理集合空值语义。

相关专题

更多
spring框架介绍
spring框架介绍

本专题整合了spring框架相关内容,想了解更多详细内容,请阅读专题下面的文章。

102

2025.08.06

spring boot框架优点
spring boot框架优点

spring boot框架的优点有简化配置、快速开发、内嵌服务器、微服务支持、自动化测试和生态系统支持。本专题为大家提供spring boot相关的文章、下载、课程内容,供大家免费下载体验。

135

2023.09.05

spring框架有哪些
spring框架有哪些

spring框架有Spring Core、Spring MVC、Spring Data、Spring Security、Spring AOP和Spring Boot。详细介绍:1、Spring Core,通过将对象的创建和依赖关系的管理交给容器来实现,从而降低了组件之间的耦合度;2、Spring MVC,提供基于模型-视图-控制器的架构,用于开发灵活和可扩展的Web应用程序等。

389

2023.10.12

Java Spring Boot开发
Java Spring Boot开发

本专题围绕 Java 主流开发框架 Spring Boot 展开,系统讲解依赖注入、配置管理、数据访问、RESTful API、微服务架构与安全认证等核心知识,并通过电商平台、博客系统与企业管理系统等项目实战,帮助学员掌握使用 Spring Boot 快速开发高效、稳定的企业级应用。

68

2025.08.19

Java Spring Boot 4更新教程_Java Spring Boot 4有哪些新特性
Java Spring Boot 4更新教程_Java Spring Boot 4有哪些新特性

Spring Boot 是一个基于 Spring 框架的 Java 开发框架,它通过 约定优于配置的原则,大幅简化了 Spring 应用的初始搭建、配置和开发过程,让开发者可以快速构建独立的、生产级别的 Spring 应用,无需繁琐的样板配置,通常集成嵌入式服务器(如 Tomcat),提供“开箱即用”的体验,是构建微服务和 Web 应用的流行工具。

25

2025.12.22

Java Spring Boot 微服务实战
Java Spring Boot 微服务实战

本专题深入讲解 Java Spring Boot 在微服务架构中的应用,内容涵盖服务注册与发现、REST API开发、配置中心、负载均衡、熔断与限流、日志与监控。通过实际项目案例(如电商订单系统),帮助开发者掌握 从单体应用迁移到高可用微服务系统的完整流程与实战能力。

113

2025.12.24

json数据格式
json数据格式

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

408

2023.08.07

json是什么
json是什么

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

532

2023.08.23

c++主流开发框架汇总
c++主流开发框架汇总

本专题整合了c++开发框架推荐,阅读专题下面的文章了解更多详细内容。

3

2026.01.09

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 8.2万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 3.1万人学习

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

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