RestTemplate响应中如何获取输入流InputStream

2023-01-11 12:01

短信预约 -IT技能 免费直播动态提醒

RestTemplate调用接口如何获取输入流

由于项目需求，需要获取RestTemplate请求响应的输入流。如下：

首先需要获取一个RestTemplate实例：

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();

当然，我们也可以先使用entity对响应做出判断，比如检查响应状态：

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

SpringRestTemplate解析

RESTful

简单来说，RESTful是基于Http协议，面向资源和语义的设计风格。它可以看做是Http协议的一种严格实现，基于Http资源（URI）和语义（Get/Post/Put/Delete等）

作为对比，PRC则是面向过程（资源+语义），而对协议没有固定要求的设计风格。它的目的是将远程方法当做本地方法一样调用，相比于RESTful的面向资源和语义，它将两者结合起来，作为我们平时开发过程中的方法。

比如一个订单查询系统，用RESTful风格的写法是这样的

// 这里查询用的是Http语义GET，对应的新增为POST，删除为DELETE，修改为PUT
GET
/order/123

用PRC风格的写法是这样的

/order/queryOrder/123

RPC对比

总结来看，RESTful和PRC有以下不同。

1、RESTful基于Http协议，而RPC对协议没有固定要求，一般会采用效率较高的协议。

2、RESTful面向资源和语义，而RPC面向过程。即RESTful提供的资源表达十分明确，提供了多种语义作为资源的操作方法，例如上面的订单查询。RPC则会为同一个资源提供多个操作方法，对外并没有十分明确的资源概念。

RestTemplate

RestTemplate整体UML.jpg

HttpMessageConverter及序列化

序列化就是将对象转化为可以传输的二进制，反序列化就是将二进制转化为程序内部的对象。序列化/反序列化主要体现在程序I/O这个过程中，包括网络I/O和磁盘I/O。在网络中Http报文是以二进制字符串的形式传递的，这种是反序列化前的存在形式，我们要在Java中处理，则还需要进行反序列化操作。

我们可以通过HttpServletRequest的getInputStream()方法获取请求报文的原始内容，HttpServletResponse的getOutputStream()方法写入响应报文，这些方式都是通过流的形式来处理数据，如果要转化为对象，还需要我们进一步处理。在面向对象的模式中，每次都需要读取流中的原始数据并转化为对象，这样显然是很麻烦的，如果能将请求和响应都自动封装为我们想要的对象，那不是很好嘛。HttpMessageConverter提供的就是这样的功能，将原始的请求报文和响应报文封装为对象。

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中出现了成对的read和write方法。每种Converter负责处理其各自支持的MimeType，can**()方法通过判断当前Converter和需要处理的MimeType是否一致，如果一致则能处理，否则不能处理。如果能处理，则再通过read/write()方法进行操作，其本质上也是通过输入输出流处理数据，我们来看下StringHttpMessageConverter是如何将请求报文转化为String对象的：

// 判断当前Converter是否支持此类型的转换，只有是String时才会支持
@Override
public boolean supports(Class<?> clazz) {
	return String.class == clazz;
}

// 从HttpInputMessage读取输入流，并转化为String对象
@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中读取原始的报文数据
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创建了HttpRequest对象再执行请求。也就是说，RestTemplate中并没有创建请求，请求是委托给HttpAccessor创建的，HttpAccessor可以切换请求工厂，这样就给我们提供了切换请求，即Http组件的操作。

通过HttpAccessor的ClientHttpRequestFactory属性来切换不同的HTTP组件：HttpAccessor默认使用SimpleClientHttpRequestFactory来创建一个ClientHttpRequest，如果通过HttpAccessor提供的setRequestFactory()方法替换掉其默认的工厂，就可以实现HTTP组件切换。RestTemplate提供了以ClientHttpRequestFactory为参数的构造方法，其内部调用了setRequestFactory()。

通过看ClientHttpRequestFactory的实现类，可以发现常见的Http组件有HttpComponents、OkHttp、Netty4Client等，在这里不做深入探究。