RestTemplate調(diào)用接口如何獲取輸入流

由于項(xiàng)目需求，需要獲取RestTemplate請(qǐng)求響應(yīng)的輸入流。如下：

首先需要獲取一個(gè)RestTemplate實(shí)例：

RestTemplate rest = new RestTemplate();

一般的使用方式如下：

String message = rest.getForObject(url, String.class);
// or
String message = rest.postForObject(url, paramObject, String.class);

若要獲取InputStream，需要使用到spring提供Resource接口和ResponseEntity類，方式如下：

ResponseEntity<Resource> entity = rest.postForEntity(url, paramObject, Resource.class);
InputStream in = entity.getBody().getInputStream();

當(dāng)然，我們也可以先使用entity對(duì)響應(yīng)做出判斷，比如檢查響應(yīng)狀態(tài)：

if (entity.getStatusCode().equals(HttpStatus.OK)) {
? ? // ...
}

SpringRestTemplate解析

RESTful

簡單來說，RESTful是基于Http協(xié)議，面向資源和語義的設(shè)計(jì)風(fēng)格。它可以看做是Http協(xié)議的一種嚴(yán)格實(shí)現(xiàn)，基于Http資源（URI）和語義（Get/Post/Put/Delete等）

作為對(duì)比，PRC則是面向過程（資源+語義），而對(duì)協(xié)議沒有固定要求的設(shè)計(jì)風(fēng)格。它的目的是將遠(yuǎn)程方法當(dāng)做本地方法一樣調(diào)用，相比于RESTful的面向資源和語義，它將兩者結(jié)合起來，作為我們平時(shí)開發(fā)過程中的方法。

? 比如一個(gè)訂單查詢系統(tǒng)，用RESTful風(fēng)格的寫法是這樣的

// 這里查詢用的是Http語義GET，對(duì)應(yīng)的新增為POST，刪除為DELETE，修改為PUT
GET
/order/123

用PRC風(fēng)格的寫法是這樣的

/order/queryOrder/123

RPC對(duì)比

總結(jié)來看，RESTful和PRC有以下不同。

? 1、RESTful基于Http協(xié)議，而RPC對(duì)協(xié)議沒有固定要求，一般會(huì)采用效率較高的協(xié)議。

? 2、RESTful面向資源和語義，而RPC面向過程。即RESTful提供的資源表達(dá)十分明確，提供了多種語義作為資源的操作方法，例如上面的訂單查詢。RPC則會(huì)為同一個(gè)資源提供多個(gè)操作方法，對(duì)外并沒有十分明確的資源概念。

RestTemplate

HttpMessageConverter及序列化

?序列化就是將對(duì)象轉(zhuǎn)化為可以傳輸?shù)亩M(jìn)制，反序列化就是將二進(jìn)制轉(zhuǎn)化為程序內(nèi)部的對(duì)象。序列化/反序列化主要體現(xiàn)在程序I/O這個(gè)過程中，包括網(wǎng)絡(luò)I/O和磁盤I/O。在網(wǎng)絡(luò)中Http報(bào)文是以二進(jìn)制字符串的形式傳遞的，這種是反序列化前的存在形式，我們要在Java中處理，則還需要進(jìn)行反序列化操作。

我們可以通過HttpServletRequest的getInputStream()方法獲取請(qǐng)求報(bào)文的原始內(nèi)容，HttpServletResponse的getOutputStream()方法寫入響應(yīng)報(bào)文，這些方式都是通過流的形式來處理數(shù)據(jù)，如果要轉(zhuǎn)化為對(duì)象，還需要我們進(jìn)一步處理。在面向?qū)ο蟮哪Ｊ街?，每次都需要讀取流中的原始數(shù)據(jù)并轉(zhuǎn)化為對(duì)象，這樣顯然是很麻煩的，如果能將請(qǐng)求和響應(yīng)都自動(dòng)封裝為我們想要的對(duì)象，那不是很好嘛。HttpMessageConverter提供的就是這樣的功能，將原始的請(qǐng)求報(bào)文和響應(yīng)報(bào)文封裝為對(duì)象。

public interface HttpMessageConverter<T> {
	boolean canRead(Class<?> clazz, @Nullable MediaType mediaType);
	boolean canWrite(Class<?> clazz, @Nullable MediaType mediaType);
	List<MediaType> getSupportedMediaTypes();
	T read(Class<? extends T> clazz, HttpInputMessage inputMessage)
			throws IOException, HttpMessageNotReadableException;
	void write(T t, @Nullable MediaType contentType, HttpOutputMessage outputMessage)
			throws IOException, HttpMessageNotWritableException;
}

?HttpMessageConverter中出現(xiàn)了成對(duì)的read和write方法。每種Converter負(fù)責(zé)處理其各自支持的MimeType，can**()方法通過判斷當(dāng)前Converter和需要處理的MimeType是否一致，如果一致則能處理，否則不能處理。如果能處理，則再通過read/write()方法進(jìn)行操作，其本質(zhì)上也是通過輸入輸出流處理數(shù)據(jù)，我們來看下StringHttpMessageConverter是如何將請(qǐng)求報(bào)文轉(zhuǎn)化為String對(duì)象的：

// 判斷當(dāng)前Converter是否支持此類型的轉(zhuǎn)換，只有是String時(shí)才會(huì)支持
@Override
public boolean supports(Class<?> clazz) {
	return String.class == clazz;
}

// 從HttpInputMessage讀取輸入流，并轉(zhuǎn)化為String對(duì)象
@Override
protected String readInternal(Class<? extends String> clazz, HttpInputMessage inputMessage) throws IOException {
	Charset charset = getContentTypeCharset(inputMessage.getHeaders().getContentType());
	return StreamUtils.copyToString(inputMessage.getBody(), charset);
}

// 從InputStream中讀取原始的報(bào)文數(shù)據(jù)
public static String copyToString(@Nullable InputStream in, Charset charset) throws IOException {
    if (in == null) {
        return "";
    } else {
        StringBuilder out = new StringBuilder();
        InputStreamReader reader = new InputStreamReader(in, charset);
        char[] buffer = new char[4096];

        int charsRead;
        while((charsRead = reader.read(buffer)) != -1) {
            out.append(buffer, 0, charsRead);
        }

        return out.toString();
    }
}

組件替換

從上面的UML可以看出，RestTemplate中定義了一組Http語義的模板方法，并通過HttpAccessor創(chuàng)建了HttpRequest對(duì)象再執(zhí)行請(qǐng)求。也就是說，RestTemplate中并沒有創(chuàng)建請(qǐng)求，請(qǐng)求是委托給HttpAccessor創(chuàng)建的，HttpAccessor可以切換請(qǐng)求工廠，這樣就給我們提供了切換請(qǐng)求，即Http組件的操作。

通過HttpAccessor的ClientHttpRequestFactory屬性來切換不同的HTTP組件：HttpAccessor默認(rèn)使用SimpleClientHttpRequestFactory來創(chuàng)建一個(gè)ClientHttpRequest，如果通過HttpAccessor提供的setRequestFactory()方法替換掉其默認(rèn)的工廠，就可以實(shí)現(xiàn)HTTP組件切換。RestTemplate提供了以ClientHttpRequestFactory為參數(shù)的構(gòu)造方法，其內(nèi)部調(diào)用了setRequestFactory()。

通過看ClientHttpRequestFactory的實(shí)現(xiàn)類，可以發(fā)現(xiàn)常見的Http組件有HttpComponents、OkHttp、Netty4Client等，在這里不做深入探究。

?總結(jié)

以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。

最新評(píng)論