微服務中如何使用RestTemplate優雅調用API（攔截器、異常處理、消息轉換）

關注我，可以獲取最新知識、經典面試題以及微服務技術分享

在微服務中，rest服務互相調用是很普遍的，我們該如何優雅地調用，其實在Spring框架使用RestTemplate類可以優雅地進行rest服務互相調用，它簡化了與http服務的通信方式，統一了RESTful的標准，封裝了http鏈接，操作使用簡便，還可以自定義RestTemplate所需的模式。其中：

• RestTemplate默認使用HttpMessageConverter實例將HTTP消息轉換成POJO或者從POJO轉換成HTTP消息。默認情況下會注冊主mime類型的轉換器，但也可以通過setMessageConverters注冊自定義轉換器。
• RestTemplate使用了默認的DefaultResponseErrorHandler，對40XBad Request或50Xinternal異常error等錯誤信息捕捉。
• RestTemplate還可以使用攔截器interceptor，進行對請求鏈接跟蹤，以及統一head的設置。

 

其中，RestTemplate還定義了很多的REST資源交互的方法，其中的大多數都對應於HTTP的方法，如下：

• delete()：在特定的URL上對資源執行HTTP DELETE操作
• exchange()：在URL上執行特定的HTTP方法，返回包含對象的ResponseEntity
• execute()：在URL上執行特定的HTTP方法，返回一個從響應體映射得到的對象
• getForEntity()：發送一個HTTP GET請求，返回的ResponseEntity包含了響應體所映射成的對象
• getForObject()：發送一個HTTP GET請求，返回的請求體將映射為一個對象
• postForEntity()：POST 數據到一個URL，返回包含一個對象的ResponseEntity
• postForObject()：POST 數據到一個URL，返回根據響應體匹配形成的對象
• headForHeaders()：發送HTTP HEAD請求，返回包含特定資源URL的HTTP頭
• optionsForAllow()：發送HTTP OPTIONS請求，返回對特定URL的Allow頭信息
• postForLocation()：POST 數據到一個URL，返回新創建資源的URLput()PUT 資源到特定的URL

1. RestTemplate源碼

1.1 默認調用鏈路

restTemplate進行API調用時，默認調用鏈：

###########1.使用createRequest創建請求########
resttemplate->execute()->doExecute()
HttpAccessor->createRequest()
//獲取攔截器Interceptor，InterceptingClientHttpRequestFactory，SimpleClientHttpRequestFactory
InterceptingHttpAccessor->getRequestFactory() 
//獲取默認的SimpleBufferingClientHttpRequest
SimpleClientHttpRequestFactory->createRequest()

#######2.獲取響應response進行處理###########
AbstractClientHttpRequest->execute()->executeInternal()
AbstractBufferingClientHttpRequest->executeInternal()

###########3.異常處理#####################
resttemplate->handleResponse()

##########4.響應消息體封裝為java對象#######
HttpMessageConverterExtractor->extractData()

1.2 restTemplate->doExecute()

在默認調用鏈中，restTemplate 進行API調用都會調用 doExecute 方法，此方法主要可以進行如下步驟：

1）使用createRequest創建請求，獲取響應
2）判斷響應是否異常，處理異常
3）將響應消息體封裝為java對象

@Nullable
protected <T> T doExecute(URI url, @Nullable HttpMethod method, @Nullable RequestCallback requestCallback,
        @Nullable ResponseExtractor<T> responseExtractor) throws RestClientException {

    Assert.notNull(url, "URI is required");
    Assert.notNull(method, "HttpMethod is required");
    ClientHttpResponse response = null;
    try {
        //使用createRequest創建請求
        ClientHttpRequest request = createRequest(url, method);
        if (requestCallback != null) {
            requestCallback.doWithRequest(request);
        }
        //獲取響應response進行處理
        response = request.execute();
        //異常處理
        handleResponse(url, method, response);
        //響應消息體封裝為java對象
        return (responseExtractor != null ? responseExtractor.extractData(response) : null);
    }catch (IOException ex) {
        String resource = url.toString();
        String query = url.getRawQuery();
        resource = (query != null ? resource.substring(0, resource.indexOf('?')) : resource);
        throw new ResourceAccessException("I/O error on " + method.name() +
                " request for \"" + resource + "\": " + ex.getMessage(), ex);
    }finally {
        if (response != null) {
            response.close();
        }
    }
}

1.3 InterceptingHttpAccessor->getRequestFactory()

