0

0

使用Jackson忽略特定类型及其数组/集合属性进行深度克隆

花韻仙語

花韻仙語

发布时间:2025-10-14 10:07:51

|

887人浏览过

|

来源于php中文网

原创

使用jackson忽略特定类型及其数组/集合属性进行深度克隆

本文旨在探讨在Java Spring Boot应用中,如何利用Jackson `ObjectMapper`的`addMixIn`功能,实现对DTO中非序列化字段(特别是`MultipartFile`及其数组类型)的深度克隆,而无需修改原始DTO定义。通过注入`@JsonIgnoreType`注解,可以有效避免因非序列化属性导致的异常,从而顺利完成对象复制。

在现代Java应用开发中,尤其是在Spring Boot环境下处理HTTP请求时,我们经常需要对数据传输对象(DTOs)进行深度克隆。然而,当DTOs包含一些非序列化字段,例如org.springframework.web.multipart.MultipartFile时,传统的序列化/反序列化(如使用ObjectOutputStream)方法会失败。更具挑战性的是,我们有时无法控制这些DTO的源码,因此无法通过添加transient关键字来直接忽略这些字段。

Jackson ObjectMapper提供了一种强大的机制来解决这类问题:addMixIn()方法结合注解。这种方法允许我们在不修改原始类定义的情况下,为类注入Jackson的序列化/反序列化行为。

使用Jackson addMixIn 忽略特定类型

核心思路是创建一个空的接口或抽象类作为“混入”(MixIn)类,并使用Jackson的@JsonIgnoreType注解标记它。然后,通过ObjectMapper将这个混入类应用到需要忽略的类型上。

首先,定义一个带有@JsonIgnoreType注解的混入类:

import com.fasterxml.jackson.annotation.JsonIgnoreType;

@JsonIgnoreType
class JacksonMixInForIgnoreType {}

接着,在执行深度克隆的方法中,配置ObjectMapper来使用这个混入类。例如,要忽略单个MultipartFile类型的字段:

SoftGist
SoftGist

SoftGist是一个软件工具目录站,每天为您带来最好、最令人兴奋的软件新产品。

下载
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.web.multipart.MultipartFile;

public class DtoCloner {

    private Object makeClone(Object obj) {
        ObjectMapper mapper = new ObjectMapper();
        // 忽略单个 MultipartFile 类型的字段
        mapper.addMixIn(MultipartFile.class, JacksonMixInForIgnoreType.class);
        try {
            return mapper.readValue(mapper.writeValueAsString(obj), obj.getClass());
        } catch (JsonProcessingException e) {
            throw new RuntimeException("Failed to deep clone object", e);
        }
    }

    @JsonIgnoreType
    static class JacksonMixInForIgnoreType {} // 内部类需要是静态的,或者单独定义
}

上述代码通过将JacksonMixInForIgnoreType混入到MultipartFile.class中,告诉Jackson在序列化和反序列化过程中完全忽略MultipartFile类型的对象。

忽略特定类型的数组或集合

上述方法对于单个MultipartFile字段是有效的。然而,当DTO中包含MultipartFile[](即MultipartFile数组)这样的字段时,仅忽略MultipartFile.class是不够的。Jackson在处理数组时,仍然会尝试序列化数组的元素,导致出现InvalidDefinitionException,因为它无法序列化MultipartFile内部的某些属性(例如inputStream中的fd)。

为了解决这个问题,我们需要显式地为数组类型也添加混入配置

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.web.multipart.MultipartFile;

public class DtoCloner {

    private Object makeClone(Object obj) {
        ObjectMapper mapper = new ObjectMapper();
        // 忽略单个 MultipartFile 类型的字段
        mapper.addMixIn(MultipartFile.class, JacksonMixInForIgnoreType.class);
        // 显式忽略 MultipartFile 数组类型
        mapper.addMixIn(MultipartFile[].class, JacksonMixInForIgnoreType.class);
        try {
            return mapper.readValue(mapper.writeValueAsString(obj), obj.getClass());
        } catch (JsonProcessingException e) {
            throw new RuntimeException("Failed to deep clone object", e);
        }
    }

