springboot集成RestTemplate及常見的用法說明
一、背景介紹
在微服務(wù)都是以HTTP接口的形式暴露自身服務(wù)的，因此在調(diào)用遠程服務(wù)時就必須使用HTTP客戶端。我們可以使用JDK原生的URLConnection、Apache的Http Client、Netty的異步HTTP Client, Spring的RestTemplate。
這里介紹的是RestTemplate。RestTemplate底層用還是HttpClient，對其做了封裝，使用起來更簡單。
1、什么是RestTemplate？
RestTemplate是Spring提供的用于訪問Rest服務(wù)的客戶端，RestTemplate提供了多種便捷訪問遠程Http服務(wù)的方法,能夠大大提高客戶端的編寫效率。
調(diào)用RestTemplate的默認構(gòu)造函數(shù)，RestTemplate對象在底層通過使用java.net包下的實現(xiàn)創(chuàng)建HTTP 請求，可以通過使用ClientHttpRequestFactory指定不同的HTTP請求方式。
ClientHttpRequestFactory接口主要提供了兩種實現(xiàn)方式
1、一種是SimpleClientHttpRequestFactory，使用J2SE提供的方式（既java.net包提供的方式）創(chuàng)建底層的Http請求連接。
2、一種方式是使用HttpComponentsClientHttpRequestFactory方式，底層使用HttpClient訪問遠程的Http服務(wù)，使用HttpClient可以配置連接池和證書等信息。
其實spring并沒有真正的去實現(xiàn)底層的http請求（3次握手），而是集成了別的http請求，spring只是在原有的各種http請求進行了規(guī)范標準，讓開發(fā)者更加簡單易用，底層默認用的是jdk的http請求。
2、RestTemplate的優(yōu)缺點
- 優(yōu)點：連接池、超時時間設(shè)置、支持異步、請求和響應(yīng)的編解碼
- 缺點：依賴別的spring版塊、參數(shù)傳遞不靈活
RestTemplate默認是使用SimpleClientHttpRequestFactory，內(nèi)部是調(diào)用jdk的HttpConnection，默認超時為-1
@Autowired RestTemplate simpleRestTemplate; @Autowired RestTemplate restTemplate;
二、配置RestTemplate
1、引入依賴
<dependency>
<groupId>org.apache.httpcomponents</groupId>
<artifactId>httpclient</artifactId>
<version>4.5.6</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
2、連接池配置
#最大連接數(shù) http.maxTotal: 100 #并發(fā)數(shù) http.defaultMaxPerRoute: 20 #創(chuàng)建連接的最長時間 http.connectTimeout: 1000 #從連接池中獲取到連接的最長時間 http.connectionRequestTimeout: 500 #數(shù)據(jù)傳輸?shù)淖铋L時間 http.socketTimeout: 10000 #提交請求前測試連接是否可用 http.staleConnectionCheckEnabled: true #可用空閑連接過期時間,重用空閑連接時會先檢查是否空閑時間超過這個時間，如果超過，釋放socket重新建立 http.validateAfterInactivity: 3000000
3、初始化連接池
package com.example.demo.config;
import org.apache.http.client.HttpClient;
import org.apache.http.client.config.RequestConfig;
import org.apache.http.config.Registry;
import org.apache.http.config.RegistryBuilder;
import org.apache.http.conn.socket.ConnectionSocketFactory;
import org.apache.http.conn.socket.PlainConnectionSocketFactory;
import org.apache.http.conn.ssl.SSLConnectionSocketFactory;
import org.apache.http.impl.client.HttpClientBuilder;
import org.apache.http.impl.conn.PoolingHttpClientConnectionManager;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.client.ClientHttpRequestFactory;
import org.springframework.http.client.HttpComponentsClientHttpRequestFactory;
import org.springframework.web.client.RestTemplate;
@Configuration
public class RestTemplateConfig {
@Value("${http.maxTotal}")
private Integer maxTotal;
@Value("${http.defaultMaxPerRoute}")
private Integer defaultMaxPerRoute;
@Value("${http.connectTimeout}")
private Integer connectTimeout;
@Value("${http.connectionRequestTimeout}")
private Integer connectionRequestTimeout;
@Value("${http.socketTimeout}")
private Integer socketTimeout;
@Value("${http.staleConnectionCheckEnabled}")
private boolean staleConnectionCheckEnabled;
@Value("${http.validateAfterInactivity}")
private Integer validateAfterInactivity;
@Bean
public RestTemplate restTemplate() {
return new RestTemplate(httpRequestFactory());
}
@Bean
public ClientHttpRequestFactory httpRequestFactory() {
return new HttpComponentsClientHttpRequestFactory(httpClient());
}
@Bean
public HttpClient httpClient() {
Registry<ConnectionSocketFactory> registry = RegistryBuilder.<ConnectionSocketFactory>create()
.register("http", PlainConnectionSocketFactory.getSocketFactory())
.register("https", SSLConnectionSocketFactory.getSocketFactory())
.build();
PoolingHttpClientConnectionManager connectionManager = new PoolingHttpClientConnectionManager(registry);
connectionManager.setMaxTotal(maxTotal); // 最大連接數(shù)
connectionManager.setDefaultMaxPerRoute(defaultMaxPerRoute); //單個路由最大連接數(shù)
connectionManager.setValidateAfterInactivity(validateAfterInactivity); // 最大空間時間
RequestConfig requestConfig = RequestConfig.custom()
.setSocketTimeout(socketTimeout) //服務(wù)器返回數(shù)據(jù)(response)的時間，超過拋出read timeout
.setConnectTimeout(connectTimeout) //連接上服務(wù)器(握手成功)的時間，超出拋出connect timeout
.setStaleConnectionCheckEnabled(staleConnectionCheckEnabled) // 提交前檢測是否可用
.setConnectionRequestTimeout(connectionRequestTimeout)//從連接池中獲取連接的超時時間，超時間未拿到可用連接，會拋出org.apache.http.conn.ConnectionPoolTimeoutException: Timeout waiting for connection from pool
.build();
return HttpClientBuilder.create()
.setDefaultRequestConfig(requestConfig)
.setConnectionManager(connectionManager)
.build();
}
}
4、使用示例
RestTemplate是對HttpCilent的封裝，所以，依HttpCilent然可以繼續(xù)使用HttpCilent?？聪聝烧叩膮^(qū)別
HttpCilent：
@RequestMapping("/testHttpClient")
@ResponseBody
public Object getUser(String msg) throws IOException {
CloseableHttpClient closeableHttpClient = HttpClients.createDefault();
HttpGet get = new HttpGet("http://192.168.1.100:8080/User/getAllUser");
CloseableHttpResponse response = closeableHttpClient.execute(get);
return EntityUtils.toString(response.getEntity(), "utf-8");
}
RestTemplate：
@RequestMapping("/testRestTemplate")
@ResponseBody
public Object testRestTemplate() throws IOException {
ResponseEntity result = restTemplate.getForEntity("http://192.168.1.100:8080/User/getAllUser",ResponseEntity.class;
return result.getBody();
}
RestTemplate更簡潔了。
三、RestTemplate常用方法
1、getForEntity
getForEntity方法的返回值是一個ResponseEntity<T>，ResponseEntity<T>是Spring對HTTP請求響應(yīng)的封裝，包括了幾個重要的元素，如響應(yīng)碼、contentType、contentLength、響應(yīng)消息體等。比如下面一個例子：
@RequestMapping("/sayhello")
public String sayHello() {
ResponseEntity<String> responseEntity = restTemplate.getForEntity("http://HELLO-SERVICE/sayhello?name={1}", String.class, "張三");
return responseEntity.getBody();
}
@RequestMapping("/sayhello2")
public String sayHello2() {
Map<String, String> map = new HashMap<>();
map.put("name", "李四");
ResponseEntity<String> responseEntity = restTemplate.getForEntity("http://HELLO-SERVICE/sayhello?name={name}", String.class, map);
return responseEntity.getBody();
}
2、getForObject
getForObject函數(shù)實際上是對getForEntity函數(shù)的進一步封裝，如果你只關(guān)注返回的消息體的內(nèi)容，對其他信息都不關(guān)注，此時
可以使用getForObject，舉一個簡單的例子，如下：
@RequestMapping("/book2")
public Book book2() {
Book book = restTemplate.getForObject("http://HELLO-SERVICE/getbook1", Book.class);
return book;
}
3、postForEntity
@RequestMapping("/book3")
public Book book3() {
Book book = new Book();
book.setName("紅樓夢");
ResponseEntity<Book> responseEntity = restTemplate.postForEntity("http://HELLO-SERVICE/getbook2", book, Book.class);
return responseEntity.getBody();
}
- 方法的第一參數(shù)表示要調(diào)用的服務(wù)的地址
- 方法的第二個參數(shù)表示上傳的參數(shù)
- 方法的第三個參數(shù)表示返回的消息體的數(shù)據(jù)類型
4、postForObject
如果你只關(guān)注，返回的消息體，可以直接使用postForObject。用法和getForObject一致。
5、postForLocation
postForLocation也是提交新資源，提交成功之后，返回新資源的URI，postForLocation的參數(shù)和前面兩種的參數(shù)基本一致，只不過該方法的返回值為Uri，這個只需要服務(wù)提供者返回一個Uri即可，該Uri表示新資源的位置。
6、PUT請求
在RestTemplate中，PUT請求可以通過put方法調(diào)用，put方法的參數(shù)和前面介紹的postForEntity方法的參數(shù)基本一致，只是put方法沒有返回值而已。舉一個簡單的例子，如下：
@RequestMapping("/put")
public void put() {
Book book = new Book();
book.setName("紅樓夢");
restTemplate.put("http://HELLO-SERVICE/getbook3/{1}", book, 99);
}
7、DELETE請求
delete請求我們可以通過delete方法調(diào)用來實現(xiàn)，如下例子：
@RequestMapping("/delete")
public void delete() {
restTemplate.delete("http://HELLO-SERVICE/getbook4/{1}", 100);
}
以上為個人經(jīng)驗，希望能給大家一個參考，也希望大家多多支持腳本之家。
相關(guān)文章
使用Java將字符串在ISO-8859-1和UTF-8之間相互轉(zhuǎn)換
大家都知道在一些情況下，我們需要特殊的編碼格式，如：UTF-8,但是系統(tǒng)默認的編碼為ISO-8859-1，遇到這個問題，該如何對字符串進行兩個編碼的轉(zhuǎn)換呢，下面小編給大家分享下java中如何在ISO-8859-1和UTF-8之間相互轉(zhuǎn)換，感興趣的朋友一起看看吧2021-12-12
圖片經(jīng)過base64編碼轉(zhuǎn)換后,文件會變大的原因是因為base64編碼會將每個3字節(jié)的數(shù)據(jù)轉(zhuǎn)換成4字節(jié)的數(shù)據(jù),并且在轉(zhuǎn)換的過程中還會添加一些額外的字符,這篇文章主要介紹了Java 中如何對圖片進行壓縮處理,需要的朋友可以參考下2023-09-09
java WSDL接口webService實現(xiàn)方式
這篇文章主要為大家詳細介紹了java WSDL接口webService實現(xiàn)方式的相關(guān)資料，具有一定的參考價值，感興趣的小伙伴們可以參考一下2017-04-04
Spring源碼學(xué)習(xí)之動態(tài)代理實現(xiàn)流程
這篇文章主要給大家介紹了關(guān)于Spring源碼學(xué)習(xí)之動態(tài)代理實現(xiàn)流程的相關(guān)資料，文中通過示例代碼介紹的非常詳細，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2021-03-03
java -D參數(shù)設(shè)置系統(tǒng)屬性無效問題及解決
這篇文章主要介紹了java -D參數(shù)設(shè)置系統(tǒng)屬性無效問題及解決方案，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2022-12-12
SpringBoot整合Swagger3生成接口文檔的示例代碼
Swagger 是一個 RESTful API 的開源框架,它的主要目的是幫助開發(fā)者設(shè)計、構(gòu)建、文檔化和測試 Web API,本文給大家介紹了SpringBoot整合Swagger3生成接口文檔的流程,并通過代碼講解的非常詳細,需要的朋友可以參考下2024-04-04
策略模式屬于Java-設(shè)計模式中行為模式之一，該模式定義了一系列算法，并將每個算法封裝起來，使它們可以相互替換。本文將通過示例詳細講解這一模式，需要的可以參考一下2022-09-09
Java 如何讀取Excel格式xls、xlsx數(shù)據(jù)工具類
這篇文章主要介紹了Java 如何讀取Excel格式xls、xlsx數(shù)據(jù)工具類的操作，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2021-09-09
Spring Cloud Feign請求添加headers的實現(xiàn)方式
這篇文章主要介紹了Spring Cloud Feign請求添加headers的實現(xiàn)方式，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2023-04-04
搭建 springboot selenium 網(wǎng)頁文件轉(zhuǎn)圖片環(huán)境的詳細教程
這篇文章主要介紹了搭建 springboot selenium 網(wǎng)頁文件轉(zhuǎn)圖片環(huán)境,本文給大家介紹的非常詳細，對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值，需要的朋友可以參考下2020-08-08