在默認調用鏈中，InterceptingHttpAccessor的getRequestFactory()方法中，如果沒有設置interceptor攔截器，就返回默認的SimpleClientHttpRequestFactory，反之，返回InterceptingClientHttpRequestFactory的requestFactory，可以通過resttemplate.setInterceptors設置自定義攔截器interceptor。

//Return the request factory that this accessor uses for obtaining client request handles.
public ClientHttpRequestFactory getRequestFactory() {
        //獲取攔截器interceptor(自定義的)
        List<ClientHttpRequestInterceptor> interceptors = getInterceptors();
        if (!CollectionUtils.isEmpty(interceptors)) {
            ClientHttpRequestFactory factory = this.interceptingRequestFactory;
            if (factory == null) {
                factory = new InterceptingClientHttpRequestFactory(super.getRequestFactory(), interceptors);
                this.interceptingRequestFactory = factory;
            }
            return factory;
        }
        else {
            return super.getRequestFactory();
        }
    }

然后再調用SimpleClientHttpRequestFactory的createRequest創建連接：

@Override
public ClientHttpRequest createRequest(URI uri, HttpMethod httpMethod) throws IOException {
    HttpURLConnection connection = openConnection(uri.toURL(), this.proxy);
    prepareConnection(connection, httpMethod.name());

    if (this.bufferRequestBody) {
        return new SimpleBufferingClientHttpRequest(connection, this.outputStreaming);
    }
    else {
        return new SimpleStreamingClientHttpRequest(connection, this.chunkSize, this.outputStreaming);
    }
}

1.4 resttemplate->handleResponse()

在默認調用鏈中，resttemplate的handleResponse，響應處理，包括異常處理，而且異常處理可以通過調用setErrorHandler方法設置自定義的ErrorHandler，實現對請求響應異常的判別和處理。自定義的ErrorHandler需實現ResponseErrorHandler接口，同時Spring boot也提供了默認實現DefaultResponseErrorHandler，因此也可以通過繼承該類來實現自己的ErrorHandler。

DefaultResponseErrorHandler默認對40X Bad Request或50X internal異常error等錯誤信息捕捉。如果想捕捉服務本身拋出的異常信息，需要通過自行實現RestTemplate的ErrorHandler。

ResponseErrorHandler errorHandler = getErrorHandler();
               //判斷響應是否有異常
    boolean hasError = errorHandler.hasError(response);
    if (logger.isDebugEnabled()) {
        try {
            int code = response.getRawStatusCode();
            HttpStatus status = HttpStatus.resolve(code);
            logger.debug("Response " + (status != null ? status : code));
        }catch (IOException ex) {
            // ignore
        }
    }
    //有異常進行異常處理
    if (hasError) {
        errorHandler.handleError(url, method, response);
    }
}

1.5 HttpMessageConverterExtractor->extractData()

在默認調用鏈中， HttpMessageConverterExtractor的extractData中進行響應消息體封裝為java對象，就需要使用message轉換器，可以通過追加的方式增加自定義的messageConverter：先獲取現有的messageConverter，再將自定義的messageConverter添加進去。

根據restTemplate的setMessageConverters的源碼可得，使用追加的方式可防止原有的messageConverter丟失，源碼：

public void setMessageConverters(List<HttpMessageConverter<?>> messageConverters) {
        //檢驗
        validateConverters(messageConverters);
        // Take getMessageConverters() List as-is when passed in here
        if (this.messageConverters != messageConverters) {
            //先清除原有的messageConverter
            this.messageConverters.clear();
            //后加載重新定義的messageConverter
            this.messageConverters.addAll(messageConverters);
        }
    }

HttpMessageConverterExtractor的extractData源碼：

MessageBodyClientHttpResponseWrapper responseWrapper = new MessageBodyClientHttpResponseWrapper(response);
    if (!responseWrapper.hasMessageBody() || responseWrapper.hasEmptyMessageBody()) {
        return null;
    }
    //獲取到response的ContentType類型
    MediaType contentType = getContentType(responseWrapper);

    try {
        //依次循環messageConverter進行判斷是否符合轉換條件，進行轉換java對象
        for (HttpMessageConverter<?> messageConverter : this.messageConverters) {
        //會根據設置的返回類型responseType和contentType參數進行匹配，選擇合適的MessageConverter
            if (messageConverter instanceof GenericHttpMessageConverter) {
                GenericHttpMessageConverter<?> genericMessageConverter =
                        (GenericHttpMessageConverter<?>) messageConverter;
                if (genericMessageConverter.canRead(this.responseType, null, contentType)) {
                    if (logger.isDebugEnabled()) {
                        ResolvableType resolvableType = ResolvableType.forType(this.responseType);
                        logger.debug("Reading to [" + resolvableType + "]");
                    }
                    return (T) genericMessageConverter.read(this.responseType, null, responseWrapper);
                }
            }
            if (this.responseClass != null) {
                if (messageConverter.canRead(this.responseClass, contentType)) {
                    if (logger.isDebugEnabled()) {
                        String className = this.responseClass.getName();
                        logger.debug("Reading to [" + className + "] as \"" + contentType + "\"");
                    }
                    return (T) messageConverter.read((Class) this.responseClass, responseWrapper);
                }
            }
        }
    }
    .....
}

