How to Enable Exhaustive Debugging Logging for Requests and Responses using Spring RestTemplate?-javaTutorial-php.cn

How to Enable Exhaustive Debugging Logging for Requests and Responses using Spring RestTemplate?

Mary-Kate Olsen

Release： 2024-11-23 02:43:14

Original

286 people have browsed it

How to Enable Exhaustive Debugging Logging for Requests and Responses using Spring RestTemplate?

How to Enable Exhaustive Debugging Logging for Requests and Responses using Spring RestTemplate

Problem

Debugging HTTP requests and responses can be challenging when using Spring RestTemplate, as it lacks detailed logging information. Similar to curl's verbose mode, you may require insights into both sent and received data, including headers and cookies.

Solution

Instead of modifying the RestTemplate source code, you can use a custom ClientHttpRequestInterceptor to intercept and log request and response data. Here's a complete example:

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.http.HttpRequest;
import org.springframework.http.client.ClientHttpRequestExecution;
import org.springframework.http.client.ClientHttpRequestInterceptor;
import org.springframework.http.client.ClientHttpResponse;

public class LoggingRequestInterceptor implements ClientHttpRequestInterceptor {

    final static Logger log = LoggerFactory.getLogger(LoggingRequestInterceptor.class);

    @Override
    public ClientHttpResponse intercept(HttpRequest request, byte[] body, ClientHttpRequestExecution execution) throws IOException {
        traceRequest(request, body);
        ClientHttpResponse response = execution.execute(request, body);
        traceResponse(response);
        return response;
    }

    private void traceRequest(HttpRequest request, byte[] body) throws IOException {
        log.info("===========================request begin================================================");
        log.debug("URI         : {}", request.getURI());
        log.debug("Method      : {}", request.getMethod());
        log.debug("Headers     : {}", request.getHeaders() );
        log.debug("Request body: {}", new String(body, "UTF-8"));
        log.info("==========================request end================================================");
    }

    private void traceResponse(ClientHttpResponse response) throws IOException {
        StringBuilder inputStringBuilder = new StringBuilder();
        BufferedReader bufferedReader = new BufferedReader(new InputStreamReader(response.getBody(), "UTF-8"));
        String line = bufferedReader.readLine();
        while (line != null) {
            inputStringBuilder.append(line);
            inputStringBuilder.append('\n');
            line = bufferedReader.readLine();
        }
        log.info("============================response begin==========================================");
        log.debug("Status code  : {}", response.getStatusCode());
        log.debug("Status text  : {}", response.getStatusText());
        log.debug("Headers      : {}", response.getHeaders());
        log.debug("Response body: {}", inputStringBuilder.toString());
        log.info("=======================response end=================================================");
    }

}

Copy after login

To use this interceptor, instantiate a RestTemplate using a BufferingClientHttpRequestFactory and register the LoggingRequestInterceptor:

RestTemplate restTemplate = new RestTemplate(new BufferingClientHttpRequestFactory(new SimpleClientHttpRequestFactory()));
List<ClientHttpRequestInterceptor> interceptors = new ArrayList<>();
interceptors.add(new LoggingRequestInterceptor());
restTemplate.setInterceptors(interceptors);

Copy after login

This solution provides a customizable and convenient way to capture and log request and response details, aiding in troubleshooting and debugging RESTful web service communication using Spring RestTemplate.

The above is the detailed content of How to Enable Exhaustive Debugging Logging for Requests and Responses using Spring RestTemplate?. For more information, please follow other related articles on the PHP Chinese website!