RestTemplate-創(chuàng)新互聯(lián)

RestTemplate

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

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

創(chuàng)建RestTemplate

? 因?yàn)?code>RestTemplate是Spirng框架提供的所以只要是一個(gè)Springboot項(xiàng)目就不用考慮導(dǎo)包的問(wèn)題，這些都是提供好的。

? 但是Spring并沒(méi)有將其加入SpringBean容器中，需要我們手動(dòng)加入，因?yàn)槲覀兪紫葎?chuàng)建一個(gè)Springboot配置類，再在配置類中將我們的RestTemlate注冊(cè)到Bean容器中

方法一

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

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

添加自定義的攔截器

? 自定義攔截器示例

@Slf4j
public class CustomClientHttpRequestInterceptor implements ClientHttpRequestInterceptor {@Override
    public ClientHttpResponse intercept(HttpRequest request, byte[] body, ClientHttpRequestExecution execution) throws IOException {//打印請(qǐng)求明細(xì)
        logRequestDetails(request,body);
        ClientHttpResponse response = execution.execute(request, body);
        //打印響應(yīng)明細(xì)
        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構(gòu)造類，添加自定義攔截器，構(gòu)造帶有自定義攔截器的RestTemplate實(shí)例

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

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

?

---

方法二

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

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

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

---

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

RestTemplate API使用

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

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

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

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

---

GET

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

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

getForEntity()

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

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

public void queryWeather() {ResponseEntity