Überblick

Ich möchte die Ausführung der Web-API mit "RestTemplate" protokollieren, das vom Spring-Framework bereitgestellt wird.

Umgebung

Java 8
SpringBoot 2.1.3.RELEASE
Spring 5.1.5.RELEASE
Lombok 1.18.6

Fügen Sie "ClientHttpRequestInterceptor" in "RestTemplate" ein

--Verwenden Sie einen Interceptor, der in die Anforderung / Antwort von "RestTemplate" eingreift

Interceptor, der Protokolle ausgibt

wichtiger Punkt
Der Antworttext kann nur einmal gelesen werden. Wenn der Antworttext vom Interceptor für die Protokollausgabe gelesen wird, wird ein leerer Text an den Aufrufer von "RestTemplate" zurückgegeben.
Vermeiden Sie dies, indem Sie "BufferingClientHttpRequestFactory" in der später beschriebenen Bean-Definition festlegen.

`Rest Template Interceptor`


import lombok.extern.slf4j.Slf4j;
import lombok.val;
import org.springframework.http.HttpRequest;
import org.springframework.http.client.ClientHttpRequestExecution;
import org.springframework.http.client.ClientHttpRequestInterceptor;
import org.springframework.http.client.ClientHttpResponse;
import org.springframework.util.StreamUtils;

import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.util.UUID;

@Slf4j
public class RestTemplateLoggingInterceptor implements ClientHttpRequestInterceptor {

    @Override
    public ClientHttpResponse intercept(HttpRequest request,
                                        byte[] body,
                                        ClientHttpRequestExecution execution) throws IOException {
        val requestUuid = UUID.randomUUID();
        logRequest(requestUuid, request, body);
        val response = execution.execute(request, body);
        logResponse(requestUuid, response);
        return response;
    }

    private void logRequest(UUID requestUuid, HttpRequest request, byte[] body) {
        if (log.isInfoEnabled()) {
            log.info("[API:Request({})] Request=[{}:{}], Headers=[{}], Body=[{}]",
                requestUuid,
                request.getMethod(),
                request.getURI(),
                request.getHeaders(),
                new String(body)
            );
        }
    }

    private void logResponse(UUID requestUuid, ClientHttpResponse response) throws IOException {
        if (log.isInfoEnabled()) {
            log.info("[API:Response({})] Status=[{}:{}], Headers=[{}], Body=[{}]",
                requestUuid,
                response.getStatusCode().value(),
                response.getStatusText(),
                response.getHeaders(),
                StreamUtils.copyToString(response.getBody(), StandardCharsets.UTF_8)
            );
        }
    }

}

Bean-Definition von "RestTemplate"

--Bean Definition von "RestTemplate" mit einem Interceptor, der Protokolle ausgibt. --Verwenden Sie "BufferingClientHttpRequestFactory", um Probleme mit Protokollausgabeabfangjägern zu vermeiden.

@Configuration
public class ExternalApiConfig {

    @Bean
    RestTemplate restTemplate() {
        return new RestTemplateBuilder()
            .requestFactory(() -> new BufferingClientHttpRequestFactory(new SimpleClientHttpRequestFactory()))
            .additionalInterceptors(new RestTemplateLoggingInterceptor())
            .build();
    }

}

Referenz

Protokollieren Sie den Inhalt von Anfragen und Antworten mit RestTemplate

[JAVA] Melden Sie die Anforderung / Antwort von RestTemplate ab