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用來幹什麼？

1.一個簡單的例子

定義一個簡單的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訪問該服務

        //請求地址
        String url = "http://localhost:8080/testPost";
        //入參
        RequestBean requestBean = new RequestBean();
        requestBean.setTest1("1");
        requestBean.setTest2("2");
        requestBean.setTest3("3");

        RestTemplate restTemplate = new RestTemplate();
        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。

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