RestTemplate 是 Spring 提供的用于访问 Rest 服务的客户端，RestTemplate 提供了多种便捷访问远程 HTTP 服务的方法,能够大大提高客户端的编写效率。

之前的HTTP开发是用 apache 的 HttpClient 开发，代码复杂，还得操心资源回收等。代码很复杂且冗余代码多。

1. 概述

RestTemplate 是 Spring 用于同步 client 端的核心类，简化了与 http 服务的通信，并满足 RestFul 原则，程序代码可以给它提供 URL，并提取结果。默认情况下，RestTemplate 默认依赖 jdk 的 HTTP 连接工具。当然你也可以 通过 setRequestFactory 属性切换到不同的 HTTP 源，比如 Apache HttpComponents、Netty 和 OkHttp。

RestTemplate 能大幅简化了提交表单数据的难度，并且附带了自动转换 JSON 数据的功能，但只有理解了HttpEntity 的组成结构（header与body），且理解了与 uriVariables 之间的差异，才能真正掌握其用法。这一点在 Post 请求更加突出，下面会介绍到。

该类的入口主要是根据HTTP的六个方法制定：
image.png
此外，exchange 和 excute 可以通用上述方法。

在内部，RestTemplate 默认使用 HttpMessageConverter 实例将 HTTP 消息转换成 POJO 或者从 POJO 转换成 HTTP 消息。默认情况下会注册主 mime 类型的转换器，但也可以通过 setMessageConverters 注册其他的转换器。

其实这点在使用的时候是察觉不到的，很多方法有一个 responseType 参数，它让你传入一个响应体所映射成的对象，然后底层用 HttpMessageConverter 将其做映射。

  1. HttpMessageConverterExtractor<T> responseExtractor = new HttpMessageConverterExtractor<>(responseType, getMessageConverters(), logger);

HttpMessageConverter.java 源码：

  1. public interface HttpMessageConverter<T> {
  2.     //指示此转换器是否可以读取给定的类。
  3.     boolean canRead(Class<?> clazz, @Nullable MediaType mediaType);
  5.     //指示此转换器是否可以写给定的类。
  6.     boolean canWrite(Class<?> clazz, @Nullable MediaType mediaType);
  8.     //返回List<MediaType>
  9.     List<MediaType> getSupportedMediaTypes();
  11.     //读取一个inputMessage
  12.     T read(Class<? extends T> clazz, HttpInputMessage inputMessage) throws IOException, HttpMessageNotReadableException;
  14.     //往output message写一个Object
  15.     void write(T t, @Nullable MediaType contentType, HttpOutputMessage outputMessage)throws IOException, HttpMessageNotWritableException;
  16. }

在内部 RestTemplate 默认使用 SimpleClientHttpRequestFactory 和 DefaultResponseErrorHandler 来分别处理 HTTP 的创建和错误，但也可以通过 setRequestFactory 和 setErrorHandler 来覆盖。

2. get 请求

2.1 getForObject() 方法

  1. public <T> T getForObject(String url, Class<T> responseType, Object... uriVariables){}
  2. public <T> T getForObject(String url, Class<T> responseType, Map<String, ?> uriVariables)
  3. public <T> T getForObject(URI url, Class<T> responseType)

getForObject() 其实比 getForEntity() 多包含了将 HTTP 转成 POJO 的功能，但是 getForObject 没有处理 response 的能力。因为它拿到手的就是成型的 pojo。省略了很多 response 的信息。

2.1.1 POJO
  1. public class Notice {
  2.     private int status;
  3.     private Object msg;
  4.     private List<DataBean> data;
  5. }
  6. public  class DataBean {
  7.   private int noticeId;
  8.   private String noticeTitle;
  9.   private Object noticeImg;
  10.   private long noticeCreateTime;
  11.   private long noticeUpdateTime;
  12.   private String noticeContent;
  13. }

示例：2.1.2 不带参的 get 请求

  1. /**
  2.  * 不带参的get请求
  3. */
  4. @Test
  5. public void restTemplateGetTest(){
  6.     RestTemplate restTemplate = new RestTemplate();
  7.     Notice notice = restTemplate.getForObject("http://xxx.top/notice/list/1/5", Notice.class);
  8.     System.out.println(notice);
  9. }

示例：2.1.3 带参数的 get 请求

  1. Map<String,String> map = new HashMap();
  2. map.put("start","1");
  3. map.put("page","5");
  4. Notice notice = restTemplate.getForObject("http://fantj.top/notice/list/", Notice.class, map);

明眼人一看就是利用 map 装载参数，不过它默认解析的是 PathVariable 的 url 形式。即 url 类似 http://fantj.top/notice/list/{name}

