一. 什么是RestTemplate
Spring's central class for synchronous client-side HTTP access.
It simplifies communication with HTTP servers, and enforces RESTful principles.
It handles HTTP connections, leaving application code to provide URLs(with possible template variables) and extract results.
上面這段是RestTemplate類中的簡單介紹，RestTemplate是Spring3.0后開始提供的用于訪問 Rest 服務的輕量級客戶端，相較于傳統的HttpURLConnection、Apache HttpClient、OkHttp等框架，RestTemplate大大簡化了發起HTTP請求以及處理響應的過程。本文關注RestTemplate是如何使用的，暫不涉及內部的實現原理。
二.一個簡單的例子。
定義一個簡單的restful接口
@RestControllerpublic class TestController{ @RequestMapping(value = "testPost", method = RequestMethod.POST) public ResponseBean testPost(@RequestBody RequestBean requestBean) { ResponseBean responseBean = new ResponseBean(); responseBean.setRetCode("0000"); responseBean.setRetMsg("succ"); return responseBean; }}使用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。
三.手動指定轉換器(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中呢。
RestTemplate restTemplate = new RestTemplate(); //獲取RestTemplate默認配置好的所有轉換器 List<HttpMessageConverter<?>> messageConverters = restTemplate.getMessageConverters(); //默認的MappingJackson2HttpMessageConverter在第7個 先把它移除掉 messageConverters.remove(6); //添加上GSON的轉換器 messageConverters.add(6, new GsonHttpMessageConverter());
這個簡單的例子展示了如何使用GsonHttpMessageConverter替換掉默認用來處理application/json的MappingJackson2HttpMessageConverter。
四.設置底層連接方式
要創建一個RestTemplate的實例，您可以像上述例子中簡單地調用默認的無參數構造函數。這將使用java.net包中的標準Java類作為底層實現來創建HTTP請求。
但很多時候我們需要像傳統的HttpClient那樣設置HTTP請求的一些屬性。RestTemplate使用了一種很偷懶的方式實現了這個需求，那就是直接使用一個HttpClient作為底層實現......
//生成一個設置了連接超時時間、請求超時時間、異常最大重試次數的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);
五.設置攔截器(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方便快捷的訪問restful接口。其實RestTemplate的功能非常強大，作者也僅僅學了點皮毛。
以上就是本文的全部內容，希望對大家的學習有所幫助，也希望大家多多支持VeVb武林網。
新聞熱點
疑難解答
圖片精選
