2. 程式人生 > 其它 >SpringBoot中使用RestTemplate

SpringBoot中使用RestTemplate

阿新 • • 發佈：2021-02-02

技術標籤：java零散知識點

@Author：Guzi499

@QQ：504305797

@Date：2020/01/11

1.新增依賴

引入spring-webmvc包,版本自己選

<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-webmvc</artifactId>
    <version>5.1.2.RELEASE</version>
</dependency>

也可以直接引用spring-boot-starter-web，這個依賴了spring-webmvc

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <version>2.1.0.RELEASE</version>
</dependency>

需要做配置優化，可引入httpclient包

<dependency>
    <groupId>org.apache.httpcomponents</groupId>
    <artifactId>httpclient</artifactId>
    <version>4.5.6</version>
</dependency>

2.配置實現類

@Configuration
public class RestTemplateConfig {
    @Bean
    public RestTemplate restTemplate(ClientHttpRequestFactory factory) {
        RestTemplate restTemplate = new RestTemplate(factory);
        // 支援中文編碼
        restTemplate.getMessageConverters().set(1, new StringHttpMessageConverter
 
(Charset.forName("UTF-8")));
        return restTemplate;
    }

    @Bean
    public ClientHttpRequestFactory simpleClientHttpRequestFactory() {
        SimpleClientHttpRequestFactory factory = new SimpleClientHttpRequestFactory();
        factory.setReadTimeout(5000);//單位為ms
        factory.setConnectTimeout(5000);//單位為ms
        return factory;
    }
}

3.簡單使用

3.1 GET請求

3.1.1 getForEntity

getForEntity方法的返回值是一個ResponseEntity<T>，ResponseEntity<T>是Spring對HTTP請求響應的封裝，包括了幾個重要的元素，如響應碼、contentType、contentLength、響應訊息體等。比如下面一個例子：

@SpringBootTest
@RunWith(SpringJUnit4ClassRunner.class)
public class TestRestTemplate {
    @Autowired
    private RestTemplate restTemplate;

    @Test
    public void test() {

        ResponseEntity<String> responseEntity = restTemplate.getForEntity("http://loaclhost/index0", String.class);

        String body = responseEntity.getBody();
        HttpStatus statusCode = responseEntity.getStatusCode();
        int statusCodeValue = responseEntity.getStatusCodeValue();
        HttpHeaders headers = responseEntity.getHeaders();

        System.out.println("body:" + body);
        System.out.println("statusCode:" + statusCode);
        System.out.println("statusCodeValue" + statusCodeValue);
        System.out.println("headers" + headers);
    }
}

關於這段程式碼：

  • getForEntity的第一個引數為我要呼叫的服務的地址。
  • getForEntity第二個引數String.class表示我希望返回的body型別是String

最終顯示結果如下：

body:<html><h3> this is index <h3></html>
statusCode:200 OK
statusCodeValue:200
headers:{Content-Length=[2381], Content-Type=[text/html], Server=[bfe], Date=[Sun, 10 Jan 2021 02:28:12 GMT]}

在呼叫服務提供者提供的介面時，可能需要傳遞引數，有兩種不同的方式

@SpringBootTest
@RunWith(SpringJUnit4ClassRunner.class)
public class TestRestTemplate {
    @Autowired
    private RestTemplate restTemplate;

	@Test
	public void test1(){
	
		ResponseEntity<String> responseEntity = restTemplate.getForEntity("http://localhost/index1?name={1}", String.class, "張三");
		
    	System.out.println(responseEntity.getBody());
	}

    @Test
    public void test2() {

        Map<String, String> map = new HashMap<>();
        map.put("name", "李四");

        ResponseEntity<String> responseEntity = restTemplate.getForEntity("http://localhost/index2?name={name}", String.class, map);

        System.out.println(responseEntity.getBody());
    }
}
  • 可以用一個數字做佔位符，最後是一個可變長度的引數，來一一替換前面的佔位符
  • 也可以前面使用name={name}這種形式，最後一個引數是一個map，map的key即為前邊佔位符的名字，map的value為引數值

第一個呼叫地址也可以是一個URI，這個時候我們構建一個URI即可，引數都包含在URI中，如下：

@SpringBootTest
@RunWith(SpringJUnit4ClassRunner.class)
public class TestRestTemplate {
    @Autowired
    private RestTemplate restTemplate;

    @Test
    public void test() {

        UriComponents uriComponents = UriComponentsBuilder.fromUriString("http://localhost/index3?name={name}").build().expand("王五").encode();
        URI uri = uriComponents.toUri();

        ResponseEntity<String> responseEntity = restTemplate.getForEntity(uri, String.class);

        System.out.println(responseEntity.getBody());
    }
}

通過Spring中提供的UriComponents來構建Uri即可。

當然，服務提供者也可以返回一個自定義型別的物件，比如如下呼叫：

