
在spring boot应用中,当需要深度克隆包含非序列化字段(如`multipartfile`及其数组)的dto时,传统的`objectoutputstream`方法不可行。本文将探讨如何利用jackson的`objectmapper`和`addmixin`机制,巧妙地忽略这些不可控dto中的特定类型数组属性,从而实现dto的顺利克隆,并指出处理集合类型时的局限性。
背景与挑战
在开发过程中,我们经常需要对DTO(数据传输对象)进行深度克隆,例如在处理请求参数时。然而,当DTO中包含如org.springframework.web.multipart.MultipartFile这类非序列化接口的字段时,传统的Java序列化(ObjectOutputStream和ObjectInputStream)方法会失效。更具挑战性的是,有时我们无法修改这些DTO的定义,例如通过添加transient关键字或@JsonIgnore注解来排除字段。
Jackson库提供了一种灵活的解决方案,即通过ObjectMapper的addMixIn()方法结合@JsonIgnoreType注解,在不修改原始类定义的情况下,指示Jackson忽略特定类型的字段。
初始尝试与局限
为了忽略DTO中的MultipartFile字段,我们可能会尝试以下Jackson配置:
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 {
private Object makeClone(Object obj) {
ObjectMapper mapper = new ObjectMapper();
// 添加针对 MultipartFile 类型的 MixIn
mapper.addMixIn(MultipartFile.class, JacksonMixInForIgnoreType.class);
try {
// 将对象序列化为JSON字符串,再反序列化回对象
return mapper.readValue(mapper.writeValueAsString(obj), obj.getClass());
} catch (JsonProcessingException e) {
throw new RuntimeException("DTO克隆失败", e);
}
}
// 定义一个空的 MixIn 接口或类,并用 @JsonIgnoreType 标记
@JsonIgnoreType
static class JacksonMixInForIgnoreType {}
// 示例DTO,可能包含 MultipartFile 字段
static class DeepCopyDto {
private String name;
private MultipartFile singleFile;
// ... 其他字段
}
}上述代码对于DTO中包含单个MultipartFile字段的情况通常是有效的。然而,当DTO中包含MultipartFile的数组,例如MultipartFile[] fileArray;时,这种策略会失败,并抛出InvalidDefinitionException异常,指出无法找到java.io.FileDescriptor的序列化器,错误信息大致如下:
com.fasterxml.jackson.databind.exc.InvalidDefinitionException: No serializer found for class java.io.FileDescriptor ... (through reference chain: com.example.uploadingfiles.DeepCopyDto["fileArray"]->org.springframework.web.multipart.support.StandardMultipartHttpServletRequest$StandardMultipartFile[0]->org.springframework.web.multipart.support.StandardMultipartHttpServletRequest$StandardMultipartFile["inputStream"]->java.io.FileInputStream["fd"])
这表明Jackson在处理数组类型时,并未将MultipartFile[]视为与MultipartFile相同的类型进行忽略,而是尝试深入数组内部,最终遇到无法序列化的底层IO流对象。
解决方案:明确指定数组类型的MixIn
问题的根源在于Jackson在应用MixIn时,将MultipartFile和MultipartFile[]视为两种不同的类型。因此,要忽略MultipartFile数组,我们需要为数组类型本身也添加一个MixIn。
修正后的makeClone方法如下:
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 {
private Object makeClone(Object obj) {
ObjectMapper mapper = new ObjectMapper();
// 1. 添加针对 MultipartFile 类型的 MixIn
mapper.addMixIn(MultipartFile.class, JacksonMixInForIgnoreType.class);
// 2. 额外添加针对 MultipartFile 数组类型的 MixIn
mapper.addMixIn(MultipartFile[].class, JacksonMixInForIgnoreType.class); // 关键改动
try {
return mapper.readValue(mapper.writeValueAsString(obj), obj.getClass());
} catch (JsonProcessingException e) {
throw new RuntimeException("DTO克隆失败", e);
}
}
@JsonIgnoreType
static class JacksonMixInForIgnoreType {}
// 示例DTO,现在可以包含 MultipartFile 数组
static class DeepCopyDto {
private String name;
private MultipartFile singleFile;
private MultipartFile[] fileArray; // 包含 MultipartFile 数组
// ... 其他字段
}
}通过在ObjectMapper中额外添加一行mapper.addMixIn(MultipartFile[].class, JacksonMixInForIgnoreType.class);,我们明确告诉Jackson:当遇到MultipartFile类型或MultipartFile数组类型时,都应该应用JacksonMixInForIgnoreType,从而忽略这些字段的序列化。
注意事项与局限性
- 类型匹配的精确性: Jackson的addMixIn机制要求精确匹配类型。MultipartFile和MultipartFile[]在JVM中是不同的类型,因此需要分别配置。
-
集合类型(如List
): 值得注意的是,上述方法对于泛型集合类型(如List)并不直接适用。addMixIn无法直接应用于List.class来忽略其内部特定泛型元素。要忽略List 字段,如果可以修改DTO,最佳实践是直接在该字段上使用@JsonIgnore注解。如果DTO不可控,可能需要更复杂的自定义序列化器或反序列化器来处理,或者在克隆前手动将这些字段置空。 - 性能考量: 深度克隆涉及对象的序列化和反序列化,对于大型或复杂的对象图,这可能带来一定的性能开销。在性能敏感的场景下,应权衡其利弊或考虑其他克隆策略(如手动属性拷贝)。
- Jackson版本: 本文示例基于Jackson Databind 2.13.1。不同版本可能存在细微差异,但核心机制通常保持一致。
总结
当需要深度克隆包含不可控的非序列化类型(如MultipartFile)及其数组的DTO时,Jackson的ObjectMapper结合addMixIn提供了一个强大的解决方案。关键在于理解Jackson对类型匹配的精确性要求,并为原始类型及其数组类型分别配置MixIn。然而,对于泛型集合类型,此方法存在局限性,通常需要结合其他策略来解决。掌握这些技巧,能够帮助开发者在处理复杂DTO克隆场景时更加灵活和高效。










