Spring的RestTemplata使用的具体方法

Spring的RestTemplata使用的具体方法

基本概念

Spring RestTemplate 是 Spring 提供的用于访问 Rest 服务的客户端，RestTemplate 提供了多种便捷访问远程Http服务的方法，能够大大提高客户端的编写效率，所以很多客户端比如 android或者第三方服务商都是使用 RestTemplate 请求 restful 服务。

spring-web的RestTemplata是对java底层http的封装，使用RestTemplata用户可以不再关注底层的连接建立，并且RestTemplata不仅支持Rest规范，还可以定义返回值对象类型。

在使用中可以直接new一个RestTemplate对象，在我们创建的RestTemplate对象中会有一些返回消息的消息转换器，可以根据返回数据的 MediaType 寻找对应的转换器并进行 MediaType 转换。自己也可以创建消息转换器，创建一个类继承AbstractGenericHttpMessageConverter类或者实现HttpMessageConverter接口，需要注意的是canRead方法和canWrite方法最好自己做判断，在writeInternal或write方法中将参数写入到流，在readInternal或read方法中将返回结果从流的body中获取并进行类型映射。

RestTemplate对象在底QSSulbGL层通过使用java.net包下的实现创建HTTP 请求，可以通过使用ClientHttpRequestFactory指定不同的HTTP请求方式。

ClientHttpRequestFactory接口主要提供了两种实现方式：

一种是SimpleClientHttpRequestFactory，使用J2SE提供的方式（既java.net包提供的方式）创建底层的Http请求连接。

一种方式是使用HttpComponentsClientHttpRequestFactory方式，底层使用HttpClient访问远程的Http服务，使用HttpClient可以配置连接池和证书等信息。

RestTemplate默认是使用SimpleClientHttpRequestFactory，内部是调用jdk的HttpConnection，默认超时为-1，我们可以自己定义超时时间

SimpleClientHttpRequestFactory factory = new SimpleClientHttpRequestFactory();

//设置连接超时，单位毫秒

factory.setConnectTimeout(5000);

//设置读取超时，单位毫秒

factory.setReadTimeout(10000);

RestTemplate restTemplate = new RestTemplate(factory);

使用GET请求：

String url = "http://localhost:80/mandy/login.json?account=123456&password=123456";

Result res = restTemplate.getForObject(url, Result.class);

RestTemplate源码：

@Override

public T getForObject(String url, Class responseType, Object... urlVariables) throws RestClientException {

RequestCallback requestCallback = acceptHeaderRequestCallback(responseType);

HttpMessageConverterExtractor responseExtractor =

new HttpMessageConverterExtractor(responseType, getMessageConverters(), logger);

return execute(url, HttpMethod.GET, requestCallback, responseExtractor, urlVariables);

}

使用get请求直接将参数拼接到地址上最好，不知道什么原因如果使用第三个参数，即便是MultiValueMap类型也不行（网上有人说用MultiValueMap类型可以，我试了不行）

使用POST请求：

HashMap map = new HashMap();

map.put("name", "测试");

map.put("account", "qwer");

map.put("password", "qwer");

ObjectMapper mapper = new ObjectMapper();

String jsonStr = null;

try {

　　jsonStr = mapper.writeValueAsString(map);

} catch (Exception e) {

　　e.printStackTrace();

}

//创建HTTP头部实体，填充头部信息，比如数据格式

HttpHeaders httpHeaders = new HttpHeaders();

httpHeaders.setContentType(MediaType.APPLICATION_JSON_UTF8);

//创建HTTP实体，可以直接利用构造方法将请求体和请求头放进去

HttpEntity httpEntity = new HttpEntity(jsonStr2, httpHeaders);

String url = "http://localhost:80/mandy/user_enable.json";

//调用方法进行请求

Result res2 = restTemplate.postForObject(url, httpEntity, Result.class);

RestTemplate源码：

@Override

public T postForObject(String url, Object request, Class responseType, Object... uriVariables)

throws RestClientException {

RequestCallback requestCallback = httpEntityCallback(request, responseType);

HttpMessageConverterExtractor responseExtractor =

new HttpMessageConverterExtractor(responseType, getMessageConverters(), logger);

return execute(url, HttpMethod.POST, requestCallback, responseExtractor, uriVariables);

}

使用PUT请求：

HashMap map = new HashMap();

map.put("user_id", "1");

map.put("enable", 0);

ObjectMapper mapper = new ObjectMapper();

String jsonStr = null;

try {

jsonStr = mapper.writeValueAsString(map);

} catch (JsonProcessingException e) {

e.printStackTrace();

}

//创建HTTP头部实体，填充头部信息，比如数据格式

HttpHeaders httpHeaders = new HttpHeaders();

httpHeaders.setContentType(MediaType.APPLICATION_JSON_UTF8);

//创建HTTP实体，可以直接利用构造方法将请求体和请求头放进去

HttpEntity httpEntity = new HttpEntity(jsonStr, httpHeaders);

StringQSSulbGL url = "http://localhost:80/mandy/user_enable.json";

restTemplate.put(url , httpEntity);

RestTemplate源码：

@Override

public void put(String url, Object request, Object... urlVariables) throws RestClientException {

RequestCallback requestCallback = httpEntityCallback(request);

execute(url, HttpMethod.PUT, requestCallback, null, urlVariables);

}

这个方法有个小的缺点就是没有请求结果的返回值，如果需要用到返回值，就不能用这个方法。

如果要使用delete类型的请求，RestTemplate的put方法的参数列中只有下面几种

@Override

public void delete(String url, Object... urlVariables) throws RestClientException {

　　execute(url, HttpMethod.DELETE, null, null, urlVariables);

}

@Override

public void delete(String url, Map urlVariables) throws RestClientException {

　　execute(url, HttpMethod.DELETE, null, null, urlVariables);

}

@Override

public void delete(URI url) throws RestClientException {

　　execute(url, HttpMethod.DELETE, null, null);

}

这些方法并没有给我们参数让我们放请求体内容，所以如果要直接使用RestTemplate提供的Delete方法，接口必须使用restful风格，将参数放在地址中，通过@PathVariable(value="")注解将参数获取到。

重点： 其实我们可以直接使用RestTemplate的 exchange 方法，如下

@Override

public ResponseEntity exchange(String url, HttpMethod method,

　　HttpEntity> requestEntity, Class responseType, Object... uriVariables) throws RestClientException {

　　RequestCallback requestCallback = httpEntityCallback(requestEntity, responseType);

　　ResponseExtractor> responseExtractor = responseEntityExtractor(responseType);

　　return execute(url, method, requestCallback, responseExtractor, uriVariables);

}

这里只列举了一个方法，其他的可以看源码，这个方法可以进行所有类型的请求。

在这个方法中，method参数可以通过HTTPMethod枚举来进行获取，requestEntity参数是自己封装的HttpEntity实体，包含请求体和请求头，responseType参数是返回结果的映射类，uriVariables这个参数给我的印象就是鸡肋（个人看法），获取请求返回接口可以通过方法返回值的getBody()方法获取。

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。