Spring RestTemplate 的介绍和使用-入门

RestTemplate是什么？

传统情况下在java代码里访问restful服务，一般使用Apache的HttpClient。不过此种方法使用起来太过繁琐。spring提供了一种简单便捷的模板类来进行操作，这就是RestTemplate。

它简化了与http服务的通信方式，统一了restful的标准，封装了http链接，我们只需要传入url及返回值类型即可。

RestTemplate默认依赖JDK提供http连接的能力（HttpURLConnection），如果有需要的话也可以通过setRequestFactory方法替换为例如 Apache HttpComponents、Netty或OkHttp等其它HTTP library。

考虑到RestTemplate类是为调用REST服务而设计的，因此它的主要方法与REST的基础紧密相连就不足为奇了，后者是HTTP协议的方法:HEAD、GET、POST、PUT、DELETE和OPTIONS。例如，RestTemplate类具有headForHeaders()、getForObject()、postForObject()、put()和delete()等方法。

RestTemplate用来干什么？

RestTemplate能大幅简化了提交表单数据的难度，并且附带了自动转换JSON数据的功能，但只有理解了HttpEntity的组成结构（header与body），且理解了与uriVariables之间的差异，才能真正掌握其用法。

该类的入口主要是根据HTTP的六个方法制定：

exchange和excute可以通用上述方法

1.几个简单的例子

1.1postForObject请求restful接口（查看该博客 RESTful接口详解可详细了解什么是restful接口）

 1 @RestController
 2 public class TestController
 3 {
 4     @RequestMapping(value = "testPost", method = RequestMethod.POST)
 5     public ResponseBean testPost(@RequestBody RequestBean requestBean)
 6     {
 7         ResponseBean responseBean = new ResponseBean();
 8         responseBean.setRetCode("0000");
 9         responseBean.setRetMsg("succ");
10 
11         return responseBean;
12     }
13 }

使用RestTemplate访问该服务

 1  　　　　//请求地址
 2         String url = "http://localhost:8080/testPost";
 3         //入参
 4         RequestBean requestBean = new RequestBean();
 5         requestBean.setTest1("1");
 6         requestBean.setTest2("2");
 7         requestBean.setTest3("3");
 8 
 9         RestTemplate restTemplate = new RestTemplate();
10         ResponseBean responseBean = restTemplate.postForObject(url, requestBean, ResponseBean.class);

从这个例子可以看出，使用restTemplate访问restful接口非常的简单粗暴无脑。(url, requestMap, ResponseBean.class)这三个参数分别代表请求地址、请求参数、HTTP响应转换被转换成的对象类型。

RestTemplate方法的名称遵循命名约定，第一部分指出正在调用什么HTTP方法，第二部分指示返回的内容。本例中调用了restTemplate.postForObject方法，post指调用了HTTP的post方法，Object指将HTTP响应转换为您选择的对象类型。还有其他很多类似的方法，有兴趣的同学可以参考官方api。

1.2exchange指定调用方式

exchange()方法跟上面的getForObject()、getForEntity()、postForObject()、postForEntity()等方法不同之处在于它可以指定请求的HTTP类型。

 1     public void rtExchangeTest() throws JSONException {
 2         RestTemplate restTemplate = new RestTemplate();
 3         String url = "http://xxx.top/notice/list";
 4         HttpHeaders headers = new HttpHeaders();
 5         headers.setContentType(MediaType.APPLICATION_FORM_URLENCODED);
 6         JSONObject jsonObj = new JSONObject();
 7         jsonObj.put("start",1);
 8         jsonObj.put("page",5);
 9  
10         HttpEntity<String> entity = new HttpEntity<>(jsonObj.toString(), headers);
11         ResponseEntity<JSONObject> exchange = restTemplate.exchange(url,HttpMethod.GET, entity, JSONObject.class);
12         System.out.println(exchange.getBody());
13     }

1.3excute()指定调用方式

excute()的用法与exchange()大同小异了，它同样可以指定不同的HttpMethod，不同的是它返回的对象是响应体所映射成的对象，而不是ResponseEntity。此处就不做代码展示了。

需要强调的是，execute()方法是以上所有方法的底层调用。比如postForObject：

 1 @Override
 2     @Nullable
 3     public <T> T postForObject(String url, @Nullable Object request, Class<T> responseType, Map<String, ?> uriVariables)
 4             throws RestClientException {
 5  
 6         RequestCallback requestCallback = httpEntityCallback(request, responseType);
 7         HttpMessageConverterExtractor<T> responseExtractor =
 8                 new HttpMessageConverterExtractor<>(responseType, getMessageConverters(), logger);
 9         return execute(url, HttpMethod.POST, requestCallback, responseExtractor, uriVariables);
10     }

