揭秘：让Spring RestTemplate 打印出请求和响应日志的秘诀

2022-11-11 10:39:27

如何通过 RestTemplate 打印日志，轻松进行调试和分析

在使用 Spring 框架进行 Web 开发时，RestTemplate 是一个不可或缺的工具，它提供了发送 HTTP 请求和处理响应的简洁方式。为了方便我们调试和分析问题，RestTemplate 还提供了打印日志的功能。

使用 RestTemplate 打印日志

1. 定义 RestTemplate Bean**

要使用 RestTemplate 打印日志，首先需要定义一个 bean。我们可以通过指定 LoggingClientHttpRequestInterceptor 拦截器来实现日志打印。

@Configuration
public class RestTemplateConfig {

    @Bean
    public RestTemplate restTemplate() {
        RestTemplate restTemplate = new RestTemplate();
        // 设置拦截器，打印日志
        restTemplate.setInterceptors(Collections.singletonList(new LoggingClientHttpRequestInterceptor()));
        return restTemplate;
    }
}

2. 实现日志打印拦截器**

在定义 bean 时，我们指定了一个拦截器 LoggingClientHttpRequestInterceptor，这个拦截器会打印出请求和响应的内容。

public class LoggingClientHttpRequestInterceptor implements ClientHttpRequestInterceptor {

    @Override
    public ClientHttpResponse intercept(HttpRequest request, byte[] body, ClientHttpRequestExecution execution) throws IOException {
        // 打印请求信息
        System.out.println("Request: " + request.getMethod() + " " + request.getURI());
        System.out.println("Request Body: " + new String(body));

        // 执行请求
        ClientHttpResponse response = execution.execute(request, body);

        // 打印响应信息
        System.out.println("Response Status: " + response.getStatusCode());
        System.out.println("Response Body: " + IOUtils.toString(response.getBody()));

        return response;
    }
}

使用 RestTemplate 打印日志

定义好 RestTemplate bean 之后，就可以在项目中使用了。

@Autowired
private RestTemplate restTemplate;

// 发送请求
ResponseEntity<String> response = restTemplate.getForEntity("https://www.baidu.com", String.class);

// 打印响应信息
System.out.println("Response Status: " + response.getStatusCode());
System.out.println("Response Body: " + response.getBody());

3. 示例代码**

以下是一个完整的示例代码，演示了如何使用 RestTemplate 打印日志：

@SpringBootApplication
public class App {

    public static void main(String[] args) {
        SpringApplication.run(App.class, args);
    }

    @Bean
    public RestTemplate restTemplate() {
        RestTemplate restTemplate = new RestTemplate();
        restTemplate.setInterceptors(Collections.singletonList(new LoggingClientHttpRequestInterceptor()));
        return restTemplate;
    }

    @RestController
    public class Controller {

        @Autowired
        private RestTemplate restTemplate;

        @GetMapping("/")
        public String index() {
            ResponseEntity<String> response = restTemplate.getForEntity("https://www.baidu.com", String.class);
            return response.getBody();
        }
    }
}