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)