首頁 > 軟體

RestTemplate在Spring或非Spring環境下使用精講

2022-03-16 19:00:14

一、什麼是 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;

以上就是RestTemplate在Spring或非Spring環境下使用精講的詳細內容,更多關於RestTemplate在Spring環境下中使用的資料請關注it145.com其它相關文章!


IT145.com E-mail:sddin#qq.com