Spring RestTemplate具體使用詳解
1、什么是REST?
REST(RepresentationalState Transfer)是Roy Fielding 提出的一個(gè)描述互聯(lián)系統(tǒng)架構(gòu)風(fēng)格的名詞。REST定義了一組體系架構(gòu)原則,您可以根據(jù)這些原則設(shè)計(jì)以系統(tǒng)資源為中心的Web 服務(wù),包括使用不同語言編寫的客戶端如何通過 HTTP處理和傳輸資源狀態(tài)。
為什么稱為 REST?Web本質(zhì)上由各種各樣的資源組成,資源由URI 唯一標(biāo)識(shí)。瀏覽器(或者任何其它類似于瀏覽器的應(yīng)用程序)將展示出該資源的一種表現(xiàn)方式,或者一種表現(xiàn)狀態(tài)。如果用戶在該頁面中定向到指向其它資源的鏈接,則將訪問該資源,并表現(xiàn)出它的狀態(tài)。這意味著客戶端應(yīng)用程序隨著每個(gè)資源表現(xiàn)狀態(tài)的不同而發(fā)生狀態(tài)轉(zhuǎn)移,也即所謂REST。
2、REST成熟度的四個(gè)層次
第一個(gè)層次(Level0)的Web 服務(wù)只是使用 HTTP 作為傳輸方式,實(shí)際上只是遠(yuǎn)程方法調(diào)用(RPC)的一種具體形 式。SOAP和 XML-RPC都屬于此類。
第二個(gè)層次(Level1)的Web 服務(wù)引入了資源的概念。每個(gè)資源有對(duì)應(yīng)的標(biāo)識(shí)符和表達(dá)。
第三個(gè)層次(Level2)的Web 服務(wù)使用不同的 HTTP 方法來進(jìn)行不同的操作,并且使用HTTP 狀態(tài)碼來表示不同的結(jié)果。如 HTTPGET 方法來獲取資源,HTTPDELETE 方法來刪除資源。
第四個(gè)層次(Level3)的Web 服務(wù)使用 HATEOAS。在資源的表達(dá)中包含了鏈接信息??蛻舳丝梢愿鶕?jù)鏈接來發(fā)現(xiàn)可以執(zhí)行的動(dòng)作。
其中第三個(gè)層次建立了創(chuàng)建、讀取、更新和刪除(create,read, update, and delete,CRUD)操作與 HTTP方法之間的一對(duì)一映射。根據(jù)此映射:
(1)若要在服務(wù)器上創(chuàng)建資源,應(yīng)該使用POST 方法。
(2)若要檢索某個(gè)資源,應(yīng)該使用GET 方法。
(3)若要更改資源狀態(tài)或?qū)ζ溥M(jìn)行更新,應(yīng)該使用PUT 方法。
(4)若要?jiǎng)h除某個(gè)資源,應(yīng)該使用DELETE 方法。
3、HTTP請(qǐng)求的方法
(1)GET:通過請(qǐng)求URI得到資源
(2)POST:用于添加新的內(nèi)容
(3)PUT:用于修改某個(gè)內(nèi)容,若不存在則添加
(4)DELETE:刪除某個(gè)內(nèi)容
(5)OPTIONS :詢問可以執(zhí)行哪些方法
(6)HEAD :類似于GET, 但是不返回body信息,用于檢查對(duì)象是否存在,以及得到對(duì)象的元數(shù)據(jù)
(7)CONNECT :用于代理進(jìn)行傳輸,如使用SSL
(8)TRACE:用于遠(yuǎn)程診斷服務(wù)器
4、HTTP請(qǐng)求的狀態(tài)碼
(1)成功Successful2xx:此類狀態(tài)碼標(biāo)識(shí)客戶端的請(qǐng)求被成功接收、理解并接受。常見如200(OK)、204(NoContent)。
(2)重定向Redirection3xx:這個(gè)類別的狀態(tài)碼標(biāo)識(shí)用戶代理要做出進(jìn)一步的動(dòng)作來完成請(qǐng)求。常見如301(MovedPermanently)、302(MovedTemprarily)。
(3)客戶端錯(cuò)誤Client Error 4xx:4xx類別的狀態(tài)碼是當(dāng)客戶端象是出錯(cuò)的時(shí)使用的。常見如400(BadRequest)、401(Unauthorized)、403(Forbidden)、404(NotFound)。
(4)服務(wù)器錯(cuò)誤Server Error 5xx:響應(yīng)狀態(tài)碼以5開頭表示服務(wù)器知道自己出錯(cuò)或者沒有能力執(zhí)行請(qǐng)求。常見如500(InternalServer Error)、502(BadGateway)、504(GatewayTimeout)。
5、RestTemplate
5.1 簡介
Spring'scentral class for synchronous client-side HTTP access.It simplifies communication with HTTPservers, and enforces RESTful principles. Ithandles HTTP connections, leaving application code to provide URLs(with possible template variables) andextract results.
簡單說就是:簡化了發(fā)起HTTP請(qǐng)求以及處理響應(yīng)的過程,并且支持REST。為什么說簡化了呢?
來看兩種實(shí)現(xiàn)方式
(1)使用java.net包下的URLConnection建立連接
String result= "";
BufferedReaderin = null;
try {
String urlNameString= url +"?" + param;
URL realUrl= new URL(urlNameString);
// 打開和URL之間的連接
URLConnectionconnection = realUrlopenConnection();
// 設(shè)置通用的請(qǐng)求屬性
connectionsetRequestProperty("accept","*/*");
connectionsetRequestProperty("connection","Keep-Alive");
connectionsetRequestProperty("user-agent",
"Mozilla/0(compatible; MSIE 0; Windows NT 1;SV1)");
// 建立實(shí)際的連接
connectionconnect();
// 獲取所有響應(yīng)頭字段
Map<String,List<String>> map = connectiongetHeaderFields();
// 遍歷所有的響應(yīng)頭字段
for(String key : mapkeySet()) {
Systemoutprintln(key+ "--->" + mapget(key));
}
// 定義 BufferedReader輸入流來讀取URL的響應(yīng)
in =new BufferedReader(newInputStreamReader(
connectiongetInputStream()));
String line;
while ((line = inreadLine())!= null) {
result += line;
}
} catch (Exception e) {
…
}
// 使用finally塊來關(guān)閉輸入流
finally{
// 關(guān)閉流
}
(2)使用RestTempalte
ResponseEntity<SsoUrlPrm>result = restTemplate.getForEntity(requestPathUrl,SsoUrlPrm.class);
5.2 對(duì)外開放的接口