2.手动指定转换器(HttpMessageConverter)

我们知道，调用reseful接口传递的数据内容是json格式的字符串，返回的响应也是json格式的字符串。然而restTemplate.postForObject方法的请求参数RequestBean和返回参数ResponseBean却都是java类。是RestTemplate通过HttpMessageConverter自动帮我们做了转换的操作。

默认情况下RestTemplate自动帮我们注册了一组HttpMessageConverter用来处理一些不同的contentType的请求。

如StringHttpMessageConverter来处理text/plain;MappingJackson2HttpMessageConverter来处理application/json;MappingJackson2XmlHttpMessageConverter来处理application/xml。
你可以在org.springframework.http.converter包下找到所有spring帮我们实现好的转换器。
如果现有的转换器不能满足你的需求，你还可以实现org.springframework.http.converter.HttpMessageConverter接口自己写一个。详情参考官方api。

选好了HttpMessageConverter后怎么把它注册到我们的RestTemplate中呢。以下这个例子展示了如何使用GsonHttpMessageConverter替换掉默认用来处理application/json的MappingJackson2HttpMessageConverter。

1         RestTemplate restTemplate = new RestTemplate();
2         //获取RestTemplate默认配置好的所有转换器
3         List<HttpMessageConverter<?>> messageConverters = restTemplate.getMessageConverters();
4         //默认的MappingJackson2HttpMessageConverter在第7个 先把它移除掉
5         messageConverters.remove(6);
6         //添加上GSON的转换器
7         messageConverters.add(6, new GsonHttpMessageConverter());

3.设置底层连接方式

要创建一个RestTemplate的实例，您可以像上述例子中简单地调用默认的无参数构造函数。这将使用java.net包中的标准Java类作为底层实现来创建HTTP请求。
但很多时候我们需要像传统的HttpClient那样设置HTTP请求的一些属性。RestTemplate使用了一种很偷懒的方式实现了这个需求，那就是直接使用一个HttpClient作为底层实现......

1         //生成一个设置了连接超时时间、请求超时时间、异常最大重试次数的httpClient
2         RequestConfig config = RequestConfig.custom().setConnectionRequestTimeout(10000).setConnectTimeout(10000).setSocketTimeout(30000).build();
3         HttpClientBuilder builder = HttpClientBuilder.create().setDefaultRequestConfig(config).setRetryHandler(new DefaultHttpRequestRetryHandler(5, false));
4         HttpClient httpClient = builder.build();
5         //使用httpClient创建一个ClientHttpRequestFactory的实现
6         ClientHttpRequestFactory requestFactory = new HttpComponentsClientHttpRequestFactory(httpClient);
7          //ClientHttpRequestFactory作为参数构造一个使用作为底层的RestTemplate
8         RestTemplate restTemplate = new RestTemplate(requestFactory);

4.设置拦截器

需要对请求做一些通用的拦截设置，这就可以使用拦截器进行处理。拦截器需要我们实现org.springframework.http.client.ClientHttpRequestInterceptor接口自己写。

举个简单的例子，写一个在header中根据请求内容和地址添加令牌的拦截器。

public class TokenInterceptor implements ClientHttpRequestInterceptor
{
    @Override
    public ClientHttpResponse intercept(HttpRequest request, byte[] body, ClientHttpRequestExecution execution) throws IOException
    {
        //请求地址
        String checkTokenUrl = request.getURI().getPath();
        //token有效时间
        int ttTime = (int) (System.currentTimeMillis() / 1000 + 1800);
        //请求方法名 POST、GET等
        String methodName = request.getMethod().name();
        //请求内容
        String requestBody = new String(body);
        //生成令牌 此处调用一个自己写的方法，有兴趣的朋友可以自行google如何使用ak/sk生成token，此方法跟本教程无关，就不贴出来了
        String token = TokenHelper.generateToken(checkTokenUrl, ttTime, methodName, requestBody);
        //将令牌放入请求header中
        request.getHeaders().add("X-Auth-Token",token);

        return execution.execute(request, body);
    }
}

创建RestTemplate实例的时候可以这样向其中添加拦截器

1         RestTemplate restTemplate = new RestTemplate();
2         //向restTemplate中添加自定义的　　拦截器
3         restTemplate.getInterceptors().add(new TokenInterceptor());

可学习博客：

1.Springboot — 用更优雅的方式发HTTP请求(RestTemplate详解)

2.RestTemplate使用教程

3.RestTemplate