RestTemplate

成都創(chuàng)新互聯(lián)專業(yè)IDC數(shù)據(jù)服務器托管提供商，專業(yè)提供成都服務器托管，服務器租用，川西大數(shù)據(jù)中心，川西大數(shù)據(jù)中心，成都多線服務器托管等服務器托管服務。簡介

• RestTemplate是由Spring框架提供的一個可用于應用中調用rest服務的類它簡化了與http服務的通信方式，統(tǒng)一了RESTFul的標準，封裝了http連接，我們只需要傳入url及其返回值類型即可。相較于之前常用的HttpClient，RestTemplate是一種更為優(yōu)雅的調用RESTFul服務的方式。
• 在Spring應用程序中訪問第三方REST服務與使用Spring RestTemplate類有關。RestTemplate類的設計原則與許多其他Spring的模板類(例如JdbcTemplate)相同，為執(zhí)行復雜任務提供了一種具有默認行為的簡化方法。
• RestTemplate默認依賴JDK提供了http連接的能力（HttpURLConnection），如果有需要的話也可以通過setRequestFactory方法替換為例如Apache HttpCompoent、Netty或OKHttp等其他Http libaray。
• 考慮到了RestTemplate類是為了調用REST服務而設計的，因此它的主要方法與REST的基礎緊密相連就不足為奇了，后者時HTTP協(xié)議的方法：HEAD、GET、POST、PUT、DELETE、OPTIONS例如，RestTemplate類具有headForHeaders()、getForObject()、putForObject()，put()和delete()等方法。

創(chuàng)建RestTemplate

? 因為RestTemplate是Spirng框架提供的所以只要是一個Springboot項目就不用考慮導包的問題，這些都是提供好的。

? 但是Spring并沒有將其加入SpringBean容器中，需要我們手動加入，因為我們首先創(chuàng)建一個Springboot配置類，再在配置類中將我們的RestTemlate注冊到Bean容器中

方法一

? 使用Springboot提供的RestTemplateBuilder構造類來構造一個RestTemplate，可以自定義一些連接參數(shù)，如：連接超時時間，讀取超時時間，還有認證信息等

@Configuration
public class WebConfiguration {@Bean
    public RestTemplate restTemplate(RestTemplateBuilder builder){return builder
                //設置連接超時時間
                .setConnectTimeout(Duration.ofSeconds(5000))
                //設置讀取超時時間
                .setReadTimeout(Duration.ofSeconds(5000))
                //設置認證信息
                .basicAuthentication("username","password")
                //設置根路徑
                .rootUri("https://api.test.com/")
                //構建
                .build();
    }
}

添加自定義的攔截器

? 自定義攔截器示例

@Slf4j
public class CustomClientHttpRequestInterceptor implements ClientHttpRequestInterceptor {@Override
    public ClientHttpResponse intercept(HttpRequest request, byte[] body, ClientHttpRequestExecution execution) throws IOException {//打印請求明細
        logRequestDetails(request,body);
        ClientHttpResponse response = execution.execute(request, body);
        //打印響應明細
        logResponseDetails(response);
        
        return response;
    }

    private void logRequestDetails(HttpRequest request, byte[] body){log.debug("Headers:{}",request.getHeaders());
        log.debug("body:{}",new String(body, StandardCharsets.UTF_8));
        log.debug("{}:{}",request.getMethod(),request.getMethodValue());
    }

    private void logResponseDetails(ClientHttpResponse response) throws IOException {log.debug("Status code : {}",response.getStatusCode());
        log.debug("Status text : {}",response.getStatusText());
        log.debug("Headers : {}",response.getHeaders());
        log.debug("Response body: {}", StreamUtils.copyToString(response.getBody(),StandardCharsets.UTF_8));
    }
}

? 使用RestTemplateBuilder構造類，添加自定義攔截器，構造帶有自定義攔截器的RestTemplate實例

@Configuration
public class WebConfiguration {@Bean
    public RestTemplate restTemplate(RestTemplateBuilder builder){return builder
                .additionalInterceptors(new CustomClientHttpRequestInterceptor())
                //構建
                .build();
    }    
}

? 測試請求確實經(jīng)過了攔截器，注冊成功（注意請求和響應的流只會被讀取一次，這里我們讀取了response后返回的response就讀取不到剛剛讀過的內(nèi)容了）

?

---

方法二

? 使用RestTemplate構造方法構造一個RestTemlate，雖然不能像RestTemplate構造類那樣更詳細、更多樣的配置參數(shù)，但是RestTemplate構造方法在一般情況是夠用的。

• 無參構造 全部參數(shù)默認
• 指定ClientHttpRequestFactory的構造方法可以指定自己實現(xiàn)的ClientHttpRequestFactory（客戶端http請求工廠）其他的與無參構造相同。
  • ClientHttpRequestFactory
• 指定List>的構造方法可以指定自己是實現(xiàn)的HttpMessageConverter（Http消息轉換器）傳入其他與無參構造相同。

@Configuration
public class WebConfiguration {@Bean
    public RestTemplate restTemplate(){return new RestTemplate();
    }
    
}

---

? 兩者方法都可使用，前者提供了多樣的自定義參數(shù)的選擇，可以將RestTemplate配置的更為完善，后者則簡化了配置雖然配置多樣性不如前者，但是日常使用調用些API還是足以使用

RestTemplate API使用

? 在使用RestTemplate前先讓我們看看RestTemplate有哪些API

? 相信大家看到這么多方法，一定很頭大，但是我們仔細看上述的方法，我們可以提取出主要的幾種方法是(這里只討論Http請求的)：

• GET
• POST
• PUT
• DELETE
• HEAD
• OPTIONS
• EXCHANGE
• EXECUTE

? 這里我給大家安利一個一個網(wǎng)站，它提供免費的RESTFul api的樣例測試。httpbin A simple HTTP Request & Response Service.

---

GET

? 通過上圖我們可以發(fā)現(xiàn)RestTemlate發(fā)送GET請求的方法有兩種

• publicT getForObject(...)
• publicResponseEntitygetForEntity(...)

getForEntity()

? 后綴帶有Entity的方法都代表返回一個ResponseEntity，ResponseEntity是Spring對HTTP請求響應的封裝，包括了幾個重要的元素，如響應碼，contentType、contentLength、響應消息體等

? 通過它繼承父類(HttpEntity)的getHeader()方法我們可以獲取contentType、contentLength、響應消息體等。比如下面這個例子。

public void queryWeather() {ResponseEntity