Comment enregistrer les requêtes et les réponses Spring RestTemplate pour un débogage efficace ?

Débogage des requêtes et des réponses Spring RestTemplate : un guide complet

Lors du débogage d'un Spring RestTemplate, l'inspection des requêtes et des réponses peut fournir des informations inestimables. Pour répliquer la sortie détaillée de la commande curl avec l'option "-v", nous devons activer la journalisation détaillée ou le débogage pour le RestTemplate.

Une approche consiste à modifier le code source du RestTemplate pour inclure des instructions de journalisation supplémentaires, mais cela n’est pas recommandé comme solution principale. Au lieu de cela, nous pouvons exploiter la puissance de ClientHttpRequestInterceptor.

ClientHttpRequestInterceptor personnalisé pour la journalisation des demandes/réponses

Pour enregistrer les détails de la demande et de la réponse, nous pouvons implémenter un ClientHttpRequestInterceptor :

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=================================================");
    }

}

Configuration de RestTemplate avec tampon et intercepteur

Pour utiliser notre intercepteur personnalisé, configurez le RestTemplate comme suit :

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

Notez que BufferingClientHttpRequestFactory est nécessaire pour permettre à l'intercepteur d'accéder au corps de réponse multiple fois.

Utilisation et résultat attendu

Avec cette configuration en place, l'appel de restTemplate.execute() enregistrera les détails de la demande et de la réponse dans le format souhaité :

restTemplate.put("http://someurl", objectToPut, urlPathValues);

Et vous verrez ce qui suit dans le journal :

===========================request begin===============================================
URI         : http://someurl
Method      : PUT
Headers     : {...}
Request body: {...}
==========================request end===============================================

============================response begin==========================================
Status code  : 200
Status text  : OK
Headers      : {...}
Response body: {...}
=======================response end=================================================

Cette journalisation détaillée fournit une vue complète de Les interactions de RestTemplate, rendant le débogage beaucoup plus efficace et pratique. En évitant les modifications de code et en tirant parti des mécanismes d'extensibilité fournis, cette approche offre une solution propre et flexible à ce défi de débogage courant.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!