Spring RestTemplate GET с параметрами

Question

Мне нужно сделать вызов REST, который включает в себя пользовательские заголовки и параметры запроса. Я установил HttpEntity только с заголовками (без тела) и использую метод RestTemplate.exchange() следующим образом:

HttpHeaders headers = new HttpHeaders();
headers.set("Accept", "application/json");

Map<String, String> params = new HashMap<String, String>();
params.put("msisdn", msisdn);
params.put("email", email);
params.put("clientVersion", clientVersion);
params.put("clientType", clientType);
params.put("issuerName", issuerName);
params.put("applicationName", applicationName);

HttpEntity entity = new HttpEntity(headers);

HttpEntity<String> response = restTemplate.exchange(url, HttpMethod.GET, entity, String.class, params);

Ошибка на стороне клиента: dispatcher servlet не может обработать запрос к обработчику. После его отладки похоже, что параметры запроса не отправляются.

Когда я делаю обмен с POST, используя тело запроса и без параметров запроса, он работает просто отлично.

У кого-нибудь есть идеи?

Answer 1

Чтобы легко манипулировать URL / path / params / и т. Д., Вы можете использовать класс Spring * UriComponentsBuilder . Это чище, что вручную объединяет строки и заботится о кодировке URL для вас:

HttpHeaders headers = new HttpHeaders();
headers.set("Accept", MediaType.APPLICATION_JSON_VALUE);

UriComponentsBuilder builder = UriComponentsBuilder.fromHttpUrl(url)
        .queryParam("msisdn", msisdn)
        .queryParam("email", email)
        .queryParam("clientVersion", clientVersion)
        .queryParam("clientType", clientType)
        .queryParam("issuerName", issuerName)
        .queryParam("applicationName", applicationName);

HttpEntity<?> entity = new HttpEntity<>(headers);

HttpEntity<String> response = restTemplate.exchange(
        builder.toUriString(), 
        HttpMethod.GET, 
        entity, 
        String.class);

Answer 2

UriVariables также раскрываются в строке запроса.Например, следующий вызов расширит значения для учетной записи и имени:

restTemplate.exchange("http://my-rest-url.org/rest/account/{account}?name={name}",
    HttpMethod.GET,
    httpEntity,
    clazz,
    "my-account",
    "my-name"
);

, поэтому фактический URL-адрес запроса будет

http://my-rest-url.org/rest/account/my-account?name=my-name

Посмотрите на HierarchicalUriComponents.expandInternal (UriTemplateVariables) длябольше деталей.Версия Spring - 3.1.3.

Answer 3

ОК, так что я идиот и путаю параметры запроса с параметрами URL.Я надеялся, что был бы более хороший способ заполнить параметры моего запроса, а не безобразно сцепленную строку, но мы здесь.Это просто случай построения URL с правильными параметрами.Если вы передадите его как String Spring, он также позаботится о кодировке для вас.

Answer 4

Поскольку, по крайней мере, Spring 3, вместо использования UriComponentsBuilder для построения URL-адреса (что является немного многословным), many методов RestTemplate принимают заполнители в пути для параметров (не толькоexchange).

Из документации:

Многие из методов RestTemplate принимают переменные шаблона URI и шаблона URI, либо как String vararg, либо какMap<String,String>.

Например, с String переменным:

restTemplate.getForObject(
   "http://example.com/hotels/{hotel}/rooms/{room}", String.class, "42", "21");

Или с Map<String, String>:

Map<String, String> vars = new HashMap<>();
vars.put("hotel", "42");
vars.put("room", "21");

restTemplate.getForObject("http://example.com/hotels/{hotel}/rooms/{hotel}", 
    String.class, vars);

Ссылка: https://docs.spring.io/spring/docs/current/spring-framework-reference/integration.html#rest-resttemplate-uri

Если вы посмотрите на JavaDoc для RestTemplate и поищите «Шаблон URI», вы увидите, какие методы вы можете использовать с заполнителями.

Answer 5

Я пытался сделать что-то подобное, и пример RoboSpice помог мне разобраться в этом :

HttpHeaders headers = new HttpHeaders();
headers.set("Accept", "application/json");

HttpEntity<String> request = new HttpEntity<>(input, createHeader());

String url = "http://awesomesite.org";
Uri.Builder uriBuilder = Uri.parse(url).buildUpon();
uriBuilder.appendQueryParameter(key, value);
uriBuilder.appendQueryParameter(key, value);
...

String url = uriBuilder.build().toString();

HttpEntity<String> response = restTemplate.exchange(url, HttpMethod.GET, request , String.class);

