Jackson DTO深度复制：非侵入式忽略特定类型及其数组字段

本文探讨了在使用jackson进行dto深度复制时，如何非侵入式地忽略非序列化字段，特别是当这些字段是特定类型的数组时。通过`objectmapper#addmixin()`和`@jsonignoretype`，可以灵活地排除如`multipartfile`及其数组`multipartfile[]`等类型，从而避免序列化异常，实现dto的顺利克隆。文章也指出了对泛型集合（如`list`）的局限性。

在现代Java应用开发，尤其是在Spring Boot框架下，数据传输对象（DTO）的深度复制是一个常见的需求。例如，在处理Web请求时，我们可能需要对包含用户上传文件（如MultipartFile）的DTO进行复制，以便进行后续处理或状态快照。然而，MultipartFile这类对象通常是非序列化的，直接使用ObjectOutputStream和ObjectInputStream进行克隆会导致NotSerializableException。

当DTO类定义不可修改时（即无法添加transient关键字或@JsonIgnore注解），Jackson的ObjectMapper提供了一种强大的非侵入式解决方案：Mix-in机制。

Jackson Mix-in 机制概述

Jackson的Mix-in机制允许我们在不修改目标类源代码的情况下，为其添加或覆盖Jackson的序列化/反序列化行为。这通过将一个“Mix-in”接口或抽象类映射到目标类上来实现。Mix-in类可以包含任何Jackson注解，这些注解将被视为目标类的一部分。

要忽略一个特定类型的字段，我们可以定义一个带有@JsonIgnoreType注解的空Mix-in类，并将其应用到目标类型上。@JsonIgnoreType注解指示Jackson完全忽略该类型及其所有实例的序列化和反序列化。

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

// 定义一个Mix-in接口，用于忽略特定类型
@JsonIgnoreType
abstract class JacksonMixInForIgnoreType {}

忽略单个特定类型字段

假设我们的DTO中包含一个MultipartFile类型的字段。我们可以通过ObjectMapper#addMixIn()方法将JacksonMixInForIgnoreType映射到MultipartFile.class上。

public class DtoCloner {

    private Object makeClone(Object obj) {
        ObjectMapper mapper = new ObjectMapper();
        // 将JacksonMixInForIgnoreType应用到MultipartFile类，使其被忽略
        mapper.addMixIn(MultipartFile.class, JacksonMixInForIgnoreType.class);
        try {
            // 先序列化为JSON字符串，再反序列化回对象，实现深度复制
            return mapper.readValue(mapper.writeValueAsString(obj), obj.getClass());
        } catch (JsonProcessingException e) {
            throw new RuntimeException("DTO cloning failed", e);
        }
    }

    // ... 其他方法
}

这种方法对于DTO中包含单个MultipartFile字段的情况非常有效。当Jackson尝试序列化obj时，遇到MultipartFile类型的字段，会根据Mix-in配置直接忽略它，从而避免了序列化异常。

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

然而，当DTO中包含MultipartFile[]（MultipartFile数组）类型的字段时，上述策略会失效。Jackson在序列化数组时，会尝试序列化数组中的每个元素。由于我们只对MultipartFile.class添加了Mix-in，而MultipartFile[]本身是一个不同的类型（数组类型），Jackson会尝试序列化数组中的MultipartFile实例，最终仍然抛出InvalidDefinitionException，因为它无法找到MultipartFile内部某些非序列化字段（如inputStream中的FileDescriptor）的序列化器。

怪兽AI数字人

数字人短视频创作，数字人直播，实时驱动数字人

44

查看详情

为了解决这个问题，我们需要为数组类型本身也添加一个Mix-in。这意味着，如果一个DTO包含MultipartFile[] fileArray;这样的字段，我们不仅要忽略MultipartFile.class，还要明确忽略MultipartFile[].class。

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("DTO cloning failed", e);
        }
    }

    // 定义一个Mix-in接口，用于忽略特定类型
    @JsonIgnoreType
    abstract class JacksonMixInForIgnoreType {}
}

通过同时为MultipartFile.class和MultipartFile[].class添加JacksonMixInForIgnoreType，Jackson在遇到这两种类型时都会直接忽略它们，从而成功地实现了DTO的深度复制。

关于集合类型字段的注意事项 (如 List<MultipartFile>)

值得注意的是，这种addMixIn策略对于泛型集合（如List<MultipartFile>、Set<MultipartFile>）的直接忽略并不适用。Jackson的Mix-in机制主要作用于具体的类或接口类型。List<MultipartFile>在运行时是一个List类型，而其泛型参数MultipartFile在类型擦除后并不直接参与Mix-in的类型匹配。

这意味着，即使你尝试mapper.addMixIn(List.class, JacksonMixInForIgnoreType.class)，这只会忽略所有的List实例，这通常不是我们期望的行为，因为它会忽略所有列表，而不仅仅是包含MultipartFile的列表。目前，通过ObjectMapper#addMixIn()没有直接的、通用的方法来忽略特定泛型参数的集合类型。对于这类情况，可能需要考虑其他策略，例如在DTO层面使用@JsonIgnore（如果DTO可修改），或者编写自定义的序列化器/反序列化器来处理包含这些特定集合的字段。

完整示例代码

以下是一个包含上述所有关键点的完整示例代码，展示了如何使用Jackson进行DTO的深度复制，并忽略MultipartFile及其数组：

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

import java.io.ByteArrayInputStream;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.util.Arrays;

/**
 * 演示如何使用Jackson进行DTO深度复制，并忽略特定

以上就是Jackson DTO深度复制：非侵入式忽略特定类型及其数组字段的详细内容，更多请关注php中文网其它相关文章！