Мы переходим с 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 templated base url, 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);
}
}
Если оставить знак + (плюс), как и ожидалось, то принимающая конечная точка Spring Boot не должна пытаться декодировать + (плюс) как ` ` (пробел). К сожалению, это не так из-за, казалось бы, противоречивых стандартов.
У меня была та же проблема, но я начал с шаблонного URL-адреса. Успех Варианта 2, кажется, зависит от настройки uriTemplateHandler так же, как и вы... но почему? Я не понимаю разницы между DefaultUriBuilderFactor, который вы используете, и DefaultUriTemplateHandler, который использовался бы иначе.
@PatrickM DefaultUriTemplateHandler кажется устаревшим, но документы указывают, что разница может заключаться в том, что «DefaultUriBuilderFactory имеет другое значение по умолчанию для свойства parsePath (от false до true)».




Мы поняли, что 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 при использовании параметров запроса.
Это не сработало вместе с UriComponentsBuilder, так как параметры запроса не обязательно обязательны, но необязательны.
Спасибо, https://stackoverflow.com/users/4466695/gregor-eesmaa, это решило мою проблему. Просто хотел добавить, что в случае, если вы можете отформатировать URL-адрес перед вызовом RestTemplate, вы можете сразу исправить 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);
Чтобы обойти эту проблему, мне было проще создать 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);
Я полагаю, это было ожидаемое изменение?