转载

Spring RestTemplate 详解

Spring RestTemplate

Spring's central class for synchronous client-side HTTP access. It simplifies communication with HTTP servers, and enforces RESTful principles. It handles HTTP connections, leaving application code to provide URLs (with possible template variables) and extract results.

什么是 RestTemplate？

RestTemplate是一个http请求的客户端工具，它不是类似HttpClient的东东，也不是类似Jackson，jaxb等工具，但它封装了这些工具．

RestTemplate能做什么？

RestTemplate是Spring 调用http的client端核心类．顾名思义，与其它template类如 JdbcTemplate 一样，它封装了与http server的通信的细节，使调用端无须关心http接口响应的消息是什么格式，统统使用Java pojo来接收请求结果．它主要做了以下事情：

封装并屏蔽了http通信细节
组装Http请求参数
抽取结果并转成调用端指定的Java pojo对象
屏蔽了不同消息格式的差异化处理

在http通信的底层，它默认采用的是Jdk的标准设施，当然你也可以切换成其它的http类库例如 Apache HttpComponents , Netty , and OkHttp 等.

RestTemplate这个类是用在同步调用上的，异步调用请移步 AsyncRestTemplate

最简单的上手方式：

我们拿到的result直接就是Java pojo，不需要我们自己解析转换对方接口返回的Json格式数据．

再来看个复杂点的case:

这个是自动把接口返回的json array转成 List<MyResponse>

RestTemplate主要方法与http方法的对应关系：

注意：传入的url会被encode，所以不要传入encode的url，以防重复encode,可以考虑使用 UriComponentsBuilder

在template内部使用是 HttpMessageConverter 来负责http message与POJO之间的互相转换，默认主要类型的Mime type的Converter会被自动注册，此外你也可以通过 setMessageConverters 来添加自定义converter. 来看默认的构造函数，只要对应的第三方类库存在classpath中，就会注册相应的 HttpMessageConverter

默认能转换的类型有：

json(jackson和gson都有)
xml
rss
atom feed

template是采用 SimpleClientHttpRequestFactory 来处理Http的连接，用 DefaultResponseErrorHandler 处理Http错误，这些默认的策略可以采用 HttpAccessor.setRequestFactory 和 HttpAccessor.setRequestFactory 来替换．

构造方法汇总：

看个典型的方法：

execut方法：

最终调用的execute方法里有两个特殊的参数 RequestCallback 和 ResponseExtractor ．