Spring學習筆記之RestTemplate使用小結
前言
作為一個Java后端，需要通過HTTP請求其他的網(wǎng)絡資源可以說是一個比較常見的case了；一般怎么做呢？
可能大部分的小伙伴直接撈起Apache的HttpClient開始做，或者用其他的一些知名的開源庫如OkHttp, 當然原生的HttpURLConnection也是沒問題的
本篇博文則主要關注點放在Sprig的生態(tài)下，利用RestTemplate來發(fā)起Http請求的使用姿勢
I. RestTempalate 基本使用
0. 目標
在介紹如何使用RestTemplate之前，我們先拋出一些小目標，至少需要知道通過RestTemplate可以做些什么，以及我們要用它來干些什么
簡單的給出了一下常見的問題如下
- 普通的Get請求獲取返回數(shù)據(jù)，怎么玩？
- post提交表達的請求，如何處理
- post請求中RequestBody的請求方式與普通的請求方式區(qū)別
- https/http兩種訪問如何分別處理
- 如何在請求中帶上指定的Header
- 有跨域的問題么？如果有怎么解決
- 有登錄驗證的請求，該怎么辦，怎樣攜帶身份信息
- 上傳文件可以支持么
- 對于需要代理才能訪問的http資源，加代理的姿勢是怎樣的
上面的問題比較多，目測不是一篇博文可以弄完的，因此對這個拆解一下，本篇主要關注在RestTemplate的簡單Get/Post請求的使用方式上
1. 基本接口
撈出源碼，看一下其給出的一些常用接口，基本上可以分為下面幾種
// get 請求 public <T> T getForObject(); public <T> ResponseEntity<T> getForEntity(); // head 請求 public HttpHeaders headForHeaders(); // post 請求 public URI postForLocation(); public <T> T postForObject(); public <T> ResponseEntity<T> postForEntity(); // put 請求 public void put(); // pathch public <T> T patchForObject // delete public void delete() // options public Set<HttpMethod> optionsForAllow // exchange public <T> ResponseEntity<T> exchange()
上面提供的幾個接口，基本上就是Http提供的幾種訪問方式的對應，其中exchange卻又不一樣，后面細說
2. Get請求
從上面的接口命名上，可以看出可以使用的有兩種方式 getForObject 和 getForEntity，那么這兩種有什么區(qū)別？
- 從接口的簽名上，可以看出一個是直接返回預期的對象，一個則是將對象包裝到 ResponseEntity 封裝類中
- 如果只關心返回結果，那么直接用 GetForObject 即可
- 如果除了返回的實體內容之外，還需要獲取返回的header等信息，則可以使用 getForEntit
a. 創(chuàng)建Get接口
為了驗證RestTemplate的使用姿勢，當然得先提供一個后端的REST服務，這了直接用了我個人的一個古詩詞的后端接口，來作為簡單的Get測試使用
請求連接： https://story.hhui.top/detail?id=666106231640
返回結果:
{
"status": {
"code": 200,
"msg": "SUCCESS"
},
"result": {
"id": 666106231640,
"title": "西塞山二首（今謂之道士磯，即興國軍大冶縣",
"author": "王周",
"content": "西塞名山立翠屏，濃嵐橫入半江青。\n千尋鐵鎖無由問，石壁空存道者形。\n匹婦頑然莫問因，匹夫何去望千春。\n翻思岵屺傳詩什，舉世曾無化石人。",
"explain": "",
"theme": "無",
"dynasty": "唐詩"
}
}
b. getForObject方式
首先看下完整的接口簽名
@Nullable public <T> T getForObject(String url, Class<T> responseType, Object... uriVariables) throws RestClientException ; @Nullable public <T> T getForObject(String url, Class<T> responseType, Map<String, ?> uriVariables) throws RestClientException ; @Nullable public <T> T getForObject(URI url, Class<T> responseType) throws RestClientException;
有三個重載的方法，從接口上也比較容易看出如何使用，其中有點疑惑的則是第一鐘，參數(shù)應該怎么傳了，下面給出上面幾種的使用姿勢
public class RestTestmplateTest {
private RestTemplate restTemplate;
@Before
public void init() {
restTemplate = new RestTemplate();
}
@lombok.Data
static class InnerRes {
private Status status;
private Data result;
}
@lombok.Data
static class Status {
int code;
String msg;
}
@lombok.Data
static class Data {
long id;
String theme;
String title;
String dynasty;
String explain;
String content;
String author;
}
@Test
public void testGet() {
// 使用方法一，不帶參數(shù)
String url = "https://story.hhui.top/detail?id=666106231640";
InnerRes res = restTemplate.getForObject(url, InnerRes.class);
System.out.println(res);
// 使用方法一，傳參替換
url = "https://story.hhui.top/detail?id={?}";
res = restTemplate.getForObject(url, InnerRes.class, "666106231640");
System.out.println(res);
// 使用方法二，map傳參
url = "https://story.hhui.top/detail?id={id}";
Map<String, Object> params = new HashMap<>();
params.put("id", 666106231640L);
res = restTemplate.getForObject(url, InnerRes.class, params);
System.out.println(res);
// 使用方法三，URI訪問
URI uri = URI.create("https://story.hhui.top/detail?id=666106231640");
res = restTemplate.getForObject(uri, InnerRes.class);
System.out.println(res);
}
}
看上面的testcase，后面兩個方法的使用沒什么好說的，主要看一下org.springframework.web.client.RestTemplate#getForObject(java.lang.String, java.lang.Class<T>, java.lang.Object...) 的使用姿勢
- 根據(jù)實際傳參替換url模板中的內容
- 使用方法一時，模板中使用 {?} 來代表坑位，根據(jù)實際的傳參順序來填充
- 使用方法二時，模板中使用 {xx}, 而這個xx，對應的就是map中的key
上面執(zhí)行后的截圖如下
c. getForEntity方式
既然getForObject有三種使用方法，那么getForEntity理論上也應該有對應的三種方式
public <T> ResponseEntity<T> getForEntity(String url, Class<T> responseType, Object... uriVariables) throws RestClientException ; public <T> ResponseEntity<T> getForEntity(String url, Class<T> responseType, Map<String, ?> uriVariables) throws RestClientException; public <T> ResponseEntity<T> getForEntity(URI url, Class<T> responseType) throws RestClientException;
因為使用姿勢和上面一致，因此只拿一個進行測試
@Test
public void testGetForEntity() {
String url = "https://story.hhui.top/detail?id=666106231640";
ResponseEntity<InnerRes> res = restTemplate.getForEntity(url, InnerRes.class);
System.out.println(res);
}
對這個，我們主要關注的就是ResponseEntity封裝中，多了哪些東西，截圖如下
從上面可以看出，多了兩個東西
- 一個返回的http狀態(tài)碼，如200表示請求成功，500服務器錯誤，404not found等
- 一個 ResponseHeader
3. Post請求
從上面的接口說明上看，post請求除了有forObject 和 forEntity之外，還多了個forLocation；其次post與get一個明顯的區(qū)別就是傳參的姿勢問題，get的參數(shù)一般會待在url上；post的則更常見的是通過表單的方式提交
因此接下來關注的重點在于forLocation是什么，以及如何傳參
a. post接口mock
首先創(chuàng)建一個簡單的提供POST請求的REST服務，基于Spring-boot簡單搭建一個，如下
@ResponseBody
@RequestMapping(path = "post", method = {RequestMethod.GET, RequestMethod.OPTIONS, RequestMethod.POST})
public String post(HttpServletRequest request,
@RequestParam(value = "email", required = false) String email,
@RequestParam(value = "nick", required = false) String nick) {
Map<String, Object> map = new HashMap<>();
map.put("code", "200");
map.put("result", "add " + email + " # " + nick + " success!");
return JSON.toJSONString(map);
}
b. postForObject方法
首先看一下接口簽名
public <T> T postForObject(String url, @Nullable Object request, Class<T> responseType, Object... uriVariables) throws RestClientException ; public <T> T postForObject(String url, @Nullable Object request, Class<T> responseType, Map<String, ?> uriVariables) throws RestClientException; public <T> T postForObject(URI url, @Nullable Object request, Class<T> responseType) throws RestClientException ;
上面的三個方法，看起來和前面并沒有太大的區(qū)別，只是多了一個request參數(shù)，那么具體的使用如何呢？
下面分別給出使用用例
@Test
public void testPost() {
String url = "http://localhost:8080/post";
String email = "test@hhui.top";
String nick = "一灰灰Blog";
MultiValueMap<String, String> request = new LinkedMultiValueMap<>();
request.add("email", email);
request.add("nick", nick);
// 使用方法三
URI uri = URI.create(url);
String ans = restTemplate.postForObject(uri, request, String.class);
System.out.println(ans);
// 使用方法一
ans = restTemplate.postForObject(url, request, String.class);
System.out.println(ans);
// 使用方法一，但是結合表單參數(shù)和uri參數(shù)的方式，其中uri參數(shù)的填充和get請求一致
request.clear();
request.add("email", email);
ans = restTemplate.postForObject(url + "?nick={?}", request, String.class, nick);
System.out.println(ans);
// 使用方法二
Map<String, String> params = new HashMap<>();
params.put("nick", nick);
ans = restTemplate.postForObject(url + "?nick={nick}", request, String.class, params);
System.out.println(ans);
}
復制代碼上面分別給出了三種方法的調用方式，其中post傳參區(qū)分為兩種，一個是uri參數(shù)即拼接在url中的，還有一個就是表單參數(shù)
- uri參數(shù)，使用姿勢和get請求中一樣，填充uri中模板坑位
- 表單參數(shù)，由MultiValueMap封裝，同樣是kv結構
c. postForEntity
和前面的使用姿勢一樣，無非是多了一層包裝而已，略過不講
d. postForLocation
這個與前面有點區(qū)別，從接口定義上來說，主要是
POST 數(shù)據(jù)到一個URL，返回新創(chuàng)建資源的URL
同樣提供了三個接口，分別如下，需要注意的是返回結果，為URI對象,即網(wǎng)絡資源
public URI postForLocation(String url, @Nullable Object request, Object... uriVariables) throws RestClientException ; public URI postForLocation(String url, @Nullable Object request, Map<String, ?> uriVariables) throws RestClientException ; public URI postForLocation(URI url, @Nullable Object request) throws RestClientException ;
那么什么樣的接口適合用這種訪問姿勢呢？
想一下我們一般登錄or注冊都是post請求，而這些操作完成之后呢？大部分都是跳轉到別的頁面去了，這種場景下，就可以使用 postForLocation 了，提交數(shù)據(jù)，并獲取返回的URI，一個測試如下
首先mock一個后端接口
@ResponseBody
@RequestMapping(path = "success")
public String loginSuccess(String email, String nick) {
return "welcome " + nick;
}
@RequestMapping(path = "post", method = {RequestMethod.GET, RequestMethod.OPTIONS, RequestMethod.POST})
public String post(HttpServletRequest request, @RequestParam(value = "email", required = false) String email,
@RequestParam(value = "nick", required = false) String nick) {
return "redirect:/success?email=" + email + "&nick=" + nick + "&status=success";
}
訪問的測試用例，基本上和前面的一樣，沒有什么特別值得一說的
@Test
public void testPostLocation() {
String url = "http://localhost:8080/post";
String email = "test@hhui.top";
String nick = "一灰灰Blog";
MultiValueMap<String, String> request = new LinkedMultiValueMap<>();
request.add("email", email);
request.add("nick", nick);
// 使用方法三
URI uri = restTemplate.postForLocation(url, request);
System.out.println(uri);
}
執(zhí)行結果如下
獲取到的就是302跳轉后端url，細心的朋友可能看到上面中文亂碼的問題，如何解決呢？
一個簡單的解決方案就是url編碼一下
@RequestMapping(path = "post", method = {RequestMethod.GET, RequestMethod.OPTIONS, RequestMethod.POST},
produces = "charset/utf8")
public String post(HttpServletRequest request, @RequestParam(value = "email", required = false) String email,
@RequestParam(value = "nick", required = false) String nick) throws UnsupportedEncodingException {
return "redirect:/success?email=" + email + "&nick=" + URLEncoder.encode(nick, "UTF-8") + "&status=success";
}
II. 小結
上面目前只給出了Get/Post兩種請求方式的基本使用方式，并沒有涉及到更高級的如添加請求頭，添加證書，設置代理等，高級的使用篇等待下一篇出爐，下面小結一下上面的使用姿勢
1. Get請求
get請求中，參數(shù)一般都是帶在url上，對于參數(shù)的填充，有兩種方式，思路一致都是根據(jù)實際的參數(shù)來填充url中的占位符的內容；根據(jù)返回結果，也有兩種方式，一個是只關心返回對象，另一個則包含了返回headers信心
參數(shù)填充
1、形如 http://story.hhui.top?id={0} 的 url
- 調用 getForObject(String url, Class<T> responseType, Object... uriVariables)
- 模板中的0，表示 uriVariables 數(shù)組中的第0個， i，則表示第i個
- 如果沒有url參數(shù)，也推薦用這個方法，不傳uriVariables即可
2、形如 http://story.hhui.top?id={id} 的 url
- 調用 getForObject(String url, Class<T> responseType, Map<String, ?> uriVariables)
- map參數(shù)中的key，就是url參數(shù)中 {} 中的內容
其實還有一種傳參方式，就是path參數(shù)，填充方式和上面一樣，并沒有什么特殊的玩法，上面沒有特別列出
返回結果
- 直接獲取返回的數(shù)據(jù) getForObject
- 獲取待responseHeader的數(shù)據(jù) getForEntity
2. Post請求
- post請求的返回也有兩種，和上面一樣
- post請求，參數(shù)可以區(qū)分為表單提交和url參數(shù)，其中url參數(shù)和前面的邏輯一致
- post表單參數(shù)，請包裝在 MultiValueMap 中，作為第二個參數(shù) Request 來提交
- post的方法，還有一個 postForLocation，返回的是一個URI對象，即適用于返回網(wǎng)絡資源的請求方式
3. 其他
最前面提了多點關于網(wǎng)絡請求的常見case，但是上面的介紹，明顯只處于基礎篇，我們還需要關注的有
- 如何設置請求頭？
- 有身份驗證的請求，如何攜帶身份信息？
- 代理的設置
- 文件上傳可以怎么做？
- post提交json串（即RequestBody) 又可以怎么處理
上面可能還停留在應用篇，對于源碼和實現(xiàn)有興趣的話，問題也就來了
- RestTemplaet的實現(xiàn)原理是怎樣的
- 前面url參數(shù)的填充邏輯實現(xiàn)是否優(yōu)雅
- 返回的對象如何解析
- ....
小小的一個工具類，其實東西還挺多的，接下來的小目標，就是針對上面提出的點，逐一進行研究
總結
以上就是這篇文章的全部內容了，希望本文的內容對大家的學習或者工作具有一定的參考學習價值，如果有疑問大家可以留言交流，謝謝大家對腳本之家的支持。
相關文章
在項目開發(fā)中，時常會遇到跨域問題，本文主要介紹了五種解決跨域的方法，使用最多的是第三種，需要的朋友們下面隨著小編來一起學習學習吧2021-06-06
這篇文章主要介紹了java采用中文方式顯示時間的方法,實例分析了java時間操作及字符串轉換的相關技巧,具有一定參考借鑒價值,需要的朋友可以參考下2015-07-07
這篇文章主要介紹了Java中的@Builder注解詳解,@Builder 注解的其中一個大坑會導致默認值失效,這是使用此注解出現(xiàn)的一個問題,總的來說,不推薦再使用 @Builder 注解,接下來講重點介紹其原因和替代方案,需要的朋友可以參考下2023-10-10
這篇文章主要介紹了Java中的Cookie和Session詳細解析,客戶端會話技術,服務端給客戶端的數(shù)據(jù),存儲于客戶端(瀏覽器),由于是保存在客戶端上的,所以存在安全問題,需要的朋友可以參考下2024-01-01
Base64是網(wǎng)絡上最常見的用于傳輸8Bit字節(jié)代碼的編碼方式之一，大家可以查看RFC2045～RFC2049，上面有MIME的詳細規(guī)范。本文給大家分享java常用的幾種加密算法，需要的朋友可以參考下2015-10-10
clickhouse?批量插入數(shù)據(jù)及ClickHouse常用命令詳解
這篇文章主要介紹了clickhouse?批量插入數(shù)據(jù)及ClickHouse常用命令,本文給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下2022-03-03
這篇文章主要給大家介紹了關于spring boot教程之全局處理異常封裝的相關資料，文中通過示例代碼介紹的非常詳細，對大家學習或者使用spring boot具有一定的參考學習價值，需要的朋友們下面來一起學習學習吧2019-09-09
spring session同域下單點登錄實現(xiàn)解析
這篇文章主要介紹了spring session同域下單點登錄實現(xiàn)解析,文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下2019-10-10
工廠方法(Factory Method)模式的意義是定義一個創(chuàng)建產(chǎn)品對象的工廠接口，將實際創(chuàng)建工作推遲到子類當中。核心工廠類不再負責產(chǎn)品的創(chuàng)建，這樣核心類成為一個抽象工廠角色，僅負責具體工廠子類必須實現(xiàn)的接口。本文將詳細介紹Java從工廠方法模式到 IOC/DI思想。2021-06-06
下面小編就為大家?guī)硪黄猭afka生產(chǎn)實踐(詳解)。小編覺得挺不錯的，現(xiàn)在就分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2017-08-08