RestTemplateConfig详解

一、RestTemplate配置

使用RestTemplate进行服务调用时，需要进行一些配置，才能使RestTemplate按照我们想要的方式进行调用。

我们通常将RestTemplate的配置封装在一个类中，以便于管理和维护，该类通常命名为RestTemplateConfig。

@Configuration
public class RestTemplateConfig {
 
    @Bean
    public RestTemplate restTemplate() {
        return new RestTemplate();
    }
 
    @Bean
    public HttpClient httpClient() {
        return HttpClientBuilder.create().build();
    }
 
    @Bean
    public HttpComponentsClientHttpRequestFactory httpComponentsClientHttpRequestFactory(HttpClient httpClient) {
        return new HttpComponentsClientHttpRequestFactory(httpClient);
    }
 
    @Bean
    public RestTemplate httpsRestTemplate(HttpComponentsClientHttpRequestFactory httpComponentsClientHttpRequestFactory) {
        return new RestTemplate(httpComponentsClientHttpRequestFactory);
    }
}

上述代码中的RestTemplate bean会被Spring进行内部化处理，在项目中可以直接通过@Autowired注解进行注入。

HttpClient的实例化采用了builder模式，它与我们平时使用的HttpClient实例化方式不同，使用了一些新的配置选项来支持更多的请求形式。

HttpComponentsClientHttpRequestFactory的实例化使用了HttpClient实例，以处理请求。

最后，我们通过实例化httpsRestTemplate方法来配置RestTemplate的行为，并将HttpComponentsClientHttpRequestFactory传递给它以便于使用我们的HttpClient对象来处理请求。

二、RestTemplate使用

使用RestTemplate进行服务调用大概分为两种情况：

1.直接使用RestTemplate进行调用

在不涉及到https和其他特定协议的服务调用时，我们可以直接使用RestTemplate进行调用。

@Autowired
private RestTemplate restTemplate;

public String callService() {
    String url = "http://example.com/service";
    String response = restTemplate.getForObject(url, String.class);
    return response;
}

上述代码中，我们直接使用RestTemplate的getForObject方法进行调用，并将调用结果转换为字符串。

2.使用RestTemplate进行https服务调用

在进行https服务调用时，我们需要先配置HttpClient和SSL相关的配置，然后再通过RestTemplate进行调用。

在RestTemplate的配置中，我们定义了一个httpsRestTemplate bean，通过该bean我们可以进行https服务调用。

@Autowired
private RestTemplate httpsRestTemplate;

public String callService() {
    String url = "https://example.com/service";
    String response = httpsRestTemplate.getForObject(url, String.class);
    return response;
}

上述代码中，我们使用httpsRestTemplate进行调用，并将SSL相关的设置内部处理。

三、RestTemplate异常处理

RestTemplate在进行服务调用时可能会遇到各种异常情况，例如连接超时、请求超时、404等，这些异常都需要进行有效的处理。

1.连接超时

连接超时是指在指定时间内无法与目标服务建立连接的情况。

我们可以通过设置HttpComponentsClientHttpRequestFactory的超时选项来定义超时时间。

@Bean
public HttpComponentsClientHttpRequestFactory httpComponentsClientHttpRequestFactory(HttpClient httpClient) {
    HttpComponentsClientHttpRequestFactory httpComponentsClientHttpRequestFactory = new HttpComponentsClientHttpRequestFactory(httpClient);
    httpComponentsClientHttpRequestFactory.setConnectTimeout(5000);
    httpComponentsClientHttpRequestFactory.setReadTimeout(5000);
    return httpComponentsClientHttpRequestFactory;
}

上述代码中，我们设置了连接超时时间为5秒，读取超时时间同样为5秒。

2.请求超时

请求超时是指向目标服务发出请求后，在指定时间内没有收到响应的情况。

与连接超时类似，我们可以通过设置HttpComponentsClientHttpRequestFactory的超时选项来定义超时时间。

@Bean
public HttpComponentsClientHttpRequestFactory httpComponentsClientHttpRequestFactory(HttpClient httpClient) {
    HttpComponentsClientHttpRequestFactory httpComponentsClientHttpRequestFactory = new HttpComponentsClientHttpRequestFactory(httpClient);
    httpComponentsClientHttpRequestFactory.setConnectTimeout(5000);
    httpComponentsClientHttpRequestFactory.setReadTimeout(5000);
    return httpComponentsClientHttpRequestFactory;
}

上述代码中，我们设置了请求超时时间为5秒。

3.404错误

在进行服务调用时，有时会遇到404错误，表示请求的资源不存在。

我们可以通过判断HttpStatus，来进行404错误的处理。

@Autowired
private RestTemplate restTemplate;

public String callService() {
    String url = "http://example.com/service";
    ResponseEntity responseEntity = restTemplate.getForEntity(url, String.class);
    if (responseEntity.getStatusCode() == HttpStatus.NOT_FOUND) {
        return "404 Not Found";
    }
    return responseEntity.getBody();
}

上述代码中，我们使用getForEntity方法进行调用，并通过HttpStatus.NOT_FOUND判断是否遇到404错误。

四、RestTemplate的拦截器

在使用RestTemplate进行服务调用时，我们可能需要对请求进行一些统一的处理，例如添加公共的header、记录请求日志、重试机制等。

这时候，利用RestTemplate的拦截器机制可以非常方便地实现这些功能。

@Configuration
public class RestTemplateConfig {
 
    @Bean
    public RestTemplate restTemplate(ClientHttpRequestInterceptor loggingInterceptor) {
        RestTemplate restTemplate = new RestTemplate();
        restTemplate.setInterceptors(Collections.singletonList(loggingInterceptor));
        return restTemplate;
    }
 
    @Bean
    public ClientHttpRequestInterceptor loggingInterceptor() {
        return new LoggingInterceptor();
    }
 
    private static class LoggingInterceptor implements ClientHttpRequestInterceptor {
 
        @Override
        public ClientHttpResponse intercept(HttpRequest request, byte[] body, ClientHttpRequestExecution execution) throws IOException {
            // 记录请求日志
            LOGGER.info("RestTemplate请求: {} {}", request.getMethod(), request.getURI());
            if (body.length > 0) {
                LOGGER.info("RestTemplate请求Body: {}", new String(body));
            }
            ClientHttpResponse response = execution.execute(request, body);
            // 记录响应日志
            LOGGER.info("RestTemplate响应: {}", response.getStatusCode());
            if (response.getBody() != null) {
                LOGGER.info("RestTemplate响应Body: {}", IOUtils.toString(response.getBody(), StandardCharsets.UTF_8));
            }
            return response;
        }
    }
}

上述代码中，我们定义了一个LoggingInterceptor拦截器，实现了一个简单的日志记录功能，在RestTemplate的配置中，我们将它作为一个拦截器进行注册。

这样，在每次RestTemplate进行服务调用时，都会经过LoggingInterceptor拦截器，以实现我们配置的统一处理。

五、总结

本文详细介绍了RestTemplate的配置、使用、异常处理和拦截器等方面，通过本文的学习，我们可以更加熟练地使用RestTemplate进行服务调用，并能够处理各种异常情况。