(1)
| DELETE | delete |
| GET | getForObject |
| getForEntity | |
| HEAD | headForHeaders |
| OPTIONS | optionsForAllow |
| POST | postForLocation |
| postForObject | |
| PUT | put |
| any | exchange |
| execute |
(2)每一個(gè)小類又分三種,這三種有什么區(qū)別?* 第一種和第二種的首個(gè)參數(shù)都是用String表示一個(gè)URI。但它們的最后一個(gè)參數(shù)分別是Object[]和Map* 第三種的首個(gè)參數(shù)使用java.net.URI表示一個(gè)URI。且只有兩個(gè)參數(shù)
這是因?yàn)?,String類型的URI支持占位符。比如:
restTemplate.getForObject("http://example.com/hotels/{hotel}/bookings/{booking}",String.class,"42", "21");
那么最終訪問的URI為:http://example.com/hotels/42/bookings/21
但是String有一個(gè)小缺陷:String形式的URI會(huì)被URL編碼兩次(URL encode請(qǐng)自行百度),這就要求服務(wù)器在獲取URI中的參數(shù)時(shí)主動(dòng)進(jìn)行一次解碼,但如果服務(wù)的提供者不這么做呢?
這時(shí)就需要使用不會(huì)使用任何編碼的java.net.URI
PS:參數(shù)‘Class<T>responseType'定義了返回?cái)?shù)據(jù)的類型。
(3)Exchange與其它接口的不同:
>允許調(diào)用者指定HTTP請(qǐng)求的方法(GET,POST,PUT等)
>可以在請(qǐng)求中增加body以及頭信息,其內(nèi)容通過參數(shù)‘HttpEntity<?>requestEntity'描述
>exchange支持‘含參數(shù)的類型'(即泛型類)作為返回類型,該特性通過‘ParameterizedTypeReference<T>responseType'描述。比如:
List<String> a = new ArrayList<String>();
System.out.println(a.getClass());
System.out.println(a.getClass().getGenericSuperclass());
ParameterizedTypeReference pt = new ParameterizedTypeReference<ArrayList<String>>() {};
System.out.println(pt.getType());
得到的結(jié)果是:
class java.util.ArrayList java.util.AbstractList<E> java.util.ArrayList<java.lang.String>
* 這是因?yàn)镻arameterizedTypeReference<ArrayList<String>>并不根據(jù)實(shí)參而是使用getGenericSuperclass()方法獲取其父類的類型(注意這里的new有花括號(hào),是ParameterizedTypeReference的子類),父類的類型通過java.lang.reflect.Type描述,然后通過Type的getActualTypeArguments()獲得了父類的實(shí)參類型,注意得到的Type類,并不是class類。
(4)excute
所有的get、post、delete、put、options、head、exchange方法最終調(diào)用的都是excute方法。舉個(gè)栗子:
@Override
public <T> T getForObject(String url, Class<T> responseType, Object urlVariables) throws RestClientException {
RequestCallback requestCallback = acceptHeaderRequestCallback(responseType);
HttpMessageConverterExtractor<T> responseExtractor = new HttpMessageConverterExtractor<T>(responseType, getMessageConverters(), logger);
return execute(url, HttpMethodGET, requestCallback, responseExtractor, urlVariables);
}
Excute方法只是將String格式的URI轉(zhuǎn)成了java.net.URI,之后調(diào)用了doExecute方法。整個(gè)調(diào)用過程

