Jak ustawić nagłówek „Accept:” na żądanie Spring RestTemplate?

193

Chcę ustawić wartość Accept:we wniosku, który składam za pomocą Springa RestTemplate.

Oto mój kod obsługi żądania wiosennego

@RequestMapping(
    value= "/uom_matrix_save_or_edit", 
    method = RequestMethod.POST,
    produces="application/json"
)
public @ResponseBody ModelMap uomMatrixSaveOrEdit(
    ModelMap model,
    @RequestParam("parentId") String parentId
){
    model.addAttribute("attributeValues",parentId);
    return model;
}

a oto mój klient Java REST:

public void post(){
    MultiValueMap<String, String> params = new LinkedMultiValueMap<String, String>();
    params.add("parentId", "parentId");
    String result = rest.postForObject( url, params, String.class) ;
    System.out.println(result);
}

To działa dla mnie; Otrzymuję ciąg JSON po stronie serwera.

Moje pytanie brzmi: w jaki sposób mogę określić Accept:nagłówek (np application/json, application/xml...) oraz metody żądania (np GET, POST...), gdy używam RestTemplate?

edaklij
źródło

Odpowiedzi:

354

Sugeruję użycie jednej z exchangemetod, która akceptuje metodę, HttpEntitydla której możesz również ustawić HttpHeaders. (Możesz także określić metodę HTTP, której chcesz użyć).

Na przykład,

RestTemplate restTemplate = new RestTemplate();
HttpHeaders headers = new HttpHeaders();
headers.setAccept(Collections.singletonList(MediaType.APPLICATION_JSON));

HttpEntity<String> entity = new HttpEntity<>("body", headers);

restTemplate.exchange(url, HttpMethod.POST, entity, String.class);

Wolę to rozwiązanie, ponieważ jest mocno wpisane, tj. exchangeoczekuje HttpEntity.

Możesz jednak przekazać to również HttpEntityjako requestargument postForObject.

HttpEntity<String> entity = new HttpEntity<>("body", headers);
restTemplate.postForObject(url, entity, String.class); 

Jest to wspomniane w RestTemplate#postForObjectJavadoc .

Ten requestparametr może być HttpEntityw celu dodania dodatkowych nagłówków HTTP do żądania .

Sotirios Delimanolis
źródło
131

Możesz ustawić przechwytywacz „ClientHttpRequestInterceptor” w RestTemplate, aby uniknąć ustawiania nagłówka za każdym razem, gdy wysyłasz żądanie.

public class HeaderRequestInterceptor implements ClientHttpRequestInterceptor {

        private final String headerName;

        private final String headerValue;

        public HeaderRequestInterceptor(String headerName, String headerValue) {
            this.headerName = headerName;
            this.headerValue = headerValue;
        }

        @Override
        public ClientHttpResponse intercept(HttpRequest request, byte[] body, ClientHttpRequestExecution execution) throws IOException {
            request.getHeaders().set(headerName, headerValue);
            return execution.execute(request, body);
        }
    }

Następnie

List<ClientHttpRequestInterceptor> interceptors = new ArrayList<ClientHttpRequestInterceptor>();
interceptors.add(new HeaderRequestInterceptor("Accept", MediaType.APPLICATION_JSON_VALUE));

RestTemplate restTemplate = new RestTemplate();
restTemplate.setInterceptors(interceptors);
Ammar
źródło
Spring Boot 1.3 ma HttpHeaderInterceptor, więc nie musimy tworzyć własnej implementacji ClientHttpRequestInterceptor.
whistling_marmot
2
Z jakiegoś powodu HttpHeaderInterceptor jest dostępny tylko w devtools na wiosnę. Wciąż musimy sami wdrożyć ClientHttpRequestInterceptor. Myślę, że należy go przenieść do wiosennej sieci.
whistling_marmot
2
Czy lepiej jest dodawać domyślne nagłówki do zestawu ClientHttpRequestFactory do pozostałych szablonów zamiast dodawać przechwytujące? PS powinieneś dodać swoją odpowiedź w osobnym pytaniu, ponieważ dotyczy to domyślnych nagłówków. Musiałem poszukać, żeby tu dotrzeć!
sbsatter
jeśli istnieją dwie usługi, które używają dwóch identyfikatorów / przepustek, które musimy wywołać, ten przechwytywacz na poziomie resttemplate jest zbyt wysoki, prawda? potrzebujesz tego na poziomie żądania - ogólnie RestTemplate jest konfiguracją @Bean w wiosennym rozruchu
Kalpesh Soni 30.04.19
21

Jeśli, podobnie jak ja, miałeś problem ze znalezieniem przykładu, który używa nagłówków z podstawowym uwierzytelnianiem i interfejsem API wymiany szablonów reszty, to w końcu opracowałem ...