@SpringBootTest
@RunWith(SpringJUnit4ClassRunner.class)
public class TestRestTemplate {
    @Autowired
    private RestTemplate restTemplate;

    @Test
    public void test() {

        ResponseEntity<User> responseEntity = restTemplate.getForEntity("http://localhost/index4", User.class);

        User book = responseEntity.getBody();

        System.out.println(book);
    }
}

執行結果如下：

{"name":"zhangsan", "age":20, "gender":"男"}
3.1.2 getForObject

getForObject函式實際上是對getForEntity函式的進一步封裝，如果你只關注返回的訊息體的內容，對其他資訊都不關注，此時可以使用getForObject，如下：

@SpringBootTest
@RunWith(SpringJUnit4ClassRunner.class)
public class TestRestTemplate {
    @Autowired
    private RestTemplate restTemplate;

    @Test
    public void test() {

        User user = restTemplate.getForObject("http://localhost/index5", User.class);
        System.out.println(user);

    }
}

getForObject也有幾個過載方法，這幾個過載方法引數的含義和getForEntity一致，這裡不再贅述了。

3.2 POST請求

3.2.1 postForEntity

該方法和get請求中的getForEntity方法類似，如下：

@SpringBootTest
@RunWith(SpringJUnit4ClassRunner.class)
public class TestRestTemplate {
    @Autowired
    private RestTemplate restTemplate;

    @Test
    public void test() {

        Book book = new Book();
        book.setName("紅樓夢");

        ResponseEntity<Book> responseEntity = restTemplate.postForEntity("http://localhost/index6", book, Book.class);
        
        System.out.println(responseEntity.getBody());

    }
}
  • 方法的第一引數表示要呼叫的服務的地址
  • 方法的第二個引數表示上傳的引數
  • 方法的第三個引數表示返回的訊息體的資料型別

postForEntity也有幾個過載方法，這幾個過載方法引數的含義和getForEntity一致，這裡不再贅述了。

3.2.2 postForObject

如果你只關注，返回的訊息體，可以直接使用postForObject。用法和getForObject一致。

3.2.3 postForLocation

postForLocation也是提交新資源，提交成功之後，返回新資源的URI，postForLocation的引數和前面兩種的引數基本一致，只不過該方法的返回值為Uri，這個只需要服務提供者返回一個Uri即可，該Uri表示新資源的位置。

3.3 PUT請求

在RestTemplate中，PUT請求可以通過put方法呼叫，put方法的引數和前面介紹的postForEntity方法的引數基本一致，只是put方法沒有返回值而已。例子如下：

@SpringBootTest
@RunWith(SpringJUnit4ClassRunner.class)
public class TestRestTemplate {
    @Autowired
    private RestTemplate restTemplate;

    @Test
    public void test() {

        Book book = new Book();
        book.setName("金瓶梅");

        restTemplate.put("http://localhost/index7/{1}", book, 100);
    }
}

book物件是我要提交的引數，最後的100用來替換前面的佔位符{1}

3.4 DELETE請求

delete請求我們可以通過delete方法呼叫來實現，如下：

@SpringBootTest
@RunWith(SpringJUnit4ClassRunner.class)
public class TestRestTemplate {
    @Autowired
    private RestTemplate restTemplate;

    @Test
    public void test() {

        restTemplate.delete("http://localhost/index8/{1}", 100);
    }
}

delete方法也有幾個過載的方法，不過過載的引數和前面基本一致，不贅述

4.高階使用(新增請求頭與引數- json傳送)

@SpringBootTest
@RunWith(SpringJUnit4ClassRunner.class)
public class TestRestTemplate {
    @Autowired
    private RestTemplate restTemplate;

    private static final ObjectMapper MAPPER = new ObjectMapper();

    @Test
    public void test() {

        //設定請求地址
        String url = "http://www.baidu.com";

        try {
            //設定請求頭
            HttpHeaders headers = new HttpHeaders();
            //如果傳送的引數資料是json資料的話，需要新增如下特殊的請求頭
            headers.setContentType(MediaType.APPLICATION_JSON);
            //或者headers.set("Content-Type", "application/json");
            headers.add("token", "xxxxx");

            //設定請求引數
            Map<String, Object> param = new HashMap<>();
            param.put("name", "guzi");
            param.put("age", 24);
            //也可以直接String = "{\"name\":\"guzi\", \"age\":24}";

            //新增請求的實體類，這裡第一個引數是要傳送的引數，第二個引數是請求頭裡的資料
            HttpEntity<String> httpEntity = new HttpEntity<>(MAPPER.writeValueAsString(param), headers);

            //POST請求  如果直接寫的json就不用再轉換了
            ResponseEntity<String> responseEntity = this.restTemplate.postForEntity(url, httpEntity, String.class);

            System.out.println(responseEntity.getStatusCodeValue()); //200
            System.out.println(responseEntity.getBody()); //<html> ... 百度一下，你就知道 ... </html>

        } catch (JsonProcessingException e) {
            e.printStackTrace();
        }
    }
}