Answer 6

    String uri = http://my-rest-url.org/rest/account/{account};

    Map<String, String> uriParam = new HashMap<>();
    uriParam.put("account", "my_account");

    UriComponents builder = UriComponentsBuilder.fromHttpUrl(uri)
                .queryParam("pageSize","2")
                        .queryParam("page","0")
                        .queryParam("name","my_name").build();

    HttpEntity<String> requestEntity = new HttpEntity<>(null, getHeaders());

    ResponseEntity<String> strResponse = restTemplate.exchange(builder.toUriString(),HttpMethod.GET, requestEntity,
                        String.class,uriParam);

    //final URL: http://my-rest-url.org/rest/account/my_account?pageSize=2&page=0&name=my_name

RestTemplate: создание динамического URI с использованием UriComponents (переменная URI и параметры запроса)

Answer 7

Я использую другой подход, вы можете согласиться или нет, но я хочу управлять из файла .properties вместо скомпилированного кода Java

Внутри файла application.properties

endpoint.url = https://yourHost/resource?requestParam1={0}&requestParam2={1}

Здесь идет Java-код, вы можете написать условие if или switch, чтобы узнать, имеет ли URL-адрес конечной точки в файле .properties значение @PathVariable (содержит {}) или @RequestParam (yourURL? Key = value) и т. Д., А затем вызвать метод. соответственно ... таким образом, его динамика и не нужно менять код в будущем один стоп магазин ...

Я пытаюсь дать больше идеи, чем фактический код здесь ... попробуйте написать универсальный метод для @RequestParam, @PathVariable и т. Д. ... и затем вызвать соответствующим образом при необходимости

  @Value("${endpoint.url}")
  private String endpointURL;
  // you can use variable args feature in Java
  public String requestParamMethodNameHere(String value1, String value2) {
    RestTemplate restTemplate = new RestTemplate();
    restTemplate
           .getMessageConverters()
           .add(new MappingJackson2HttpMessageConverter());

    HttpHeaders headers = new HttpHeaders();
    headers.set("Accept", MediaType.APPLICATION_JSON_VALUE);
    HttpEntity<String> entity = new HttpEntity<>(headers);

    try {
      String formatted_URL = MessageFormat.format(endpointURL, value1, value2);
      ResponseEntity<String> response = restTemplate.exchange(
                    formatted_URL ,
                    HttpMethod.GET,
                    entity,
                    String.class);
     return response.getBody();
    } catch (Exception e) { e.printStackTrace(); }

Answer 8

В Spring Web 4.3.6 я тоже вижу

public <T> T getForObject(String url, Class<T> responseType, Object... uriVariables)

Это означает, что вам не нужно создавать уродливую карту

Так что, если у вас есть этот URL

http://my-url/action?param1={param1}&param2={param2}

Вы можете сделать

restTemplate.getForObject(url, Response.class, param1, param2)

или

restTemplate.getForObject(url, Response.class, param [])

Answer 9

Если вы передадите непараметризованные параметры для RestTemplate, у вас будет один показатель для каждого отдельного другого URL, который вы передаете, с учетом параметров. Вы хотели бы использовать параметризованные URL:

http://my-url/action?param1={param1}&param2={param2}

вместо

http://my-url/action?param1=XXXX&param2=YYYY

Второй случай - это то, что вы получаете, используя класс UriComponentsBuilder.

Одним из способов реализации первого поведения является следующее:

Map<String, Object> params = new HashMap<>();
params.put("param1", "XXXX");
params.put("param2", "YYYY");

String url = "http://my-url/action?%s";

String parametrizedArgs = params.keySet().stream().map(k ->
    String.format("%s={%s}", k, k)
).collect(Collectors.joining("&"));

HttpHeaders headers = new HttpHeaders();
headers.set("Accept", MediaType.APPLICATION_JSON_VALUE);
HttpEntity<String> entity = new HttpEntity<>(headers);

restTemplate.exchange(String.format(url, parametrizedArgs), HttpMethod.GET, entity, String.class, params);

Answer 10

public static void main(String[] args) {
         HttpHeaders httpHeaders = new HttpHeaders();
         httpHeaders.set("Accept", MediaType.APPLICATION_JSON_VALUE);
         final String url = "https://host:port/contract/{code}";
         Map<String, String> params = new HashMap<String, String>();
         params.put("code", "123456");
         HttpEntity<?> httpEntity  = new HttpEntity<>(httpHeaders); 
         RestTemplate restTemplate  = new RestTemplate();
         restTemplate.exchange(url, HttpMethod.GET, httpEntity,String.class, params);
    }