能否用Spring WebClient不加载文件到内存向JSON接口传文件？

目标接口定义 #

@PostMapping("/endpoint", consumes="application/json")
public ResponsePojo post(final @RequestBody UploadPojo uploadPojo) {
    ...
}

请求体对应类结构 #

public class UploadPojo {
    private String metadata;
    private List<InnerClass> innerList;
}

public class InnerClass {
    private String metadata;
    private byte[] data;
}

当前WebClient实现代码 #

// 创建基础WebClient
WebClient webClient = WebClient.builder()
    .baseUrl(myBaseUrl)
    .defaultHeaders(httpHeaders -> {
        httpHeaders.setContentType(MediaType.APPLICATION_JSON);
        ...
    })
    .clientConnector(new ReactorClientHttpConnector(client))
    .build();
    
// 执行上传
webClient.post()
    .uri("endpoint")
    .body(Mono.just(uploadPojo), UploadPojo.class)
    .retrieve()
    .bodyToMono(ResponsePojo.class);

当前实现需要把文件内容加载到byte[]存入内存，大文件场景下不仅耗时还会引发JVM内存问题，在无法修改接口的前提下，有没有办法避免将文件内容全量加载到内存？

解决方案：自定义JSON序列化器，流式处理文件内容 #

因为接口要求application/json格式，默认Jackson序列化会把byte[]一次性加载到内存再序列化，所以需要自定义序列化逻辑，让文件内容流式读取并序列化，而非提前全量加载。

1. 修改实体类字段类型 #

把InnerClass中的byte[] data替换为File类型（也可用Path或InputStream），避免提前加载文件：

public class InnerClass {
    private String metadata;
    private File dataFile; // 存储文件路径，无需加载内容到内存
}

2. 自定义Jackson序列化器 #

为File类型编写序列化器，流式读取文件并序列化为接口预期的Base64格式：

public class FileToBase64Serializer extends StdSerializer<File> {
    public FileToBase64Serializer() {
        super(File.class);
    }

    @Override
    public void serialize(File file, JsonGenerator gen, SerializerProvider provider) throws IOException {
        try (InputStream inputStream = new FileInputStream(file)) {
            // 利用Jackson内置方法流式写入Base64，无需全量加载文件
            gen.writeBinary(Base64Variants.getDefaultVariant(), inputStream, file.length());
        }
    }
}

3. 配置WebClient使用自定义序列化器 #

将自定义序列化器注册到Jackson，并配置WebClient的编解码器：

// 配置ObjectMapper
ObjectMapper objectMapper = new ObjectMapper();
SimpleModule module = new SimpleModule();
module.addSerializer(File.class, new FileToBase64Serializer());
objectMapper.registerModule(module);

// 自定义编解码器
Jackson2JsonEncoder encoder = new Jackson2JsonEncoder(objectMapper, MediaType.APPLICATION_JSON);
Jackson2JsonDecoder decoder = new Jackson2JsonDecoder(objectMapper, MediaType.APPLICATION_JSON);

// 构建WebClient
WebClient webClient = WebClient.builder()
    .baseUrl(myBaseUrl)
    .codecs(configurer -> {
        configurer.defaultCodecs().jackson2JsonEncoder(encoder);
        configurer.defaultCodecs().jackson2JsonDecoder(decoder);
    })
    .clientConnector(new ReactorClientHttpConnector(client))
    .build();

4. 修改上传逻辑 #

直接传入File对象构建请求体，无需加载文件内容：

// 构建请求体
InnerClass inner = new InnerClass();
inner.setMetadata("文件元数据");
inner.setDataFile(new File("/path/to/large/file"));

UploadPojo uploadPojo = new UploadPojo();
uploadPojo.setMetadata("全局元数据");
uploadPojo.setInnerList(Collections.singletonList(inner));

// 执行上传
webClient.post()
    .uri("endpoint")
    .bodyValue(uploadPojo)
    .retrieve()
    .bodyToMono(ResponsePojo.class);

核心说明 #

• 自定义序列化器通过JsonGenerator.writeBinary分块读取文件并序列化，不会占用大量内存存储整个文件内容。
• 若使用Path或InputStream，只需对应调整序列化器的类型和读取逻辑，核心流式处理逻辑不变。
• 需确保文件在序列化过程中存在且有读取权限。

内容的提问来源于stack exchange，提问作者billoot