一、通过GET方式获取数据
1.通过GET请求获取json数据
让我们使用getForEntity()API发起一个简单GET请求
RestTemplate restTemplate = new RestTemplate();
String fooResourceUrl = "http://localhost:8080/spring-rest/foos";
ResponseEntity<String> response = restTemplate.getForEntity(fooResourceUrl +"/1", String.class);
assertThat(response.getStatusCode(), equalTo(HttpStatus.OK));
注意我们我们已经成功的获取HTTP response,我们还需要检查状态,确保我们的请求确实成功。接着我们要处理response body:
ObjectMapper mapper = new ObjectMapper();
JsonNode root = mapper.readTree(response.getBody());
JsonNode name = root.path("name");
assertThat(name.asText(), notNullValue());
我们在这里处理response body 作为标准的String,并且运用Jackson验证了一些细节。
2.用POJO代替JSON
我们也可以将reponse直接映射为POJO,例如:
public class Foo implements Serializable {
private long id;
private String name;
// standard getters and setters
}
现在,我们就可以在template中使用getForObject
Foo foo = restTemplate
.getForObject(fooResourceUrl + "/1", Foo.class);
assertThat(foo.getName(), notNullValue());
assertThat(foo.getId(), is(1L));
二、使用 HEAD 获取 Headers
在我们在看RestTemplate的其他方法前,我快速了解HEAD的使用方法。我将使用 headForHeaders()API:
HttpHeaders httpHeaders = restTemplate.headForHeaders(fooResourceUrl);
assertTrue(httpHeaders.getContentType().includes(MediaType.APPLICATION_JSON));
三、使用POST创建资源
- postForObject 方法
RestTemplate restTemplate = new RestTemplate();
HttpEntity<Foo> request = new HttpEntity<>(new Foo("bar"));
Foo foo = restTemplate.postForObject(fooResourceUrl, request, Foo.class);
assertThat(foo, notNullValue());
assertThat(foo.getName(), is("bar"));
- postForLocation 方法
HttpEntity<Foo> request = new HttpEntity<>(new Foo("bar"));
URI location = restTemplate
.postForLocation(fooResourceUrl, request);
assertThat(location, notNullValue());
- exchange 方法
运用exchange 方法发送 post请求
RestTemplate restTemplate = new RestTemplate();
HttpEntity<Foo> request = new HttpEntity<>(new Foo("bar"));
ResponseEntity<Foo> response = restTemplate
.exchange(fooResourceUrl, HttpMethod.POST, request, Foo.class);
assertThat(response.getStatusCode(), is(HttpStatus.CREATED));
Foo foo = response.getBody();
assertThat(foo, notNullValue());
assertThat(foo.getName(), is("bar"));
- 提交form表单数据
接下来,让我们看下如何试用post方法提交表单
首先,我们需要在header设置content-type 的值为 application/x-www-form-urlencoded。这样可以确保大量的查下字符串可以被发送到服务端,这个请求body中包含name/value对用&符号分开。
HttpHeaders headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_FORM_URLENCODED);
我们可以封装表单变量到LinkedMultiValueMap中。
MultiValueMap<String, String> map= new LinkedMultiValueMap<>();
map.add("id", "1");
接下来,我们通过HttpEntity创建一个请求
HttpEntity<MultiValueMap<String, String>> request = new HttpEntity<>(map, headers);
最后,我们可以通过调用restTemplate.postForEntity()向后端发送请求
ResponseEntity<String> response = restTemplate.postForEntity(
fooResourceUrl+"/form", request , String.class);
assertThat(response.getStatusCode(), is(HttpStatus.CREATED));
四、运用OPTIONS获取允许的操作
接下来,我们将快速浏览使用OPTIONS请求的方法,并且通过一个特殊的URI请求去探索可以被允许的操作。
Set<HttpMethod> optionsForAllow = restTemplate.optionsForAllow(fooResourceUrl);
HttpMethod[] supportedMethods
= {HttpMethod.GET, HttpMethod.POST, HttpMethod.PUT, HttpMethod.DELETE};
assertTrue(optionsForAllow.containsAll(Arrays.asList(supportedMethods)));
五、使用put方法更新资源
接下来,我们开始研究put方法,并且有比较多的exchange方法为这个操作。因为template.put方法相当直观。
- 运用exchange发送一个简单的put请求
我们开始使用这个api发送一个简单的put请求,并且我们要记住这个操作不会返回任何东西给客户端。
Foo updatedInstance = new Foo("newName");
updatedInstance.setId(createResponse.getBody().getId());
String resourceUrl =
fooResourceUrl + '/' + createResponse.getBody().getId();
HttpEntity<Foo> requestUpdate = new HttpEntity<>(updatedInstance, headers);
template.exchange(resourceUrl, HttpMethod.PUT, requestUpdate, Void.class);
2.运用exchange和request callback发送put请求
接下来,我们将运用requestCallback发起一个PUT请求。
我们准备一个可以设置请求头和请求体的callback
RequestCallback requestCallback(final Foo updatedInstance) {
return clientHttpRequest -> {
ObjectMapper mapper = new ObjectMapper();
mapper.writeValue(clientHttpRequest.getBody(), updatedInstance);
clientHttpRequest.getHeaders().add(
HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON_VALUE);
clientHttpRequest.getHeaders().add(
HttpHeaders.AUTHORIZATION, "Basic " + getBase64EncodedLogPass());
};
}
接下来,我们使用POST请求创建资源
ResponseEntity<Foo> response = restTemplate
.exchange(fooResourceUrl, HttpMethod.POST, request, Foo.class);
assertThat(response.getStatusCode(), is(HttpStatus.CREATED));
然后我们更新这个资源
Foo updatedInstance = new Foo("newName");
updatedInstance.setId(response.getBody().getId());
String resourceUrl =fooResourceUrl + '/' + response.getBody().getId();
restTemplate.execute(
resourceUrl,
HttpMethod.PUT,
requestCallback(updatedInstance),
clientHttpResponse -> null);
六、运用DELETE删除资源
为了删除一个存在的资源,我只需要调用delete()方法。
String entityUrl = fooResourceUrl + "/" + existingResource.getId();
restTemplate.delete(entityUrl);
七、配置超时时间
我们通过使用ClientHttpRequestFactory去配置RestTemplate的超时时间。
RestTemplate restTemplate = new RestTemplate(getClientHttpRequestFactory());
private ClientHttpRequestFactory getClientHttpRequestFactory() {
int timeout = 5000;
HttpComponentsClientHttpRequestFactory clientHttpRequestFactory
= new HttpComponentsClientHttpRequestFactory();
clientHttpRequestFactory.setConnectTimeout(timeout);
return clientHttpRequestFactory;
}
并且我们也通过使用HttpClient去设置更多配置选项。
private ClientHttpRequestFactory getClientHttpRequestFactory() {
int timeout = 5000;
RequestConfig config = RequestConfig.custom()
.setConnectTimeout(timeout)
.setConnectionRequestTimeout(timeout)
.setSocketTimeout(timeout)
.build();
CloseableHttpClient client = HttpClientBuilder
.create()
.setDefaultRequestConfig(config)
.build();
return new HttpComponentsClientHttpRequestFactory(client);
}