精講RestTemplate第1篇-在Spring或非Spring環境下如何使用
一、什麼是 RestTemplate?
RestTemplate
是執行HTTP請求的同步阻塞式的客戶端,它在HTTP客戶端庫(例如JDK HttpURLConnection,Apache HttpComponents,okHttp等)基礎封裝了更加簡單易用的模板方法API。也就是說RestTemplate是一個封裝,底層的實現還是java應用開發中常用的一些HTTP客戶端。但是相對於直接使用底層的HTTP客戶端庫,它的操作更加方便、快捷,能很大程度上提升我們的開發效率。
RestTemplate
作爲spring-web項目的一部分,在Spring 3.0版本開始被引入。RestTemplate類通過爲HTTP方法(例如GET,POST,PUT,DELETE等)提供重載的方法,提供了一種非常方便的方法訪問基於HTTP的Web服務。如果你的Web服務API基於標準的RESTful風格設計,使用效果將更加的完美。
根據Spring官方文檔及源碼中的介紹,RestTemplate在將來的版本中它可能會被棄用,因爲他們已在Spring 5中引入了WebClient作爲非阻塞式Reactive HTTP客戶端。但是RestTemplate目前在Spring 社區內還是很多項目的“重度依賴”,比如說Spring Cloud。另外,RestTemplate說白了是一個客戶端API封裝,和服務端相比,非阻塞Reactive 編程的需求並沒有那麼高。
二、非Spring環境下使用RestTemplate
爲了方便後續開發測試,首先介紹一個網站給大家。 JSONPlaceholder 是一個提供免費的在線REST API的網站,我們在開發時可以使用它提供的url地址測試下網絡請求以及請求參數。或者當我們程序需要獲取一些模擬數據、模擬圖片時也可以使用它。
RestTemplate是spring的一個rest客戶端,在spring-web這個包下。這個包雖然叫做spring-web,但是它的RestTemplate可以脫離Spring 環境使用。
<dependency> <groupId>org.springframework</groupId> <artifactId>spring-web</artifactId> <version>5.2.6.RELEASE</version> </dependency>
測試一下Hello world,使用RestTemplate發送一個GET請求,並把請求得到的JSON數據結果打印出來。
@Test public void simpleTest() { RestTemplate restTemplate = new RestTemplate(); String url = "http://jsonplaceholder.typicode.com/posts/1"; String str = restTemplate.getForObject(url, String.class); System.out.println(str); }
服務端是JSONPlaceholder網站,幫我們提供的服務端API。需要注意的是:"http://jsonplaceholder.typicode.com/posts/1"服務URL,雖然URL裏面有posts這個單詞,但是它的英文含義是:帖子或者公告,而不是我們的HTTP Post協議。所以說"http://jsonplaceholder.typicode.com/posts/1",請求的數據是:id爲1的Post公告資源。打印結果如下:
這裏我們只是演示了RestTemplate 最基礎的用法,RestTemplate 會寫成一個系列的文章,請大家關注。
三、Spring環境下使用RestTemplate
將maven座標從spring-web換成spring-boot-starter-web
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency>
將RestTemplate配置初始化爲一個Bean。這種初始化方法,是使用了JDK 自帶的HttpURLConnection作爲底層HTTP客戶端實現。我們還可以把底層實現切換爲Apache HttpComponents,okHttp等,我們後續章節會爲大家介紹。
@Configuration public class ContextConfig { //默認使用JDK 自帶的HttpURLConnection作爲底層實現 @Bean public RestTemplate restTemplate(){ RestTemplate restTemplate = new RestTemplate(); return restTemplate; } }
在需要使用RestTemplate 的位置,注入並使用即可。
@Resource //@AutoWired private RestTemplate restTemplate;
歡迎關注我的博客,裏面有很多精品合集
- 本文轉載註明出處(必須帶連接,不能只轉文字): 字母哥博客 。
覺得對您有幫助的話,幫我點贊、分享!您的支持是我不竭的創作動力!。另外,筆者最近一段時間輸出瞭如下的精品內容,期待您的關注。