private HttpHeaders createHttpHeaders(String user, String password)
{
    String notEncoded = user + ":" + password;
    String encodedAuth = Base64.getEncoder().encodeToString(notEncoded.getBytes());
    HttpHeaders headers = new HttpHeaders();
    headers.setContentType(MediaType.APPLICATION_JSON);
    headers.add("Authorization", "Basic " + encodedAuth);
    return headers;
}

private void doYourThing() 
{
    String theUrl = "http://blah.blah.com:8080/rest/api/blah";
    RestTemplate restTemplate = new RestTemplate();
    try {
        HttpHeaders headers = createHttpHeaders("fred","1234");
        HttpEntity<String> entity = new HttpEntity<String>("parameters", headers);
        ResponseEntity<String> response = restTemplate.exchange(theUrl, HttpMethod.GET, entity, String.class);
        System.out.println("Result - status ("+ response.getStatusCode() + ") has body: " + response.hasBody());
    }
    catch (Exception eek) {
        System.out.println("** Exception: "+ eek.getMessage());
    }
}
Dave
źródło
11

Wywoływanie interfejsu API RESTful przy użyciu RestTemplate

Przykład 1:

RestTemplate restTemplate = new RestTemplate();
// Add the Jackson message converter
restTemplate.getMessageConverters()
                .add(new MappingJackson2HttpMessageConverter());
HttpHeaders headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON);
headers.set("Authorization", "Basic XXXXXXXXXXXXXXXX=");
HttpEntity<String> entity = new HttpEntity<String>("parameters", headers);
restTemplate.getInterceptors()
                .add(new BasicAuthorizationInterceptor(USERID, PWORD));
String requestJson = getRequetJson(Code, emailAddr, firstName, lastName);
response = restTemplate.postForObject(URL, requestJson, MYObject.class);
        

Przykład 2:

RestTemplate restTemplate = new RestTemplate();
String requestJson = getRequetJson(code, emil, name, lastName);
HttpHeaders headers = new HttpHeaders();
String userPass = USERID + ":" + PWORD;
String authHeader =
    "Basic " + Base64.getEncoder().encodeToString(userPass.getBytes());
headers.set(HttpHeaders.AUTHORIZATION, authHeader);
headers.setContentType(MediaType.APPLICATION_JSON);
headers.setAccept(Collections.singletonList(MediaType.APPLICATION_JSON));
HttpEntity<String> request = new HttpEntity<String>(requestJson, headers);
ResponseEntity<MyObject> responseEntity;
responseEntity =
    this.restTemplate.exchange(URI, HttpMethod.POST, request, Object.class);
responseEntity.getBody()

getRequestJsonMetoda tworzy obiekt JSON:

private String getRequetJson(String Code, String emailAddr, String name) {
    ObjectMapper mapper = new ObjectMapper();
    JsonNode rootNode = mapper.createObjectNode();
    ((ObjectNode) rootNode).put("code", Code);
    ((ObjectNode) rootNode).put("email", emailAdd);
    ((ObjectNode) rootNode).put("firstName", name);
    String jsonString = null;
    try {
        jsonString = mapper.writerWithDefaultPrettyPrinter()
                               .writeValueAsString(rootNode);
    }
    catch (JsonProcessingException e) {
        e.printStackTrace();
    }
    return jsonString;
}
Vaquar Khan
źródło
4

Oto prosta odpowiedź. Mam nadzieję, że to komuś pomoże.

import org.springframework.boot.devtools.remote.client.HttpHeaderInterceptor;
import org.springframework.http.MediaType;
import org.springframework.http.client.ClientHttpRequestInterceptor;
import org.springframework.web.client.RestTemplate;


public String post(SomeRequest someRequest) {
    // create a list the headers 
    List<ClientHttpRequestInterceptor> interceptors = new ArrayList<>();
    interceptors.add(new HttpHeaderInterceptor("Accept", MediaType.APPLICATION_JSON_VALUE));
    interceptors.add(new HttpHeaderInterceptor("ContentType", MediaType.APPLICATION_JSON_VALUE));
    interceptors.add(new HttpHeaderInterceptor("username", "user123"));
    interceptors.add(new HttpHeaderInterceptor("customHeader1", "c1"));
    interceptors.add(new HttpHeaderInterceptor("customHeader2", "c2"));
    // initialize RestTemplate
    RestTemplate restTemplate = new RestTemplate();
    // set header interceptors here
    restTemplate.setInterceptors(interceptors);
    // post the request. The response should be JSON string
    String response = restTemplate.postForObject(Url, someRequest, String.class);
    return response;
}
Tunde Michael
źródło
10
Twój kod użyje Spring Devtools jako zależności produkcyjnej (importując org.springframework.boot.devtools.remote.client.HttpHeaderInterceptor) ...
snorbi