Как zip-компрессировать HTTP-запрос с помощью Spring RestTemplate?

Как gzip HTTP запрос, созданный org.springframework.web.client.RestTemplate?

Я использую Spring 4.2.6 с Spring Boot 1.3.5 (Java SE, а не Android или Javascript в веб-браузере).

Я делаю несколько действительно больших запросов POST, и я хочу, чтобы тело запроса было сжато.

Ответ 1

Я предлагаю два решения, один более простой без потоковой передачи и один, поддерживающий потоковое вещание.

Если не требуется потоковая передача, используйте ClientHttpRequestInterceptor, Spring.

RestTemplate rt = new RestTemplate();
rt.setInterceptors(Collections.singletonList(interceptor));

Где interceptor может быть:

ClientHttpRequestInterceptor interceptor = new ClientHttpRequestInterceptor() {

    @Override
    public ClientHttpResponse intercept(HttpRequest request, byte[] body, ClientHttpRequestExecution execution)
            throws IOException {
        request.getHeaders().add("Content-Encoding", "gzip");
        byte[] gzipped = getGzip(body);
        return execution.execute(request, gzipped);
    } 
 }

getGzip я скопировано

    private byte[] getGzip(byte[] body) throws IOException {

        ByteArrayOutputStream byteStream = new ByteArrayOutputStream();
        try {
            GZIPOutputStream zipStream = new GZIPOutputStream(byteStream);
            try {
                zipStream.write(body);
            } finally {
                zipStream.close();
            }
        } finally {
            byteStream.close();
        }

        byte[] compressedData = byteStream.toByteArray();
        return compressedData;

    }

После настройки перехватчика все запросы будут заархивированы.

Недостатком этого подхода является то, что он не поддерживает потоковое вещание, поскольку ClientHttpRequestInterceptor получает контент как byte[]

Если требуется потоковая передача, создайте пользовательский ClientHttpRequestFactory, скажем GZipClientHttpRequestFactory и используйте его следующим образом:

    SimpleClientHttpRequestFactory requestFactory = new SimpleClientHttpRequestFactory();
    requestFactory.setBufferRequestBody(false);
    ClientHttpRequestFactory gzipRequestFactory = new GZipClientHttpRequestFactory(requestFactory);
    RestTemplate rt = new RestTemplate(gzipRequestFactory);

Где GZipClientHttpRequestFactory:

public class GZipClientHttpRequestFactory extends AbstractClientHttpRequestFactoryWrapper {

    public GZipClientHttpRequestFactory(ClientHttpRequestFactory requestFactory) {
        super(requestFactory);
    }

    @Override
    protected ClientHttpRequest createRequest(URI uri, HttpMethod httpMethod, ClientHttpRequestFactory requestFactory)
            throws IOException {
        ClientHttpRequest delegate = requestFactory.createRequest(uri, httpMethod);
        return new ZippedClientHttpRequest(delegate);
    }

}

И ZippedClientHttpRequest:

public class ZippedClientHttpRequest extends WrapperClientHttpRequest
{
    private GZIPOutputStream zip;

    public ZippedClientHttpRequest(ClientHttpRequest delegate) {
        super(delegate);
        delegate.getHeaders().add("Content-Encoding", "gzip");
        // here or in getBody could add content-length to avoid chunking
        // but is it available ? 
        // delegate.getHeaders().add("Content-Length", "39");

    }

    @Override
    public OutputStream getBody() throws IOException {
        final OutputStream body = super.getBody();
        zip = new GZIPOutputStream(body);
        return zip;
    }

    @Override
    public ClientHttpResponse execute() throws IOException {
        if (zip!=null) zip.close();
        return super.execute();
    }

}

И, наконец, WrapperClientHttpRequest:

public class WrapperClientHttpRequest implements ClientHttpRequest {

    private final ClientHttpRequest delegate;

    protected WrapperClientHttpRequest(ClientHttpRequest delegate) {
        super();
        if (delegate==null)
            throw new IllegalArgumentException("null delegate");
        this.delegate = delegate;
    }

    protected final ClientHttpRequest getDelegate() {
        return delegate;
    }

    @Override
    public OutputStream getBody() throws IOException {
        return delegate.getBody();
    }

    @Override
    public HttpHeaders getHeaders() {
        return delegate.getHeaders();
    }

    @Override
    public URI getURI() {
        return delegate.getURI();
    }

    @Override
    public HttpMethod getMethod() {
        return delegate.getMethod();
    }

    @Override
    public ClientHttpResponse execute() throws IOException {
        return delegate.execute();
    }
}

Этот подход создает запрос с chunked transfer encoding, это можно изменить, задав заголовок длины контента, если размер известен.

Преимущество подхода ClientHttpRequestInterceptor и/или custom ClientHttpRequestFactory заключается в том, что он работает с любым методом RestTemplate. Альтернативный подход, проходящий RequestCallback, возможен только с execute, это потому, что другие методы RestTemplate внутренне создают свои собственные RequestCallback (ы), которые создают контент.

Кстати, кажется, что есть небольшая поддержка для распаковки запроса gzip на сервере. Также связаны: Отправка gzip-данных в WebRequest?, которая указывает на проблему код.

Ответ 2

Основная идея - создать requestCallback, который скопирует данные, которые вы хотите отправить из gzipOutputStream, прямо в поток request.

RequestCallback requestCallback = new RequestCallback() {
    @Override
    public void doWithRequest(ClientHttpRequest request) throws IOException {
        GZIPOutputStream gzipOutputStream;
        try {
            gzipOutputStream = new GZIPOutputStream(request.getBody());
        } catch (IOException ignored) {
            return;
        }

        request.getHeaders().add("Content-Type", "application/octet-stream");
        request.getHeaders().add("Content-Encoding", "gzip");

        try {
            String data = "Test data.";
            gzipOutputStream.write(data.getBytes(StandardCharsets.UTF_8));
            gzipOutputStream.flush(); // Optional in this example.
            gzipOutputStream.finish();
        } catch (IOException ignored) {
        }
    }
};

Теперь вы можете использовать его следующим образом:

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

ResponseExtractor<String> responseExtractor = new HttpMessageConverterExtractor<>(String.class,
        restTemplate.getMessageConverters());
String response = restTemplate.execute("http://localhost:8080/gzip.php", HttpMethod.POST, requestCallback,
        responseExtractor);

System.out.println(response);

Ссылки:

Ответ 3

В дополнение к приведенному выше ответу @TestoTestini, если мы воспользуемся синтаксисом "try-with-resources" Java 7+, поскольку и ByteArrayOutputStream и GZIPOutputStream реализуют GZIPOutputStream(), мы можем сжать функцию getGzip следующим образом:

private byte[] getGzip(byte[] body) throws IOException {

    try (ByteArrayOutputStream byteStream = new ByteArrayOutputStream()) {
        try (GZIPOutputStream zipStream = new GZIPOutputStream(byteStream)) {
            zipStream.write(body);
        }
        byte[] compressedData = byteStream.toByteArray();
        return compressedData;
    }

}

(Я не смог найти способ комментировать исходный ответ @TestoTestini и сохранить приведенный выше формат кода, отсюда и этот Ответ).

Ответ 4

когда я пытался с потоковой передачей (пользовательский ClientHttpRequestFactory), я получаю,

org.json.JSONException: текст JSONObject должен начинаться с '{' с 0 [символ 1, строка 1].