2.2 getForEntity() 方法

  1. public <T> ResponseEntity<T> getForEntity(String url, Class<T> responseType, Object... uriVariables){}
  2. public <T> ResponseEntity<T> getForEntity(String url, Class<T> responseType, Map<String, ?> uriVariables){}
  3. public <T> ResponseEntity<T> getForEntity(URI url, Class<T> responseType){}

与 getForObject() 方法不同的是返回的是 ResponseEntity 对象，如果需要转换成 pojo，还需要 json 工具类的引入，这个按个人喜好用。不会解析 json 的可以百度 FastJson 或者 Jackson 等工具类。然后我们就研究一下 ResponseEntity 下面有啥方法。

ResponseEntity、HttpStatus、BodyBuilder结构

  • ResponseEntity.java

    1. public HttpStatus getStatusCode(){}
    2. public int getStatusCodeValue(){}
    3. public boolean equals(@Nullable Object other) {}
    4. public String toString() {}
    5. public static BodyBuilder status(HttpStatus status) {}
    6. public static BodyBuilder ok() {}
    7. public static <T> ResponseEntity<T> ok(T body) {}
    8. public static BodyBuilder created(URI location) {}

  • HttpStatus.java

    1. public enum HttpStatus {
    2.   public boolean is1xxInformational() {}
    3.   public boolean is2xxSuccessful() {}
    4.   public boolean is3xxRedirection() {}
    5.   public boolean is4xxClientError() {}
    6.   public boolean is5xxServerError() {}
    7.   public boolean isError() {}
    8. }

  • BodyBuilder.java

    1. public interface BodyBuilder extends HeadersBuilder<BodyBuilder> {
    2.   //设置正文的长度，以字节为单位，由Content-Length标头
    3.   BodyBuilder contentLength(long contentLength);
    4.   //设置body的MediaType 类型
    5.   BodyBuilder contentType(MediaType contentType);
    6.   //设置响应实体的主体并返回它。
    7.   <T> ResponseEntity<T> body(@Nullable T body);
    8. ｝

    可以看出来，ResponseEntity 包含了 HttpStatus 和 BodyBuilder 的这些信息，这更方便我们处理 response 原生的东西。

示例：

  1. @Test
  2. public void rtGetEntity(){
  3.     RestTemplate restTemplate = new RestTemplate();
  4.     ResponseEntity<Notice> entity = restTemplate.getForEntity("http://fantj.top/notice/list/1/5", Notice.class);
  6.     HttpStatus statusCode = entity.getStatusCode();
  7.     System.out.println("statusCode.is2xxSuccessful()"+statusCode.is2xxSuccessful());
  9.     Notice body = entity.getBody();
  10.     System.out.println("entity.getBody()"+body);
  12.     ResponseEntity.BodyBuilder status = ResponseEntity.status(statusCode);
  13.     status.contentLength(100);
  14.     status.body("我在这里添加一句话");
  15.     ResponseEntity<Class<Notice>> body1 = status.body(Notice.class);
  16.     Class<Notice> body2 = body1.getBody();
  17.     System.out.println("body1.toString()"+body1.toString());
  18. }
  19. // statusCode.is2xxSuccessful()true
  20. // entity.getBody()Notice{status=200, msg=null, data=[DataBean{noticeId=21, noticeTitle='aaa', ...
  21. // body1.toString()<200 OK,class com.waylau.spring.cloud.weather.pojo.Notice,{Content-Length=[100]}>

当然，还有 getHeaders() 等方法没有举例。

3. post 请求

同样的，post 请求也有 postForObject 和 postForEntity。

  1. public <T> T postForObject(String url, @Nullable Object request, Class<T> responseType, Object... uriVariables)throws RestClientException {}
  2. public <T> T postForObject(String url, @Nullable Object request, Class<T> responseType, Map<String, ?> uriVariables)throws RestClientException {}
  3. public <T> T postForObject(URI url, @Nullable Object request, Class<T> responseType) throws RestClientException {}

用一个邮箱的接口来测试

  1. @Test
  2. public void rtPostObject(){
  3.     RestTemplate restTemplate = new RestTemplate();
  4.     String url = "http://47.xxx.xxx.96/register/checkEmail";
  5.     HttpHeaders headers = new HttpHeaders();
  6.     headers.setContentType(MediaType.APPLICATION_FORM_URLENCODED);
  7.     MultiValueMap<String, String> map= new LinkedMultiValueMap<>();
  8.     map.add("email", "844072586@qq.com");
  10.     HttpEntity<MultiValueMap<String, String>> request = new HttpEntity<>(map, headers);
  11.     ResponseEntity<String> response = restTemplate.postForEntity( url, request , String.class );
  12.     System.out.println(response.getBody());
  13. }

执行结果：

  1. {"status":500,"msg":"该邮箱已被注册","data":null}

代码中，MultiValueMap 是 Map 的一个子类，它的一个key可以存储多个value，简单的看下这个接口：

  1. public interface MultiValueMap<K, V> extends Map<K, List<V>> {...}

为什么用 MultiValueMap? 因为 HttpEntity 接受的request类型是它：

  1. public HttpEntity(@Nullable T body, @Nullable MultiValueMap<String, String> headers){}
  2. //我这里只展示它的一个construct,从它可以看到我们传入的map是请求体，headers是请求头。

为什么用 HttpEntity 是因为 restTemplate.postForEntity 方法虽然表面上接收的 request 是 @Nullable Object request 类型，但是你追踪下去会发现，这个 request 是用 HttpEntity 来解析。核心代码如下：

  1. if (requestBody instanceof HttpEntity) {
  2.     this.requestEntity = (HttpEntity<?>) requestBody;
  3. }else if (requestBody != null) {
  4.     this.requestEntity = new HttpEntity<>(requestBody);
  5. }else {
  6.     this.requestEntity = HttpEntity.EMPTY;
  7. }

我曾尝试用 map 来传递参数，编译不会报错，但是执行不了，是无效的 url request请求(400 ERROR)。其实这样的请求方式已经满足post请求了，cookie 也是属于 header 的一部分。可以按需求设置请求头和请求体。其它方法与之类似。

4. 使用 exchange 指定调用方式

exchange() 方法跟上面的 getForObject()、getForEntity()、postForObject()、postForEntity() 等方法不同之处在于它可以指定请求的HTTP类型。

但是你会发现 exchange 的方法中似乎都有 @Nullable HttpEntity requestEntity 这个参数，这就意味着我们至少要用 HttpEntity 来传递这个请求体，之前说过源码所以建议就使用 HttpEntity 提高性能。

  1. @Test
  2. public void rtExchangeTest() throws JSONException {
  3.     RestTemplate restTemplate = new RestTemplate();
  4.     String url = "http://xxx.top/notice/list";
  5.     HttpHeaders headers = new HttpHeaders();
  6.     headers.setContentType(MediaType.APPLICATION_FORM_URLENCODED);
  7.     JSONObject jsonObj = new JSONObject();
  8.     jsonObj.put("start",1);
  9.     jsonObj.put("page",5);
  11.     HttpEntity<String> entity = new HttpEntity<>(jsonObj.toString(), headers);
  12.     ResponseEntity<JSONObject> exchange = restTemplate.exchange(url, HttpMethod.GET, entity, JSONObject.class);
  13.     System.out.println(exchange.getBody());
  14. }

这次可以看到，我使用了 JSONObject 对象传入和返回。

5. excute() 指定调用方式

excute() 的用法与 exchange() 大同小异了，它同样可以指定不同的 HttpMethod，不同的是它返回的对象是响应体所映射成的对象，而不是 ResponseEntity。
需要强调的是，execute()方法是以上所有方法的底层调用。随便看一个：

  1. @Override
  2. @Nullable
  3. public <T> T postForObject(String url, @Nullable Object request, Class<T> responseType, Map<String, ?> uriVariables)
  4.     throws RestClientException {
  6.     RequestCallback requestCallback = httpEntityCallback(request, responseType);
  7.     HttpMessageConverterExtractor<T> responseExtractor =
  8.         new HttpMessageConverterExtractor<>(responseType, getMessageConverters(), logger);
  9.     return execute(url, HttpMethod.POST, requestCallback, responseExtractor, uriVariables);
  10. }

6. RestTemplate 添加请求头headers和请求体body

  1. //headers
  2. HttpHeaders requestHeaders = new HttpHeaders();
  3. requestHeaders.add("api-version", "1.0");
  4. requestHeaders.add("Authorization", token);
  5. //body
  6. MultiValueMap<String, String> requestBody = new LinkedMultiValueMap<>();
  7. requestBody.add("roundid", "1");
  8. //HttpEntity
  9. HttpEntity<MultiValueMap> requestEntity = new HttpEntity<MultiValueMap>(requestBody, requestHeaders);
  10. RestTemplate restTemplate = new RestTemplate();
  11. //post
  12. ResponseEntity<String> responseEntity = restTemplate.postForEntity("http://xxx", requestEntity, String.class);
  13. System.out.println(responseEntity.getBody());