"+" (знак плюс) не кодируется с помощью RestTemplate с использованием String url, но интерпретируется как "" (пробел)

Мы переходим с Java 8 на Java 11 и, следовательно, с Spring Boot 1.5.6 на 2.1.2. Мы заметили, что при использовании RestTemplate знак "+" больше не кодируется в "%2B" (изменяется с помощью SPR-14828). Это было бы хорошо, потому что RFC3986 не перечисляет "+" как зарезервированный символ, но все равно интерпретируется как "" (пробел) при получении в конечной точке Spring Boot.

У нас есть поисковый запрос, который может принимать дополнительные метки времени в качестве параметров запроса. Запрос выглядит примерно так http://example.com/search?beforeTimestamp=2019-01-21T14:56:50%2B00:00,

Мы не можем понять, как отправить закодированный знак плюс, без его двойного кодирования. Параметр запроса 2019-01-21T14:56:50+00:00 будет интерпретироваться как 2019-01-21T14:56:50 00:00, Если бы мы сами закодировали параметр (2019-01-21T14:56:50%2B00:00), то оно будет получено и интерпретировано как 2019-01-21T14:56:50%252B00:00,

Дополнительным ограничением является то, что мы хотим установить базовый URL в другом месте, при настройке restTemplate, а не там, где выполняется запрос.

Альтернативно, есть ли способ заставить '+' не интерпретироваться как '' конечной точкой?

Я написал короткий пример, демонстрирующий некоторые способы достижения более строгого кодирования с их недостатками, поясненными в комментариях:

package com.example.clientandserver;

import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.web.client.RestTemplateBuilder;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.client.RestTemplate;
import org.springframework.web.util.DefaultUriBuilderFactory;
import org.springframework.web.util.UriComponentsBuilder;
import org.springframework.web.util.UriUtils;

import java.nio.charset.StandardCharsets;
import java.util.HashMap;
import java.util.Map;

@SpringBootApplication
@RestController
public class ClientAndServerApp implements CommandLineRunner {

    public static void main(String[] args) {
        SpringApplication.run(ClientAndServerApp.class, args);
    }

    @Override
    public void run(String... args) {
        String beforeTimestamp = "2019-01-21T14:56:50+00:00";

        // Previously - base url and raw params (encoded automatically). This worked in the earlier version of Spring Boot
        {
            RestTemplate restTemplate = new RestTemplateBuilder().rootUri("http://localhost:8080").build();
            UriComponentsBuilder b = UriComponentsBuilder.fromPath("/search");
            if (beforeTimestamp != null) {
                b.queryParam("beforeTimestamp", beforeTimestamp);
            }
            restTemplate.getForEntity(b.toUriString(), Object.class);
            // Received: 2019-01-21T14:56:50 00:00
            //       Plus sign missing here ^
        }

        // Option 1 - no base url and encoding the param ourselves.
        {
            RestTemplate restTemplate = new RestTemplate();
            UriComponentsBuilder b = UriComponentsBuilder.fromHttpUrl("http://localhost:8080/search");
            if (beforeTimestamp != null) {
                b.queryParam("beforeTimestamp", UriUtils.encode(beforeTimestamp, StandardCharsets.UTF_8));
            }
            restTemplate.getForEntity(b.build(true).toUri(), Object.class).getBody();
            // Received: 2019-01-21T14:56:50+00:00
        }

        // Option 2 - with base url, but templated, so query parameter is not optional.
        {
            RestTemplate restTemplate = new RestTemplateBuilder().rootUri("http://localhost:8080").uriTemplateHandler(new DefaultUriBuilderFactory()).build();
            Map<String, String> params = new HashMap<>();
            params.put("beforeTimestamp", beforeTimestamp);
            restTemplate.getForEntity("/search?beforeTimestamp={beforeTimestamp}", Object.class, params);
            // Received: 2019-01-21T14:56:50+00:00
        }
    }

    @GetMapping("/search")
    public void search(@RequestParam String beforeTimestamp) {
        System.out.println("Received: " + beforeTimestamp);
    }
}
Источник

5 ответов

Решение

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

RestTemplate restTemplate = new RestTemplateBuilder()
        .rootUri("http://localhost:8080")
        .interceptors(new PlusEncoderInterceptor())
        .build();

