利用Jackson忽略DTO中特定类型及其数组的非可序列化字段-java教程-PHP中文网

利用jackson忽略dto中特定类型及其数组的非可序列化字段

本文探讨了在Spring Boot应用中，使用Jackson ObjectMapper 克隆包含非可序列化字段（如 MultipartFile）的DTOs时遇到的挑战。针对无法修改DTOs源文件的情况，我们介绍了如何通过 addMixIn 方法结合 @JsonIgnoreType 注解，有效忽略单个 MultipartFile 字段及其 MultipartFile[] 数组。文章详细阐述了针对数组类型需单独配置 addMixIn 的关键点，并提供了示例代码，帮助开发者在不修改DTO定义的前提下，实现安全的DTO深拷贝。

背景与挑战

在Spring Boot等Web应用开发中，DTO（Data Transfer Object）常用于数据传输。有时，我们需要对这些DTO进行深拷贝或克隆，例如在业务逻辑处理前保留原始数据，或在不同层之间传递独立的数据副本。一种常见的克隆策略是利用Java的序列化机制，如 ObjectOutputStream 和 ObjectInputStream。然而，当DTO中包含非 Serializable 字段（例如 org.springframework.web.multipart.MultipartFile，它通常用于文件上传）时，这种方法便不再适用，会抛出 NotSerializableException。

更具挑战性的是，我们可能无法控制这些DTO的源代码，这意味着我们不能直接添加 transient 关键字来忽略这些字段，也不能直接在字段上使用Jackson的 @JsonIgnore 注解。在这种限制下，我们需要一种外部配置的方式来告诉Jackson在序列化/反序列化过程中忽略特定类型的字段。

Jackson addMixIn 的初步应用

Jackson库提供了一种强大的机制——MixIn 注解，允许我们为已存在的类添加Jackson相关的注解，而无需修改原始类的源代码。这对于处理第三方库中的类或无法修改的DTOs非常有用。

为了忽略单个 MultipartFile 字段，我们可以定义一个空的 MixIn 接口或类，并用 @JsonIgnoreType 注解标记它，然后通过 ObjectMapper 的 addMixIn 方法将其应用到 MultipartFile.class：

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

public class DtoCloner {

    // 定义一个空的MixIn类，并用@JsonIgnoreType标记
    @JsonIgnoreType
    static class JacksonMixInForIgnoreType {}

    /**
     * 使用Jackson ObjectMapper克隆对象，忽略特定类型。
     * @param obj 待克隆的对象
     * @return 克隆后的对象
     * @throws RuntimeException 如果克隆过程中发生JSON处理异常
     */
    public Object makeClone(Object obj) {
        ObjectMapper mapper = new ObjectMapper();
        // 将MixIn应用到MultipartFile类，使其在序列化时被忽略
        mapper.addMixIn(MultipartFile.class, JacksonMixInForIgnoreType.class);

        try {
            // 先序列化为JSON字符串，再反序列化回对象
            String json = mapper.writeValueAsString(obj);
            return mapper.readValue(json, obj.getClass());
        } catch (JsonProcessingException e) {
            // 捕获并包装JSON处理异常
            throw new RuntimeException("Failed to clone object using Jackson", e);
        }
    }

    // 假设存在一个DTO类，其中包含MultipartFile字段
    public static class DeepCopyDto {
        private String name;
        private MultipartFile singleFile;
        // ... 其他字段

        public DeepCopyDto(String name, MultipartFile singleFile) {
            this.name = name;
            this.singleFile = singleFile;
        }

        // Getter/Setter省略
        public String getName() { return name; }
        public MultipartFile getSingleFile() { return singleFile; }
    }

    public static void main(String[] args) {
        // 示例用法
        // 注意：这里需要一个MultipartFile的实现，例如MockMultipartFile
        // MockMultipartFile mockFile = new MockMultipartFile("test", "hello.txt", "text/plain", "Hello World".getBytes());
        // DeepCopyDto originalDto = new DeepCopyDto("TestDto", mockFile);
        // DtoCloner cloner = new DtoCloner();
        // DeepCopyDto clonedDto = (DeepCopyDto) cloner.makeClone(originalDto);
        // System.out.println("Cloned DTO name: " + clonedDto.getName());
        // System.out.println("Cloned DTO singleFile: " + clonedDto.getSingleFile()); // 应该为null或被忽略
    }
}

登录后复制

上述代码对于DTO中包含 MultipartFile singleFile; 这样的单个字段是有效的。当Jackson尝试序列化 DeepCopyDto 时，会根据 addMixIn 的配置，直接忽略 singleFile 字段。

解决数组/集合类型字段的忽略问题

然而，当DTO中包含 MultipartFile[] fileArray; 这样的 MultipartFile 数组时，仅仅 mapper.addMixIn(MultipartFile.class, JacksonMixInForIgnoreType.class); 是不足以忽略整个数组的。Jackson在处理数组时，会尝试序列化数组的每个元素。如果数组元素类型本身是 MultipartFile，虽然单个 MultipartFile 被忽略了，但Jackson仍然会尝试处理数组结构本身，这可能导致在某些情况下，由于 MultipartFile 内部的非序列化属性（如 InputStream 的 FileDescriptor）而被触发序列化异常。

序列猴子开放平台