    @JsonIgnoreType
    static class JacksonMixInForIgnoreType {}
}

通过添加mapper.addMixIn(MultipartFile[].class, JacksonMixInForIgnoreType.class);,Jackson现在会完全忽略MultipartFile类型的数组,从而避免了序列化异常。

注意事项与局限性

  1. 集合类型(如List)的挑战: 与数组不同,直接为泛型集合类型(如List)添加混入配置通常无法通过addMixIn()实现类似的效果。Jackson在处理List时,通常会通过List.class进行处理,而不会直接识别List这种具体的泛型类型。这意味着,如果你的DTO中包含List字段,上述方法可能无法直接忽略整个列表。对于这种情况,可能需要考虑以下策略:

    • 自定义序列化器/反序列化器:为List.class注册一个自定义的序列化器,并在其中判断元素类型。
    • @JsonIgnore注解:如果可以修改DTO,直接在List字段上添加@JsonIgnore注解是最直接的解决方案。
    • DTO结构调整:考虑将非序列化集合字段从需要深度克隆的DTO中分离出来,或使用一个不包含这些字段的中间DTO进行克隆。
  2. 性能考量: 深度克隆操作本身涉及对象的序列化和反序列化,这可能比简单的对象引用复制或字段赋值更耗费资源。在对性能敏感的场景下,应仔细评估其影响。

  3. Jackson版本兼容性: 本文示例基于Jackson Databind 2.13.1版本。不同版本的Jackson可能在API行为或异常处理上存在细微差异,请根据实际使用的版本进行测试。

总结

通过Jackson ObjectMapper的addMixIn()方法结合@JsonIgnoreType注解,我们可以在不修改原始DTO定义的情况下,灵活地控制对象的序列化行为。这种方法对于处理包含MultipartFile等非序列化字段的DTOs(包括其数组形式)进行深度克隆非常有效,是Spring Boot应用中一个实用的技巧。然而,对于泛型集合类型,其处理方式略有不同,需要开发者根据具体场景选择合适的策略。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

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

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

114

2025.08.06

Java Spring Security 与认证授权
Java Spring Security 与认证授权

本专题系统讲解 Java Spring Security 框架在认证与授权中的应用,涵盖用户身份验证、权限控制、JWT与OAuth2实现、跨站请求伪造(CSRF)防护、会话管理与安全漏洞防范。通过实际项目案例,帮助学习者掌握如何 使用 Spring Security 实现高安全性认证与授权机制,提升 Web 应用的安全性与用户数据保护。

29

2026.01.26

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应用程序等。

390

2023.10.12

Java Spring Boot开发
Java Spring Boot开发

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

70

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 应用的流行工具。

34

2025.12.22

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

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

135

2025.12.24

硬盘接口类型介绍
硬盘接口类型介绍

硬盘接口类型有IDE、SATA、SCSI、Fibre Channel、USB、eSATA、mSATA、PCIe等等。详细介绍:1、IDE接口是一种并行接口,主要用于连接硬盘和光驱等设备,它主要有两种类型:ATA和ATAPI,IDE接口已经逐渐被SATA接口;2、SATA接口是一种串行接口,相较于IDE接口,它具有更高的传输速度、更低的功耗和更小的体积;3、SCSI接口等等。

1126

2023.10.19

俄罗斯Yandex引擎入口
俄罗斯Yandex引擎入口

2026年俄罗斯Yandex搜索引擎最新入口汇总,涵盖免登录、多语言支持、无广告视频播放及本地化服务等核心功能。阅读专题下面的文章了解更多详细内容。

158

2026.01.28

热门下载

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

精品课程

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

共23课时 | 3万人学习

C# 教程
C# 教程

共94课时 | 7.8万人学习

Java 教程
Java 教程

共578课时 | 52.6万人学习

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

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