Сокращенный пример:

public class PlusEncoderInterceptor implements ClientHttpRequestInterceptor {

    @Override
    public ClientHttpResponse intercept(HttpRequest request, byte[] body, ClientHttpRequestExecution execution) throws IOException {
        return execution.execute(new HttpRequestWrapper(request) {
            @Override
            public URI getURI() {
                URI u = super.getURI();
                String strictlyEscapedQuery = StringUtils.replace(u.getRawQuery(), "+", "%2B");
                return UriComponentsBuilder.fromUri(u)
                        .replaceQuery(strictlyEscapedQuery)
                        .build(true).toUri();
            }
        }, body);
    }
}
Источник

Здесь тоже обсуждали этот вопрос.

Кодирование переменных URI в RestTemplate [SPR-16202]

Более простое решение - установить режим кодирования в построителе URI на VALUES_ONLY.

    DefaultUriBuilderFactory builderFactory = new DefaultUriBuilderFactory();
    builderFactory.setEncodingMode(DefaultUriBuilderFactory.EncodingMode.VALUES_ONLY);
    RestTemplate restTemplate = new RestTemplateBuilder()
            .rootUri("http://localhost:8080")
            .uriTemplateHandler(builderFactory)
            .build();

Это дает тот же результат, что и при использовании PlusEncodingInterceptor при использовании параметров запроса.

Источник

Чтобы обойти эту проблему, мне было проще создать URI вручную.

      URI uri = new URI(siteProperties.getBaseUrl()
  + "v3/elements/"
  + URLEncoder.encode("user/" + user + "/type/" + type, UTF_8)
  + "/"
  + URLEncoder.encode(id, UTF_8)
);

restTemplate.exchange(uri, DELETE, new HttpEntity<>(httpHeaders), Void.class);
Источник

Спасибо, Gregor Eesmaa, это решило мою проблему. Просто хотел добавить, что на случай, если вы можете отформатировать URL-адрес перед вызовом, вы можете исправить URL-адрес сразу (вместо того, чтобы заменять его в PlusEncoderInterceptor):

      UriComponentsBuilder uriBuilder = UriComponentsBuilder.fromUriString("/search");
uriBuilder.queryParam("beforeTimestamp", "2019-01-21T14:56:50+00:00");
URI uriPlus = uriBuilder.encode().build(false).toUri();

// import org.springframework.util.StringUtils;
String strictlyEscapedQuery = StringUtils.replace(uriPlus.getRawQuery(), "+", "%2B");
URI uri = UriComponentsBuilder.fromUri(uriPlus)
        .replaceQuery(strictlyEscapedQuery)
        .build(true).toUri();

// prints "/search?beforeTimestamp=2019-01-21T14:56:50%2B00:00"
System.out.println(uri);

Тогда вы можете использовать в RestTemplate вызов:

      RequestEntity<?> requestEntity = RequestEntity.get(uri).build();
ResponseEntity<String> responseEntity = restTemplate.exchange(requestEntity, String.class);
Источник

Просто хочу добавить! Вы можете попробовать это без настройки везде, где вы использовали RestTemplate в своем проекте, конфигурация также поддерживает кодировку UTF-8:

      public class PlusEncoderInterceptor implements ClientHttpRequestInterceptor {

@Override
public ClientHttpResponse intercept(HttpRequest request, byte[] body, ClientHttpRequestExecution execution)
        throws IOException {
    return execution.execute(new HttpRequestWrapper(request) {
        @NotNull
        @Override
        public URI getURI() {
            URI u = super.getURI();
            String strictlyEscapedQuery = StringUtils.replace(u.getRawQuery(), "+", "%2B");
            return UriComponentsBuilder.fromUri(u).replaceQuery(strictlyEscapedQuery).build(true).toUri();
        }
    }, body);
}
}

@Configuration
public class RestTemplateConfig {
@Bean
public RestTemplate restTemplate() {
    RestTemplate restTemplate = new RestTemplateBuilder().interceptors(new PlusEncoderInterceptor()).build();
    restTemplate.getMessageConverters().add(0, new StringHttpMessageConverter(StandardCharsets.UTF_8));
    return restTemplate;
}
}
Источник
Другие вопросы по тегам