相關推薦

詳解SpringBoot中RestTemplate的幾種實現

RestTemplate的多種實現 使用JDK預設的http library 使用Apache提供的httpclient 使用Okhttp3

SpringBoot中RestTemplate基本封裝

核心配置,注入RestTemplate為Bean package com.example.demo.config; import org.springframework.context.annotation.Bean;

淺談springboot 中如何通過restTemplate傳送帶有header和token的網路請求

最近在進行第三方介面對接，在對接過程中要用到大量的restTemplate的使用，個人覺得restTemplate裝載帶token的header傳送網路請求是很重要的一個知識點，我在這裡簡單記錄下：

springboot中的resttemplate使用了jackson序列化遇到的坑

spring.jackson.time-zone=GMT+8 spring.jackson.date-format=yyyy-MM-dd HH:mm:ss springboot之restTemplate學習

關於springboot 中使用httpclient或RestTemplate做MultipartFile檔案跨服務傳輸的問題

大家好，因為近期做需求中遇到了檔案上傳這個東西，而且我這個還是跨服務去傳輸檔案的所以我這邊使用了httpclient和RestTemplate去做,但是最後還是用的httpclient。feign和RestTemplate在超大檔案下會OOM所以適用於小

SpringBoot中使用RestTemplate

技術標籤：java零散知識點 @Author：Guzi499 @QQ：504305797 @Date：2020/01/11 1.新增依賴 引入spring-webmvc包,版本自己選

SpringBoot中的服務端訊息推送

在跟基友看完《天氣之子》之後，突然發覺上天與人類的通訊是選擇其中某些人作為連線載體，再進行單向性的通訊（人類向上天）。這個時候就想到了JAVA中的伺服器與客戶端之間的通訊方式。

springboot中的AOP

AOP分享，springboot中的aop springboot中引入aop <!--aop--> <dependency> <groupId>org.springframework.boot</groupId>

SpringBoot中RedisTemplate的RedisScript解析

著作權歸作者所有，任何形式的轉載都請聯絡作者獲得授權並註明出處。 在RedisTemplate執行lua指令碼如果做呢？

SpringBoot 中使用 RabbitMQ

今日內容是訊息佇列。大佬講了三個訊息佇列分別是 Pegion、Kafka 和 RabbitMQ。其中 Pegion 是公司自己研發的元件。今天主要在 SpringBoot 中整合 RabbitMQ,將訊息儲存在訊息佇列中並消費的過程。

springboot中使用poi匯出excel

環境 IntelliJ IDEA 2018.2 JDK 1.8 SpringBoot 2.1.9.RELEASE POI 3.9 Maven 依賴 <dependencies> <dependency>

在SpringBoot中使用flyway進行資料庫版本管理

本文大綱 flyway是什麼 能幫助我們解決什麼問題 springboot環境下使用flyway flyway的工作原理

Tomcat在SpringBoot中是如何啟動的

前言 我們知道SpringBoot給我們帶來了一個全新的開發體驗，我們可以直接把web程式達成jar包，直接啟動，這就得益於SpringBoot內建了容器，可以直接啟動，本文將以Tomcat為例，來看看SpringBoot是如何啟動Tomcat的，

Live-Server-5-SpringBoot中一個請求的流程

Live專案： 1. Idea IDE搭建SpringBoot 2. Mybatis-generator逆向生成Pojo、Mapper介面和XML等 3. WebMvcConfigurerAdapter資源攔截

SpringBoot中使用SpringSecurity實現認證和授權(入門)

簡介 SpringSecurity 是Spring專案組中用來提供安全認證(authentication)和授權(authorization)服務的框架。所謂的認證通俗的說就是判斷正在操作的使用者和密碼是否匹配，而授權就是控制使用者能做什麼操作，也就是能

Redis 在 SpringBoot 中的使用

Redis 支援多種 java 客戶端，支援列表參考官網 Jedis 是redis官方推薦的java客戶端

SpringBoot中Shiro快取使用Redis、Ehcache

在SpringBoot中Shiro快取使用Redis、Ehcache實現的兩種方式例項 SpringBoot 中配置redis作為session 快取器。 讓shiro引用

關於SpringBoot中Redis執行緒池的有關探討

探討起因 最近在寫一個小專案，用redis過期來實現驗證碼的時間限制。因為SpringBoot預設採用

SpringBoot中的五種對靜態資源的對映規則的實現

SpringBoot中的SpringMVC配置功能都是在WebMvcAutoConfiguration類中，xxxxAutoConfiguration就是幫我們給容器中自動配置元件的；idea全域性搜尋的快捷鍵是兩次shift，檢視webMvcAutoConfiguration 檢視webMvc自動配

Springboot中@Value的使用詳解

Springboot通過@Value註解將配置檔案中的屬性注入到容器內元件中（可用在@Controller、@Service、@Configuration、@Component等Spring託管的類中）