RestTemplate的一些坑和改造点

一、RestTemplate怎么引入和使用

在pom.xml文件中加入如下dependency：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

在项目的config文件夹下创建InitBeanConfig.java，添加如下代码：

@Bean
public RestTemplate getRestTemplate() {
       return new RestTemplate();
}

使用的方式很简单，如下：

@Autowired
private RestTemplate restTemplate;

二、给RestTemplate设置全局Header

在config文件夹下创建HeaderRequestInterceptor.java

import org.springframework.http.HttpRequest;
import org.springframework.http.MediaType;
import org.springframework.http.client.ClientHttpRequestExecution;
import org.springframework.http.client.ClientHttpRequestInterceptor;
import org.springframework.http.client.ClientHttpResponse;

import java.io.IOException;

/**
 * @author 远猷
 * @version 1.0.0
 * @copyright xxx.com
 * @description RestTemplate拦截器统一添加请求头
 * @create 2021-04-29 17:40:34
 */
public class HeaderRequestInterceptor implements ClientHttpRequestInterceptor {
    @Override
    public ClientHttpResponse intercept(HttpRequest httpRequest, byte[] bytes, ClientHttpRequestExecution clientHttpRequestExecution) throws IOException {
        httpRequest.getHeaders().setContentType(MediaType.APPLICATION_JSON);
        httpRequest.getHeaders().set("Http-Rpc-Type", "JsonContent");
        httpRequest.getHeaders().set("Http-Rpc-Timeout", "3000");
        httpRequest.getHeaders().set("app-name", "xxxx");
        return clientHttpRequestExecution.execute(httpRequest, bytes);
    }
}

在InitBeanConfig的代码中加入

@Bean
public RestTemplate getRestTemplate() {
  RestTemplate restTemplate = new RestTemplate();
  //给所有的Http请求加上请求头
  restTemplate.setInterceptors(Collections.singletonList(new HeaderRequestInterceptor()));
  return restTemplate;
}

三、对RestTemplate进行错误处理

在config文件夹下创建RestTemplateErrorHandler.java

import org.springframework.http.client.ClientHttpResponse;
import org.springframework.stereotype.Component;
import org.springframework.web.client.ResponseErrorHandler;

import java.io.IOException;

/**
 * @author 远猷
 * @version 1.0.0
 * @copyright xxx.com
 * @description 请求过程日志打印
 * @create 2021-04-29 20:48:22
 */
@Component
public class RestTemplateErrorHandler implements ResponseErrorHandler {

    @Override
    public boolean hasError(ClientHttpResponse response) throws IOException {
        // 返回false表示不管response的status是多少都返回没有错
        // 这里可以自己定义那些status code你认为是可以抛Error
        return false;
    }

    @Override
    public void handleError(ClientHttpResponse response) throws IOException {
        // 这里面可以实现你自己遇到了Error进行合理的处理
        System.out.println("handleError" + response);
    }
}

在InitBeanConfig的代码中加入

@Bean
public RestTemplate getRestTemplate() {
   RestTemplate restTemplate = new RestTemplate();
   //给所有的Http请求加上请求头
   restTemplate.setInterceptors(Collections.singletonList(new HeaderRequestInterceptor()));
   //给请求的返回值加上自己的业务处理
   restTemplate.setErrorHandler(new RestTemplateErrorHandler());
   return restTemplate;
 }

四、给RestTemplate的Get设置RequestBody参数

RestTemplate支持通过setRequestFactory设置HTTP请求客户端工具，支持jdk、httpclient、okHttp等，默认使用的是SimpleClientHttpRequestFactory，该工程使用的JDK实现，底层使用OutputStream来传递body数据，不支持GET传递body。

我们可以修改为httpclient，只需要使用HttpComponentsClientHttpRequestFactory，但是默认的httpclient的GET请求也是不支持传递body的。有两个用于定义Http请求的基础抽象类：HttpRequestBase、HttpEntityEnclosingRequestBase，前者扩展的不能传递body，而后者可以。引入httpClient依赖：

<dependency>
    <groupId>org.apache.httpcomponents</groupId
    <artifactId>httpclient</artifactId>
    <version>4.5.13</version>
</dependency>

在config文件夹下创建HttpComponentsClientRestfulHttpRequestFactory.java

import org.apache.http.client.methods.HttpEntityEnclosingRequestBase;
import org.apache.http.client.methods.HttpUriRequest;
import org.springframework.http.HttpMethod;
import org.springframework.http.client.HttpComponentsClientHttpRequestFactory;
import org.springframework.stereotype.Component;

import java.net.URI;

/**
 * @author 远猷
 * @version 1.0.0
 * @copyright xxx.com
 * @description 让RestTemplate的GET请求支持RequestBody参数
 * @create 2021-04-30 09:26:15
 */
@Component
public class HttpComponentsClientRestfulHttpRequestFactory extends HttpComponentsClientHttpRequestFactory {
    @Override
    protected HttpUriRequest createHttpUriRequest(HttpMethod httpMethod, URI uri) {

        if (httpMethod == HttpMethod.GET) {
            return new HttpGetRequestWithEntity(uri);
        }
        return super.createHttpUriRequest(httpMethod, uri);
    }

    /**
     * 定义HttpGetRequestWithEntity实现HttpEntityEnclosingRequestBase抽象类，以支持GET请求携带body数据
     */
    private static final class HttpGetRequestWithEntity extends HttpEntityEnclosingRequestBase {
        public HttpGetRequestWithEntity(final URI uri) {
            super.setURI(uri);
        }

        @Override
        public String getMethod() {
            return HttpMethod.GET.name();

        }
    }
}

在InitBeanConfig的代码中加入

@Bean
public RestTemplate getRestTemplate() {
    RestTemplate restTemplate = new RestTemplate();
    //给所有的Http请求加上请求头
    restTemplate.setInterceptors(Collections.singletonList(new HeaderRequestInterceptor()));
    //给请求的返回值加上自己的业务处理
    restTemplate.setErrorHandler(new RestTemplateErrorHandler());
    //给RestTemplate的get请求加上RequestBody
    restTemplate.setRequestFactory(new HttpComponentsClientRestfulHttpRequestFactory());
    return restTemplate;
}

调用方式

String requestBody = "param"
restTemplate.exchange(url, HttpMethod.GET, new HttpEntity(requestBody, null), Object.class)