一、什么玩意？

spring框架提供的RestTemplate类可用于在应用中调用rest服务，它简化了与http服务的通信方式，统一了RESTful的标准，封装了http链接，我们只需要传入url及返回值类型即可。相较于之前常用的HttpClient，RestTemplate是一种更优雅的调用RESTful服务的方式。

在Spring应用程序中访问第三方REST服务与使用Spring RestTemplate类有关。RestTemplate类的设计原则与许多其他Spring *模板类(例如JdbcTemplate、JmsTemplate)相同，为执行复杂任务提供了一种具有默认行为的简化方法。

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实例化及配置

配置使用默认的RestTemplateBuilder
为了配置一个RestTemplate 这个方法，我们需要在我们的类中注入spring boot提供默认的RestTemplateBuilder bean

/**
     * 启动的时候要注意，由于我们在controller中注入了RestTemplate，所以启动的时候需要实例化该类的一个实例
     */
    @Autowired
    private RestTemplateBuilder builder;

    /**
     * 使用RestTemplateBuilder来实例化RestTemplate对象，spring默认已经注入了RestTemplateBuilder实例
     *
     * @return RestTemplate
     */
    @Bean
    public RestTemplate restTemplate() {
        return builder.build();
    }

其他实例化方式

三、简单例子

/**
     * 响应请求
     */
    @RequestMapping(value = "testPost", method = RequestMethod.POST)
    public ResponseBean testPost(@RequestBody ResponseBean requestBean) {
        ResponseBean responseBean = new ResponseBean();
        responseBean.setRetCode("0000");
        responseBean.setRetMsg("succ");

        return responseBean;
    }

    /**
     * 发送请求
     */
    @RequestMapping(value = "callTestPost", method = RequestMethod.GET)
    public void callTestPost() {
        //请求地址
        String url = "https://localhost:9091/testPost";
        //入参
        RequestBean requestBean = new RequestBean();
        requestBean.setTest1("1");
        requestBean.setTest2("2");
        requestBean.setTest3("3");

        ResponseBean responseBean = restTemplate.postForObject(url, requestBean, ResponseBean.class);
        System.out.println(responseBean.toString());
    }

** RequestBean ResponseBean 是自己定义的测试实体类

说明

1.参数介绍

(url, requestMap, ResponseBean.class)这三个参数分别代表

请求地址
请求参数
HTTP响应转换被转换成的对象类型。

2.方法命名规则

RestTemplate方法的名称遵循命名约定，

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

四、自定义转换器

我们知道，调用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中呢。

        RestTemplate restTemplate = new RestTemplate();
        //获取RestTemplate默认配置好的所有转换器
        List> messageConverters = restTemplate.getMessageConverters();
        //默认的MappingJackson2HttpMessageConverter在第7个 先把它移除掉
        //此处建议是使用循环遍历方式更为严谨
        messageConverters.remove(6);
        //添加上GSON的转换器
        messageConverters.add(6, new GsonHttpMessageConverter());

这个简单的例子展示了如何使用GsonHttpMessageConverter替换掉默认用来处理application/json的MappingJackson2HttpMessageConverter。

五、设置Http请求参数

方式1：创建RestTemplate时，指定http参数

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

方式二：

 try {  
    
          //复杂构造函数的使用  
         SimpleClientHttpRequestFactory requestFactory = new SimpleClientHttpRequestFactory();  
         requestFactory.setConnectTimeout(1000);// 设置超时  
         requestFactory.setReadTimeout(1000);  
   
        //利用复杂构造器可以实现超时设置，内部实际实现为 HttpClient  
         RestTemplate restTemplate = new RestTemplate(requestFactory);  
   
         //设置HTTP请求头信息，实现编码等  
         HttpHeaders requestHeaders = new HttpHeaders();  
         // requestHeaders.set("Accept", "text/");  
         requestHeaders.set("Accept-Charset", "utf-8");  
        requestHeaders.set("Content-type", "text/xml; charset=utf-8");// 设置编码  
   
         //利用容器实现数据封装，发送  
        HttpEntity entity = new HttpEntity(mRequestXml, requestHeaders);  
         returnXml = restTemplate.postForObject(mUrl, entity, String.class);  
   
         // 转码原因：RestTemplate默认是使用org.springframework.http.converter.StringHttpMessageConverter来解析  
         // StringHttpMessageConverter 默认用的 ISO-8859-1来编码的  
         returnXml = new String(returnXml.getBytes("ISO-8859-1"), "utf-8");  
   
     } catch (UnsupportedEncodingException e) {  
         e.printStackTrace();  
     }  
   
     System.out.println("restTemplate客户端访问返回： \n" + returnXml);

六、设置拦截器(ClientHttpRequestInterceptor)

有时候我们需要对请求做一些通用的拦截设置，这就可以使用拦截器进行处理。拦截器需要我们实现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实例的时候可以这样向其中添加拦截器

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

RestTemplate