6.doExcute
6.1 定義
protected <T> T doExecute(URI url, HttpMethod method, RequestCallback requestCallback,ResponseExtractor<T> responseExtractor) throws RestClientException {…}
這里需要了解兩個(gè)類: RequestCallback &ResponseExtractor
6.2RequestCallback
Callback interface for code that operates on a ClientHttpRequest. Allows to manipulate the request headers, and write to the request body.
簡單說:用于操作請(qǐng)求頭和body,在請(qǐng)求發(fā)出前執(zhí)行。
該接口有兩個(gè)實(shí)現(xiàn)類:
| AcceptHeaderRequestCallback | 只處理請(qǐng)求頭,用于getXXX()方法。 |
| HttpEntityRequestCallback | 繼承于AcceptHeaderRequestCallback可以處理請(qǐng)求頭和body,用于putXXX()、postXXX()和exchange()方法。 |
* DELETE、HEAD、OPTIONS沒有使用這個(gè)接口。
6.3 發(fā)起請(qǐng)求
6.4ResponseExtractor
6.4.1 定義
Generic callback interface used by RestTemplate's retrieval methods Implementations of this interface perform the actual work of extracting data from a ClientHttpResponse, but don't need to worry about exception handling or closing resources.
簡單說:解析HTTP響應(yīng)的數(shù)據(jù),而且不需要擔(dān)心異常和資源的關(guān)閉。
該接口有三個(gè)實(shí)現(xiàn)類:
| HeadersExtractor | 用于提取請(qǐng)求頭。 |
| HttpMessageConverterExtractor | 用于提取響應(yīng)body。 |
| ResponseEntityResponseExtractor | 使用HttpMessageConverterExtractor提取body(委托模式),然后將body和響應(yīng)頭、狀態(tài)封裝成ResponseEntity對(duì)象。 |
6.4.2 提取響應(yīng)body
提取分三步:
(1)提取器HttpMessageConverterExtractor尋找可用的轉(zhuǎn)化器在默認(rèn)的RestTemplate的構(gòu)造函數(shù)中初始化了轉(zhuǎn)化器集合,包括:
|
轉(zhuǎn)化器 |
可轉(zhuǎn)化的類型 |
| ByteArrayHttpMessageConverter | byte[] |
| StringHttpMessageConverter | String |
| ResourceHttpMessageConverter | Resource |
| SourceHttpMessageConverter | javax.xml.transform.* |
| AllEncompassingFormHttpMessageConverter | MultiValueMap |
| Jaxb2RootElementHttpMessageConverter | XmlRootElement,XmlType(注解) |
| ... | |
| MappingJackson2HttpMessageConverter | Json |
除了前五個(gè),其他的轉(zhuǎn)化器會(huì)由classloader嘗試加載某個(gè)類來判斷工程是否包含某個(gè)包,而后決定是否加入轉(zhuǎn)化器集合。
提取器遍歷轉(zhuǎn)化器集合以查找可用的轉(zhuǎn)化器,其中MappingJackson2HttpMessageConverter總是在最后一個(gè),因?yàn)樵擃悓?shí)現(xiàn)了GenericHttpMessageConverter,算是一個(gè)通用轉(zhuǎn)化器,只有在找不到合適的轉(zhuǎn)化器時(shí)才輪到它。Spring提供了一個(gè)該類的實(shí)現(xiàn),以保證總是能得到該類。
(2)轉(zhuǎn)化器尋找可用的反序列化器
轉(zhuǎn)化器持有一個(gè)反序列化器緩存集合,首先從緩存中尋找
如果已有可用的反序列化器,則直接返回。否則創(chuàng)建一個(gè)新的反序列化器。
反序列化器保存著待反序列化類的域、方法、構(gòu)造器等信息,反序列化時(shí)就是使用構(gòu)造器創(chuàng)建了一個(gè)新的實(shí)例。
以jackson為例,創(chuàng)建反序列化器的過程在jackson-databind-xxx.jar中,有興趣的可以看一下。調(diào)用棧如下(由下往上找):
BeanDeserializerFactory.addBeanProps/addObjectIdReader/addReferenceProperties/addInjectables
BeanDeserializerFactory.buildBeanDeserializer
BeanDeserializerFactory.createBeanDeserializer
(3)反序列化器執(zhí)行反序列化
|
TOKEN |
Json的一個(gè)或一組字符 |
| START_OBJECT | { |
| END_OBJECT | } |
| START_ARRAY | [ |
| END_ARRAY | ] |
| VALUE_TRUE | true |
| VALUE_FALSE | false |
| ... |

