通过@Bean 提供的 RestTemplateBuilder 流式上传缓冲完整文件

Question

我正在构建一个用于上传大文件（数 GB）的反向代理，因此想使用不缓冲整个文件的流模型。大缓冲区会引入延迟，更重要的是，它们可能会导致内存不足错误。

我的客户端class包含

@Autowired private RestTemplate restTemplate;

@Bean
public RestTemplate restTemplate(RestTemplateBuilder restTemplateBuilder) {

    int REST_TEMPLATE_MODE = 1; // 1=streams, 2=streams, 3=buffers

    return 
        REST_TEMPLATE_MODE == 1 ? new RestTemplate() :
        REST_TEMPLATE_MODE == 2 ? (new RestTemplateBuilder()).build() :
        REST_TEMPLATE_MODE == 3 ? restTemplateBuilder.build() : null;
}

和

public void upload_via_streaming(InputStream inputStream, String originalname) {

    SimpleClientHttpRequestFactory requestFactory = new SimpleClientHttpRequestFactory();
    requestFactory.setBufferRequestBody(false);
    restTemplate.setRequestFactory(requestFactory);

    InputStreamResource inputStreamResource = new InputStreamResource(inputStream) {
        @Override public String getFilename() { return originalname; }
        @Override public long contentLength() { return -1; }
    };

    MultiValueMap<String, Object> body = new LinkedMultiValueMap<String, Object>();
    body.add("myfile", inputStreamResource);

    HttpHeaders headers = new HttpHeaders();
    headers.setContentType(MediaType.MULTIPART_FORM_DATA);

    HttpEntity<MultiValueMap<String, Object>> requestEntity = new HttpEntity<>(body,headers);

    String response = restTemplate.postForObject(UPLOAD_URL, requestEntity, String.class);
    System.out.println("response: "+response);
}

这是有效的，但请注意我的 REST_TEMPLATE_MODE 值控制它是否满足我的流式传输要求。

问题：为什么REST_TEMPLATE_MODE == 3会导致全文件缓冲？

参考文献：

How to forward large files with RestTemplate?
-- 建立输入流
How to autowire RestTemplate using annotations

Answer 1

简而言之，RestTemplateBuilder 的实例由 Spring Boot 作为 @Bean 提供，包括一个与 actuator/metrics 关联的拦截器（过滤器）——以及拦截器接口需要将请求主体缓冲为简单的 byte[].

如果您从头开始实例化自己的 RestTemplateBuilder 或 RestTemplate，默认情况下它不会包含它。

我似乎是唯一访问此 post 的人，但为了以防万一它在我开始 post 找到完整的解决方案之前对某人有所帮助，我发现了一条重要线索：

restTemplate.getInterceptors().forEach(item->System.out.println(item));

显示...

org.SF.boot.actuate.metrics.web.client.MetricsClientHttpRequestInterceptor

如果我通过setInterceptors清除拦截器列表，问题就解决了。此外，我发现任何拦截器，即使它只执行一个 NOP，也会引入全文件缓冲。

public class SimpleClientHttpRequestFactory { ...

我已经明确地设置了bufferRequestBody = false，但是如果使用拦截器，显然这段代码会被绕过。早点知道就好了...

@Override
public ClientHttpRequest createRequest(URI uri, HttpMethod httpMethod) throws IOException {
    HttpURLConnection connection = openConnection(uri.toURL(), this.proxy);
    prepareConnection(connection, httpMethod.name());

    if (this.bufferRequestBody) {
        return new SimpleBufferingClientHttpRequest(connection, this.outputStreaming);
    }
    else {
        return new SimpleStreamingClientHttpRequest(connection, this.chunkSize, this.outputStreaming);
    }
}

public 摘要 class InterceptingHttpAccessor 扩展 HttpAccessor { ...

这表明如果 interceptors 的列表不为空，则使用 InterceptingClientHttpRequestFactory。

/**
 * Overridden to expose an {@link InterceptingClientHttpRequestFactory}
 * if necessary.
 * @see #getInterceptors()
 */
@Override
public ClientHttpRequestFactory getRequestFactory() {
    List<ClientHttpRequestInterceptor> interceptors = getInterceptors();
    if (!CollectionUtils.isEmpty(interceptors)) {
        ClientHttpRequestFactory factory = this.interceptingRequestFactory;
        if (factory == null) {
            factory = new InterceptingClientHttpRequestFactory(super.getRequestFactory(), interceptors);
            this.interceptingRequestFactory = factory;
        }
        return factory;
    }
    else {
        return super.getRequestFactory();
    }
}

class InterceptingClientHttpRequest extends AbstractBufferingClientHttpRequest { ...

接口清楚地表明使用 InterceptingClientHttpRequest 需要缓冲 body 到 byte[]。没有使用流接口的选项。

    @Override
    public ClientHttpResponse execute(HttpRequest request, byte[] body) throws IOException {

通过@Bean 提供的 RestTemplateBuilder 流式上传缓冲完整文件

Streaming upload via @Bean-provided RestTemplateBuilder buffers full file

spring

spring-boot

streaming

reverse-proxy

resttemplate

public class SimpleClientHttpRequestFactory { ...

public 摘要 class InterceptingHttpAccessor 扩展 HttpAccessor { ...

class InterceptingClientHttpRequest extends AbstractBufferingClientHttpRequest { ...