知識庫 / HTTP Client-Side RSS 訂閱

1. 概述

本教程將學習如何實現高效的 <em >RestTemplate</em> 請求/響應日誌記錄。 這對於調試兩個服務器之間的交互特別有用。

不幸的是，Spring Boot 沒有提供一種方便的方法來檢查或記錄簡單的 JSON 響應體。

我們將探索多種方法來記錄 HTTP 頭部或，更重要的是，HTTP 實體。

注意：Spring 的 <em >RestTemplate</em> 將被棄用，將被 <em >WebClient</em> 取代。 您可以在這裏找到使用 <em >WebClient</em> 的類似文章：記錄 Spring WebClient 調用。

2. 使用 RestTemplate 進行基本日誌記錄

讓我們從在 application.properties 文件中配置 RestTemplate 日誌記錄開始：

logging.level.org.springframework.web.client.RestTemplate=DEBUG

因此，我們可以僅看到基本信息，例如請求 URL、方法、請求體和響應狀態:

o.s.w.c.RestTemplate - HTTP POST http://localhost:8082/spring-rest/persons
o.s.w.c.RestTemplate - Accept=[text/plain, application/json, application/*+json, */*]
o.s.w.c.RestTemplate - Writing [my request body] with org.springframework.http.converter.StringHttpMessageConverter
o.s.w.c.RestTemplate - Response 200 OK

然而，響應體在這裏未被記錄，這不太理想，因為它包含了最重要的信息。

為了解決這個問題，我們將選擇使用 Apache HttpClient 或 Spring 攔截器。

3. 使用 Apache HttpClient 記錄日誌

首先，我們需要讓 RestTemplate 使用 Apache HttpClient 實現。

我們需要以下 Maven 依賴：

<dependency>
    <groupId>org.apache.httpcomponents.core5</groupId>
    <artifactId>httpcore5</artifactId>
    <version>5.2.1</version>
</dependency>

當創建 RestTemplate 實例時，我們應該告訴它我們正在使用 Apache HttpClient：

RestTemplate restTemplate = new RestTemplate();
restTemplate.setRequestFactory(new HttpComponentsClientHttpRequestFactory());

然後，讓我們在 application.properties文件中配置客户端日誌記錄器：

logging.level.org.apache.http=DEBUG
logging.level.httpclient.wire=DEBUG

現在我們可以看到請求/響應頭和內容主體。

    o.a.http.headers - http-outgoing-0 >> POST /spring-rest/persons HTTP/1.1
    o.a.http.headers - http-outgoing-0 >> Accept: text/plain, application/json, application/*+json, */*
// ... more request headers
    o.a.http.headers - http-outgoing-0 >> User-Agent: Apache-HttpClient/4.5.9 (Java/1.8.0_171)
    o.a.http.headers - http-outgoing-0 >> Accept-Encoding: gzip,deflate
org.apache.http.wire - http-outgoing-0 >> "POST /spring-rest/persons HTTP/1.1[\r][\n]"
org.apache.http.wire - http-outgoing-0 >> "Accept: text/plain, application/json, application/*+json, */*[\r][\n]"
org.apache.http.wire - http-outgoing-0 >> "Content-Type: text/plain;charset=ISO-8859-1[\r][\n]"
// ... more request headers
org.apache.http.wire - http-outgoing-0 >> "[\r][\n]"
org.apache.http.wire - http-outgoing-0 >> "my request body"
org.apache.http.wire - http-outgoing-0 << "HTTP/1.1 200 [\r][\n]"
org.apache.http.wire - http-outgoing-0 << "Content-Type: application/json[\r][\n]"
// ... more response headers
org.apache.http.wire - http-outgoing-0 << "Connection: keep-alive[\r][\n]"
org.apache.http.wire - http-outgoing-0 << "[\r][\n]"
org.apache.http.wire - http-outgoing-0 << "21[\r][\n]"
org.apache.http.wire - http-outgoing-0 << "["Lucie","Jackie","Danesh","Tao"][\r][\n]"

然而，這些日誌冗餘且不便於調試。

在下一章中，我們將探討如何解決這個問題。

4. 使用 RestTemplate 攔截器記錄請求體

我們可以通過配置 RestTemplate 的攔截器，作為另一種解決方案。

4.1. 日誌攔截器實現

首先，我們創建一個新的 LoggingInterceptor 以自定義日誌記錄 。此攔截器將請求體記錄為簡單的字節數組。但是，對於響應，我們需要讀取整個體內容流：

public class LoggingInterceptor implements ClientHttpRequestInterceptor {

    static Logger LOGGER = LoggerFactory.getLogger(LoggingInterceptor.class);

    @Override
    public ClientHttpResponse intercept(
      HttpRequest req, byte[] reqBody, ClientHttpRequestExecution ex) throws IOException {
        LOGGER.debug("Request body: {}", new String(reqBody, StandardCharsets.UTF_8));
        ClientHttpResponse response = ex.execute(req, reqBody);
        InputStreamReader isr = new InputStreamReader(
          response.getBody(), StandardCharsets.UTF_8);
        String body = new BufferedReader(isr).lines()
            .collect(Collectors.joining("\n"));
        LOGGER.debug("Response body: {}", body);
        return response;
    }
}

ClientHttpRequestFactory factory = 
        new BufferingClientHttpRequestFactory(new SimpleClientHttpRequestFactory());
        RestTemplate restTemplate = new RestTemplate(factory);

List<ClientHttpRequestInterceptor> interceptors = restTemplate.getInterceptors();
if (CollectionUtils.isEmpty(interceptors)) {
    interceptors = new ArrayList<>();
}
interceptors.add(new LoggingInterceptor());
restTemplate.setInterceptors(interceptors);

c.b.r.l.LoggingInterceptor - Request body: my request body
c.b.r.l.LoggingInterceptor - Response body: ["Lucie","Jackie","Danesh","Tao"]

RestTemplate restTemplate = null;
if (LOGGER.isDebugEnabled()) {
    ClientHttpRequestFactory factory 
    = new BufferingClientHttpRequestFactory(new SimpleClientHttpRequestFactory());
    restTemplate = new RestTemplate(factory);
} else {
    restTemplate = new RestTemplate();
}

if (LOGGER.isDebugEnabled()) {
    InputStreamReader isr = new InputStreamReader(response.getBody(), StandardCharsets.UTF_8);
    String body = new BufferedReader(isr)
        .lines()
        .collect(Collectors.joining("\n"));
    LOGGER.debug("Response body: {}", body);
}