調(diào)用棧:

以上就是本文的全部內(nèi)容,希望對(duì)大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。
相關(guān)文章
BeanUtils.copyProperties擴(kuò)展--實(shí)現(xiàn)String轉(zhuǎn)Date
這篇文章主要介紹了BeanUtils.copyProperties擴(kuò)展--實(shí)現(xiàn)String轉(zhuǎn)Date操作,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2021-06-06
Java 中 synchronized的用法詳解(四種用法)
Java語言的關(guān)鍵字,當(dāng)它用來修飾一個(gè)方法或者一個(gè)代碼塊的時(shí)候,能夠保證在同一時(shí)刻最多只有一個(gè)線程執(zhí)行該段代碼。本文給大家介紹java中 synchronized的用法,對(duì)本文感興趣的朋友一起看看吧2015-11-11
Mybatis操作多數(shù)據(jù)源的實(shí)現(xiàn)
本文主要介紹了Mybatis操作多數(shù)據(jù)源,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2023-05-05
Java網(wǎng)絡(luò)編程之簡單的服務(wù)端客戶端應(yīng)用實(shí)例
這篇文章主要介紹了Java網(wǎng)絡(luò)編程之簡單的服務(wù)端客戶端應(yīng)用,以實(shí)例形式較為詳細(xì)的分析了java網(wǎng)絡(luò)編程的原理與服務(wù)器端客戶端的實(shí)現(xiàn)技巧,具有一定參考借鑒價(jià)值,需要的朋友可以參考下2015-04-04
SpringBoot CommandLineRunner的異步任務(wù)機(jī)制使用
這篇文章主要介紹了SpringBoot CommandLineRunner的異步任務(wù)機(jī)制使用,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2024-08-08
Java中的動(dòng)態(tài)代理和靜態(tài)代理詳細(xì)解析
這篇文章主要介紹了Java中的動(dòng)態(tài)代理和靜態(tài)代理詳細(xì)解析,Java中的代理可以幫助被代理者完成一些前期的準(zhǔn)備工作和后期的善后工作,但是核心的業(yè)務(wù)邏輯仍然是由被代理者完成,需要的朋友可以參考下2023-11-11
Intellij IDEA命令行執(zhí)行java無法加載主類解決方案
這篇文章主要介紹了Intellij IDEA命令行執(zhí)行java無法加載主類解決方案,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-09-09

