如何使用 spring 记录 RestTemplate 请求和响应？

Posted 2023-02-26

【中文标题】如何使用 spring 记录 RestTemplate 请求和响应？

【英文标题】：How to log RestTemplate request and response with spring?

【发布时间】：2015-10-07 01:37:18

【问题描述】：

我正在使用spring 和RestTemplate 来执行GET 查询。

如何在每个请求上自动将任何请求和响应数据记录到日志文件中？

【问题讨论】：

Spring RestTemplate - how to enable full debugging/logging of requests/responses? 的可能重复项

这无济于事，因为当我截获消息时，我会有 org.springframework.http.client.InterceptingClientHttpRequest 类型的 java 对象和`org.springframework.http.client.SimpleClientHttpResponse`。我需要的是响应的文本/xml 表示并记录这个。

您是否尝试将通过 Apache httpClient 的消息发送到 restTempalte 并在 httpclient 级别启用日志？

从以下内容阅读我的答案：[如何通过 RestTemplate 记录请求和响应休息呼叫] (***.com/questions/3892018/…)

从以下内容阅读我对这个问题的回答：answer

【参考方案1】：

您可以通过在 Spring 中使用 ClientHttpRequestInterceptor 来实现。 您必须重写接口 ClientHttpRequestInterceptor 的方法 intercept。

下面是sn-p代码：

@Component
public class LogRequestResponseFilter implements ClientHttpRequestInterceptor 

private static final Logger logger=LoggerFactory.getLogger(LogRequestResponseFilter.class);

   @Override
   public ClientHttpResponse intercept(HttpRequest request, byte[] body, ClientHttpRequestExecution execution)
         throws IOException 

      traceRequest(request, body);
      ClientHttpResponse clientHttpResponse = execution.execute(request, body);
      traceResponse(clientHttpResponse);

      return clientHttpResponse;
    

 private void traceRequest(HttpRequest request, byte[] body) throws IOException 
      logger.debug("request URI : " + request.getURI());
      logger.debug("request method : " + request.getMethod());
      logger.debug("request body : " + getRequestBody(body));
   

   private String getRequestBody(byte[] body) throws UnsupportedEncodingException 
      if (body != null && body.length > 0) 
         return (new String(body, "UTF-8"));
       else 
         return null;
      
   


  private void traceResponse(ClientHttpResponse response) throws IOException 
      String body = getBodyString(response);
      logger.debug("response status code: " + response.getStatusCode());
      logger.debug("response status text: " + response.getStatusText());
      logger.debug("response body : " + body);
   

   private String getBodyString(ClientHttpResponse response) 
      try 
         if (response != null && response.getBody() != null) // &&
                                                              // isReadableResponse(response))
                                                              // 
            StringBuilder inputStringBuilder = new StringBuilder();
            BufferedReader bufferedReader = new BufferedReader(new InputStreamReader(response.getBody(), StandardCharsets.UTF_8));
            String line = bufferedReader.readLine();
            while (line != null) 
               inputStringBuilder.append(line);
               inputStringBuilder.append('\n');
               line = bufferedReader.readLine();
            
            return inputStringBuilder.toString();
          else 
            return null;
         
       catch (IOException e) 
         logger.error(e.getMessage(), e);
         return null;
      
   

【讨论】：

只需将@Component 添加到自定义Interceptor 就足够了吗？还是我必须在某处明确注册它，例如在RestTemplate 上？因为这就是我要避免的：必须自己注册和接线。

我相信@Component 就足够了。您可以点击以下链接，这是很好的示例来源。 blog.cacoveanu.com/2016/06/24/rest-template-logging.html

这记录正确，但如果底层InputStream 不支持标记怎么办？读完就没了。

我得到一个错误，使用它跟踪响应会阻止它稍后被编组到我的 POJO 中。不知道为什么，但它仍然有助于调试。