1.6 contentType與messageConverter之間的關系

在HttpMessageConverterExtractor的extractData方法中看出，會根據contentType與responseClass選擇messageConverter是否可讀、消息轉換。關系如下：

ByteArrayHttpMessageConverter:java對象byte[]，contentType為application/octet-stream, */*
StringHttpMessageConverter: :java對象String，contentType為text/plain, */*
ResourceHttpMessageConverter: Resource，contentType為*/*
SourceHttpMessageConverter: :java對象Source ，contentType為application/xml, text/xml, application/*+xml
AllEncompassingFormHttpMessageConverter：:java對象Map<K, List<?>>，contentType為application/x-www-form-urlencoded, multipart/form-data
MappingJackson2HttpMessageConverter：:java對象Object ，contentType為application/json, application/*+
jsonJaxb2RootElementHttpMessageConverter：:java對象Object ，contentType為 application/xml, text/xml, application/*+xml
JavaSerializationConverter：:java對象Serializable ，contentType為x-java-serialization;charset=UTF-8Fast
JsonHttpMessageConverter: :java對象Object ，contentType為 */*

2. springboot集成RestTemplate

根據上述源碼的分析學習，可以輕松，簡單地在項目進行對RestTemplate進行優雅地使用，比如增加自定義的異常處理、MessageConverter以及攔截器interceptor。本文使用示例demo，詳情請查看接下來的內容。

2.1. 導入依賴：（RestTemplate集成在Web Start中）

<!-- https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-starter-web -->
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-web</artifactId>
  <version>2.2.0.RELEASE</version>
</dependency>
<!-- https://mvnrepository.com/artifact/org.projectlombok/lombok -->
<dependency>
  <groupId>org.projectlombok</groupId>
  <artifactId>lombok</artifactId>
  <version>1.18.10</version>
  <scope>provided</scope>
</dependency>

2.2. RestTemplat配置：

• 使用ClientHttpRequestFactory屬性配置RestTemplat參數，比如ConnectTimeout，ReadTimeout;
• 增加自定義的interceptor攔截器和異常處理;
• 追加message轉換器;
• 配置自定義的異常處理.

@Configuration
public class RestTemplateConfig {

    @Value("${resttemplate.connection.timeout}")
    private int restTemplateConnectionTimeout;
    @Value("${resttemplate.read.timeout}")
    private int restTemplateReadTimeout;

    @Bean
    //@LoadBalanced
    public RestTemplate restTemplate( ClientHttpRequestFactory simleClientHttpRequestFactory) {
        RestTemplate restTemplate = new RestTemplate();
        //配置自定義的message轉換器
        List<HttpMessageConverter<?>> messageConverters = restTemplate.getMessageConverters();
        messageConverters.add(new CustomMappingJackson2HttpMessageConverter());
        restTemplate.setMessageConverters(messageConverters);
        //配置自定義的interceptor攔截器
        List<ClientHttpRequestInterceptor> interceptors=new ArrayList<ClientHttpRequestInterceptor>();
        interceptors.add(new HeadClientHttpRequestInterceptor());
        interceptors.add(new TrackLogClientHttpRequestInterceptor());
        restTemplate.setInterceptors(interceptors);
        //配置自定義的異常處理
        restTemplate.setErrorHandler(new CustomResponseErrorHandler());
        restTemplate.setRequestFactory(simleClientHttpRequestFactory);

        return restTemplate;
    }

    @Bean
    public ClientHttpRequestFactory simleClientHttpRequestFactory(){
        SimpleClientHttpRequestFactory reqFactory= new SimpleClientHttpRequestFactory();
        reqFactory.setConnectTimeout(restTemplateConnectionTimeout);
        reqFactory.setReadTimeout(restTemplateReadTimeout);
        return reqFactory;
    }
}

2.3. 組件(自定義異常處理、interceptor攔截器、message轉化器)