具有长序列、多模态、单模型、大数据等特点的超大规模语言模型

查看详情

为了正确忽略 MultipartFile[] 类型的字段，我们需要明确地将 MixIn 应用到数组类型本身：

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

public class DtoClonerWithArraySupport {

    @JsonIgnoreType
    static class JacksonMixInForIgnoreType {}

    /**
     * 使用Jackson ObjectMapper克隆对象，忽略特定类型及其数组类型。
     * @param obj 待克隆的对象
     * @return 克隆后的对象
     * @throws RuntimeException 如果克隆过程中发生JSON处理异常
     */
    public Object makeClone(Object obj) {
        ObjectMapper mapper = new ObjectMapper();
        // 忽略单个MultipartFile类型
        mapper.addMixIn(MultipartFile.class, JacksonMixInForIgnoreType.class);
        // 关键：同时忽略MultipartFile数组类型
        mapper.addMixIn(MultipartFile[].class, JacksonMixInForIgnoreType.class);

        try {
            String json = mapper.writeValueAsString(obj);
            return mapper.readValue(json, obj.getClass());
        } catch (JsonProcessingException e) {
            throw new RuntimeException("Failed to clone object using Jackson", e);
        }
    }

    // 假设存在一个DTO类，其中包含MultipartFile数组字段
    public static class DeepCopyDtoWithArray {
        private String name;
        private MultipartFile[] fileArray;

        public DeepCopyDtoWithArray(String name, MultipartFile[] fileArray) {
            this.name = name;
            this.fileArray = fileArray;
        }

        // Getter/Setter省略
        public String getName() { return name; }
        public MultipartFile[] getFileArray() { return fileArray; }
    }

    public static void main(String[] args) {
        // 示例用法 (需要MockMultipartFile)
        // MockMultipartFile mockFile1 = new MockMultipartFile("f1", "a.txt", "text/plain", "Content A".getBytes());
        // MockMultipartFile mockFile2 = new MockMultipartFile("f2", "b.txt", "text/plain", "Content B".getBytes());
        // MultipartFile[] files = {mockFile1, mockFile2};
        // DeepCopyDtoWithArray originalDto = new DeepCopyDtoWithArray("ArrayDto", files);
        // DtoClonerWithArraySupport cloner = new DtoClonerWithArraySupport();
        // DeepCopyDtoWithArray clonedDto = (DeepCopyDtoWithArray) cloner.makeClone(originalDto);
        // System.out.println("Cloned DTO name: " + clonedDto.getName());
        // System.out.println("Cloned DTO fileArray: " + clonedDto.getFileArray()); // 应该为null或被忽略
    }
}

登录后复制

通过同时配置 mapper.addMixIn(MultipartFile.class, JacksonMixInForIgnoreType.class); 和 mapper.addMixIn(MultipartFile[].class, JacksonMixInForIgnoreType.class);，我们能够确保无论是单个 MultipartFile 字段还是 MultipartFile 数组字段，都能够在Jackson的序列化过程中被有效忽略，从而避免 InvalidDefinitionException。

关于集合类型（如 List<MultipartFile>）的注意事项

值得注意的是，对于像 List<MultipartFile> 这样的泛型集合类型，直接使用 mapper.addMixIn(List.class, JacksonMixInForIgnoreType.class); 或 mapper.addMixIn(List<MultipartFile>.class, JacksonMixInForIgnoreType.class); 并不能达到忽略集合中特定类型元素的目的。Jackson处理泛型集合的方式与数组有所不同，它通常会序列化集合中的每个元素，而不是将集合本身作为一个整体来忽略。

在当前Jackson版本（如2.13.1）中，没有直接通过 addMixIn 机制来忽略特定泛型类型参数的集合的方法。如果需要忽略 List<MultipartFile>，可能需要更复杂的策略，例如：

自定义序列化器/反序列化器： 为 List<MultipartFile> 或包含该列表的DTO编写自定义的 JsonSerializer 和 JsonDeserializer，在其中手动跳过 MultipartFile 元素。
@JsonView： 如果你的DTO结构允许，可以通过定义不同的视图来控制哪些字段在特定场景下被序列化。
使用 JsonFilter： 通过 ObjectMapper 注册 SimpleFilterProvider 和 PropertyFilter 来动态过滤属性。

然而，这些方法通常比 addMixIn 更复杂，且超出了本文主要讨论的范围。对于 MultipartFile 及其数组类型，上述 addMixIn 方案是最直接且有效的。

总结

当需要克隆包含非可序列化字段（特别是 MultipartFile 及其数组）的DTO，且无法修改DTO源代码时，Jackson的 addMixIn 机制提供了一个优雅的解决方案。关键在于，不仅要为基类型（如 MultipartFile.class）应用 MixIn，也要为对应的数组类型（如 MultipartFile[].class）进行相同的配置。这确保了Jackson在序列化和反序列化过程中能够正确识别并忽略这些非可序列化字段，从而实现DTO的深拷贝而避免运行时异常。对于泛型集合，addMixIn 的直接应用存在局限性，可能需要考虑其他Jackson高级特性或自定义实现。

以上就是利用Jackson忽略DTO中特定类型及其数组的非可序列化字段的详细内容，更多请关注php中文网其它相关文章！