Какой правильный способ избежать переменных URL-адресов с помощью Spring RestTemplate при вызове Spring RestController?

Вы можете использовать UriComponentsBuilder в Spring (org.springframework.web.util.UriComponentsBuilder)

String url = UriComponentsBuilder
    .fromUriString("http://example.com/")
    .queryParam("foo", "fo+o")
    .queryParam("bar", "ba r")
    .build().toUriString();

restTemplate.exchange(url , HttpMethod.GET, httpEntity);

Я начинаю верить, что это ошибка, и сообщил здесь: https://jira.spring.io/browse/SPR-16860

В настоящее время мой обходной путь таков:

String foo = "fo+o";
String bar = "ba r";
String uri = UriComponentsBuilder.
    fromUriString("http://example.com/?foo = {foo}&bar = {bar}").
    buildAndExpand(vars).toUriString();
uri = uri.replace("+", "%2B"); // This is the horrible hack.
try {
    return new URI(uriString);
} catch (URISyntaxException e) {
    throw new RuntimeException("UriComponentsBuilder generated an invalid URI.", e);
}

это ужасный взлом, который может потерпеть неудачу в некоторых ситуациях.

Я думаю, ваша проблема здесь в том, что RFC 3986, на котором основаны UriComponents и расширение UriTemplate, не требует экранирования + в строке запроса.

Взгляд спецификации на это прост:

sub-delims  = "!" / "$" / "&" / "'" / "(" / ")"
                  / "*" / "+" / "," / ";" / " = "

pchar       = unreserved / pct-encoded / sub-delims / ":" / "@"

query       = *( pchar / "/" / "?" )

URI         = scheme ":" hier-part [ "?" query ] [ "#" fragment ]

Если ваша веб-платформа (например, Spring MVC!) Интерпретирует + как пространство, то это ее решение и не требуется в соответствии со спецификацией URI.

Что касается вышеизложенного, вы также увидите, что !$'()*+,; не экранируются с помощью UriTemplate. = и &находятся экранированы, потому что Spring придерживается «самоуверенного» взгляда на то, как выглядит строка запроса - последовательность пар ключ = значение.

Аналогично, #[] и пробел находятся экранированы, потому что они недопустимы в строке запроса в соответствии со спецификацией.

Конечно, ничто из этого вряд ли станет для вас утешением, если вы вполне разумно хотите, чтобы параметры вашего запроса были экранированы!

Чтобы на самом деле закодировать параметры запроса, чтобы ваша веб-платформа могла их переносить, вы можете использовать что-то вроде org.springframework.web.util.UriUtils.encode(foo, charset).

Для этого я все же предпочел бы, чтобы кодировка решалась с помощью правильного метода, а не с помощью взлома, как вы. Я бы просто использовал что-то вроде ниже

String foo = "fo+o";
String bar = "ba r";
MyUriComponentsBuilder ucb = MyUriComponentsBuilder.fromUriString("http://example.com/?foo = {foo}&bar = {bar}");

UriComponents uriString = ucb.buildAndExpand(foo, bar);
// http://example.com/?foo=fo%252Bo&bar=ba+r
URI x = uriString.toUri();

// http://example.com/?foo=fo%2Bo&bar=ba+r
String y = uriString.toUriString();

// http://example.com/?foo=fo%2Bo&bar=ba+r
String z = uriString.toString();

И, конечно, класс, как показано ниже

class MyUriComponentsBuilder extends UriComponentsBuilder {
    protected UriComponentsBuilder originalBuilder; 

    public MyUriComponentsBuilder(UriComponentsBuilder builder) {
        // TODO Auto-generated constructor stub
        originalBuilder = builder;
    }


    public static MyUriComponentsBuilder fromUriString(String uri) {
        return new MyUriComponentsBuilder(UriComponentsBuilder.fromUriString(uri));
    }


    @Override
    public UriComponents buildAndExpand(Object... values) {
        // TODO Auto-generated method stub
        for (int i = 0; i< values.length; i ++) {
            try {
                values[i] = URLEncoder.encode((String) values[i], StandardCharsets.UTF_8.toString());
            } catch (UnsupportedEncodingException e) {
                // TODO Auto-generated catch block
                e.printStackTrace();
            }
        }
        return originalBuilder.buildAndExpand(values);
    }

}

Все еще не самый чистый из возможных способов, но лучше, чем жестко запрограммированный подход к замене.

По-видимому, правильный способ сделать это - определить фабрику и изменить режим кодирования:

String foo = "fo+o";
String bar = "ba r";
DefaultUriBuilderFactory factory = new DefaultUriBuilderFactory();
factory.setEncodingMode(DefaultUriBuilderFactory.EncodingMode.VALUES_ONLY);
URI uri = factory.uriString("http://example.com/?foo = {foo}&bar = {bar}").build(foo, bar);
System.out.println(uri);

Это распечатывает:

http://example.com/?foo=fo%2Bo&bar=ba%20r

Это задокументировано здесь: https://docs.spring.io/spring/docs/current/spring-framework-reference/web.html#web-uri-encoding