自定義interceptor攔截器，實現ClientHttpRequestInterceptor接口

• 自定義TrackLogClientHttpRequestInterceptor，記錄resttemplate的request和response信息，可進行追蹤分析；
• 自定義HeadClientHttpRequestInterceptor，設置請求頭的參數。API發送各種請求，很多請求都需要用到相似或者相同的Http Header。如果在每次請求之前都把Header填入HttpEntity/RequestEntity，這樣的代碼會顯得十分冗余，可以在攔截器統一設置。

 

TrackLogClientHttpRequestInterceptor：

/**
 * @Auther: ccww
 * @Date: 2019/10/25 22:48，記錄resttemplate訪問信息
 * @Description:   記錄resttemplate訪問信息
 */
@Slf4j
public class TrackLogClientHttpRequestInterceptor implements ClientHttpRequestInterceptor {
    public ClientHttpResponse intercept(HttpRequest request, byte[] body, ClientHttpRequestExecution execution) throws IOException {
        trackRequest(request,body);
        ClientHttpResponse httpResponse = execution.execute(request, body);
        trackResponse(httpResponse);
        return httpResponse;
    }

    private void trackResponse(ClientHttpResponse httpResponse)throws IOException {
        log.info("============================response begin==========================================");
        log.info("Status code  : {}", httpResponse.getStatusCode());
        log.info("Status text  : {}", httpResponse.getStatusText());
        log.info("Headers      : {}", httpResponse.getHeaders());
        log.info("=======================response end=================================================");
    }

    private void trackRequest(HttpRequest request, byte[] body)throws UnsupportedEncodingException {
        log.info("======= request begin ========");
        log.info("uri : {}", request.getURI());
        log.info("method : {}", request.getMethod());
        log.info("headers : {}", request.getHeaders());
        log.info("request body : {}", new String(body, "UTF-8"));
        log.info("======= request end ========");
    }
}

HeadClientHttpRequestInterceptor：

@Slf4j
public class HeadClientHttpRequestInterceptor implements ClientHttpRequestInterceptor {
    public ClientHttpResponse intercept(HttpRequest httpRequest, byte[] bytes, ClientHttpRequestExecution clientHttpRequestExecution) throws IOException {
       log.info("#####head handle########");
        HttpHeaders headers = httpRequest.getHeaders();
        headers.add("Accept", "application/json");
        headers.add("Accept-Encoding", "gzip");
        headers.add("Content-Encoding", "UTF-8");
        headers.add("Content-Type", "application/json; charset=UTF-8");
        ClientHttpResponse response = clientHttpRequestExecution.execute(httpRequest, bytes);
        HttpHeaders headersResponse = response.getHeaders();
        headersResponse.add("Accept", "application/json");
        return  response;
    }
}

自定義異常處理，可繼承DefaultResponseErrorHandler或者實現ResponseErrorHandler接口：

• 實現自定義ErrorHandler的思路是根據響應消息體進行相應的異常處理策略，對於其他異常情況由父類DefaultResponseErrorHandler來進行處理。
• 自定義CustomResponseErrorHandler進行30x異常處理

 

CustomResponseErrorHandler:

/**
 * @Auther: Ccww
 * @Date: 2019/10/28 17:00
 * @Description:  30X的異常處理
 */
@Slf4j
public class CustomResponseErrorHandler extends DefaultResponseErrorHandler {
    @Override
    public boolean hasError(ClientHttpResponse response) throws IOException {
        HttpStatus statusCode = response.getStatusCode();
        if(statusCode.is3xxRedirection()){
            return true;
        }
        return super.hasError(response);
    }

    @Override
    public void handleError(ClientHttpResponse response) throws IOException {
        HttpStatus statusCode = response.getStatusCode();
        if(statusCode.is3xxRedirection()){
            log.info("########30X錯誤，需要重定向！##########");
            return;
        }
        super.handleError(response);
    }

}

自定義message轉化器

 

/**
 * @Auther: Ccww
 * @Date: 2019/10/29 21:15
 * @Description: 將Content-Type:"text/html"轉換為Map類型格式
 */
public class CustomMappingJackson2HttpMessageConverter extends MappingJackson2HttpMessageConverter {
    public CustomMappingJackson2HttpMessageConverter() {
        List<MediaType> mediaTypes = new ArrayList<MediaType>();
        mediaTypes.add(MediaType.TEXT_PLAIN);
        mediaTypes.add(MediaType.TEXT_HTML);  //加入text/html類型的支持
        setSupportedMediaTypes(mediaTypes);// tag6
    }

}