成人免费xxxxx在线视频软件_久久精品久久久_亚洲国产精品久久久_天天色天天色_亚洲人成一区_欧美一级欧美三级在线观看

Spring Boot 記錄請求響應日志的常用手段

作者： 碼農小胖哥
開發 架構
某些業務需求需要追蹤我們的接口訪問情況，也就是把請求和響應記錄下來。基本的記錄維度包含了請求入參(路徑query參數，請求體)、請求路徑(uri)、請求方法(method)、請求頭(headers)以及響應狀態、響應頭、甚至包含了敏感的響應體等等。今天總結了幾種方法，你可以按需選擇。

[[416714]]

某些業務需求需要追蹤我們的接口訪問情況，也就是把請求和響應記錄下來。基本的記錄維度包含了請求入參(路徑query參數，請求體)、請求路徑(uri)、請求方法(method)、請求頭(headers)以及響應狀態、響應頭、甚至包含了敏感的響應體等等。今天總結了幾種方法，你可以按需選擇。

請求追蹤的實現方式

網關層

很多網關設施都具有httptrace的功能，可以幫助我們集中記錄請求流量的情況。Orange、Kong、Apache Apisix這些基于Nginx的網關都具有該能力，就連Nginx本身也提供了記錄httptrace日志的能力。

優點是可以集中的管理httptrace日志，免開發;缺點是技術要求高，需要配套的分發、存儲、查詢的設施。

Spring Boot Actuator

在Spring Boot中，其實提供了簡單的追蹤功能。你只需要集成：

  1. <dependency> 
  2.     <groupId>org.springframework.boot</groupId> 
  3.     <artifactId>spring-boot-starter-actuator</artifactId> 
  4. </dependency> 

開啟/actuator/httptrace：

  1. management: 
  2.   endpoints: 
  3.     web: 
  4.       exposure: 
  5.         include: 'httptrace' 

就可以通過http://server:port/actuator/httptrace獲取最近的Http請求信息了。

不過在最新的版本中可能需要顯式的聲明這些追蹤信息的存儲方式，也就是實現HttpTraceRepository接口并注入Spring IoC。

例如放在內存中并限制為最近的100條(不推薦生產使用)：

  1. @Bean 
  2. public HttpTraceRepository httpTraceRepository(){ 
  3.     return new InMemoryHttpTraceRepository(); 
  4. } 

追蹤日志以json格式呈現：

Spring Boot Actuator記錄的httptrace

記錄的維度不多，當然如果夠用的話可以試試。

優點在于集成起來簡單，幾乎免除開發;缺點在于記錄的維度不多，而且需要搭建緩沖消費這些日志信息的設施。

CommonsRequestLoggingFilter

Spring Web模塊還提供了一個過濾器CommonsRequestLoggingFilter，它可以對請求的細節進行日志輸出。配置起來也比較簡單：

  1. @Bean 
  2. CommonsRequestLoggingFilter  loggingFilter(){ 
  3.     CommonsRequestLoggingFilter loggingFilter = new CommonsRequestLoggingFilter(); 
  4.     // 記錄 客戶端 IP信息 
  5.     loggingFilter.setIncludeClientInfo(true); 
  6.     // 記錄請求頭 
  7.     loggingFilter.setIncludeHeaders(true); 
  8.     // 如果記錄請求頭的話，可以指定哪些記錄，哪些不記錄 
  9.     // loggingFilter.setHeaderPredicate(); 
  10.     // 記錄 請求體  特別是POST請求的body參數 
  11.     loggingFilter.setIncludePayload(true); 
  12.     // 請求體的大小限制 默認50 
  13.     loggingFilter.setMaxPayloadLength(10000); 
  14.     //記錄請求路徑中的query參數  
  15.     loggingFilter.setIncludeQueryString(true); 
  16.     return loggingFilter; 
  17. } 

而且必須開啟對CommonsRequestLoggingFilter的debug日志：

  1. logging: 
  2.   level: 
  3.     org: 
  4.       springframework: 
  5.         web: 
  6.           filter: 
  7.             CommonsRequestLoggingFilter: debug 

一次請求會輸出兩次日志，一次是在第一次經過過濾器前;一次是完成過濾器鏈后。

CommonsRequestLoggingFilter記錄請求日志

這里多說一句其實可以改造成輸出json格式的。

優點是靈活配置、而且對請求追蹤的維度全面，缺點是只記錄請求而不記錄響應。

ResponseBodyAdvice

Spring Boot統一返回體其實也能記錄，需要自行實現。這里借鑒了CommonsRequestLoggingFilter解析請求的方法。響應體也可以獲取了，不過響應頭和狀態因為生命周期還不清楚，這里獲取還不清楚是否合適，不過這是一個思路。

  1. /** 
  2.  * @author felord.cn 
  3.  * @since 1.0.8.RELEASE 
  4.  */ 
  5. @Slf4j 
  6. @RestControllerAdvice(basePackages = {"cn.felord.logging"}) 
  7. public class RestBodyAdvice implements ResponseBodyAdvice<Object> { 
  8.     private static final int DEFAULT_MAX_PAYLOAD_LENGTH = 10000; 
  9.     public static final String REQUEST_MESSAGE_PREFIX = "Request ["; 
  10.     public static final String REQUEST_MESSAGE_SUFFIX = "]"; 
  11.     private ObjectMapper objectMapper = new ObjectMapper(); 
  12.  
  13.     @Override 
  14.     public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) { 
  15.         return true; 
  16.     } 
  17.  
  18.     @SneakyThrows 
  19.     @Override 
  20.     public Object beforeBodyWrite(Object body, 
  21.                                   MethodParameter returnType, 
  22.                                   MediaType selectedContentType, 
  23.                                   Class<? extends HttpMessageConverter<?>> selectedConverterType, 
  24.                                   ServerHttpRequest request, 
  25.                                   ServerHttpResponse response) { 
  26.  
  27.         ServletServerHttpRequest servletServerHttpRequest = (ServletServerHttpRequest) request; 
  28.  
  29.         log.debug(createRequestMessage(servletServerHttpRequest.getServletRequest(), REQUEST_MESSAGE_PREFIX, REQUEST_MESSAGE_SUFFIX)); 
  30.         Rest<Object> objectRest; 
  31.         if (body == null) { 
  32.             objectRest = RestBody.okData(Collections.emptyMap()); 
  33.         } else if (Rest.class.isAssignableFrom(body.getClass())) { 
  34.             objectRest = (Rest<Object>) body; 
  35.         } 
  36.         else if (checkPrimitive(body)) { 
  37.             return RestBody.okData(Collections.singletonMap("result", body)); 
  38.         }else { 
  39.             objectRest = RestBody.okData(body); 
  40.         } 
  41.         log.debug("Response Body ["+ objectMapper.writeValueAsString(objectRest) +"]"); 
  42.         return objectRest; 
  43.     } 
  44.  
  45.  
  46.     private boolean checkPrimitive(Object body) { 
  47.         Class<?> clazz = body.getClass(); 
  48.         return clazz.isPrimitive() 
  49.                 || clazz.isArray() 
  50.                 || Collection.class.isAssignableFrom(clazz) 
  51.                 || body instanceof Number 
  52.                 || body instanceof Boolean 
  53.                 || body instanceof Character 
  54.                 || body instanceof String; 
  55.     } 
  56.  
  57.  
  58.     protected String createRequestMessage(HttpServletRequest request, String prefix, String suffix) { 
  59.         StringBuilder msg = new StringBuilder(); 
  60.         msg.append(prefix); 
  61.         msg.append(request.getMethod()).append(" "); 
  62.         msg.append(request.getRequestURI()); 
  63.  
  64.  
  65.         String queryString = request.getQueryString(); 
  66.         if (queryString != null) { 
  67.             msg.append('?').append(queryString); 
  68.         } 
  69.  
  70.  
  71.         String client = request.getRemoteAddr(); 
  72.         if (StringUtils.hasLength(client)) { 
  73.             msg.append(", client=").append(client); 
  74.         } 
  75.         HttpSession session = request.getSession(false); 
  76.         if (session != null) { 
  77.             msg.append(", session=").append(session.getId()); 
  78.         } 
  79.         String user = request.getRemoteUser(); 
  80.         if (user != null) { 
  81.             msg.append(", user=").append(user); 
  82.         } 
  83.  
  84.         HttpHeaders headers = new ServletServerHttpRequest(request).getHeaders(); 
  85.         msg.append(", headers=").append(headers); 
  86.  
  87.         String payload = getMessagePayload(request); 
  88.         if (payload != null) { 
  89.             msg.append(", payload=").append(payload); 
  90.         } 
  91.  
  92.         msg.append(suffix); 
  93.         return msg.toString(); 
  94.     } 
  95.  
  96.     protected String getMessagePayload(HttpServletRequest request) { 
  97.         ContentCachingRequestWrapper wrapper = 
  98.                 WebUtils.getNativeRequest(request, ContentCachingRequestWrapper.class); 
  99.         if (wrapper != null) { 
  100.             byte[] buf = wrapper.getContentAsByteArray(); 
  101.             if (buf.length > 0) { 
  102.                 int length = Math.min(buf.length, DEFAULT_MAX_PAYLOAD_LENGTH); 
  103.                 try { 
  104.                     return new String(buf, 0, length, wrapper.getCharacterEncoding()); 
  105.                 } catch (UnsupportedEncodingException ex) { 
  106.                     return "[unknown]"; 
  107.                 } 
  108.             } 
  109.         } 
  110.         return null; 
  111.     } 
  112. } 

別忘記配置ResponseBodyAdvice的logging級別為DEBUG。

logstash-logback-encoder

這個是logstash的logback編碼器，可以結構化輸出httptrace為json。引入：

  1. <dependency> 
  2.     <groupId>net.logstash.logback</groupId> 
  3.     <artifactId>logstash-logback-encoder</artifactId> 
  4.     <version>6.6</version> 
  5. </dependency> 

配置logback的ConsoleAppender為LogstashEncoder:

  1. <configuration> 
  2.     <appender name="jsonConsoleAppender" class="ch.qos.logback.core.ConsoleAppender"> 
  3.         <encoder class="net.logstash.logback.encoder.LogstashEncoder"/> 
  4.     </appender> 
  5.     <root level=" INFO"> 
  6.         <appender-ref ref="jsonConsoleAppender"/> 
  7.     </root> 
  8. </configuration> 

然后同樣實現一個解析的Filter:

  1. import org.slf4j.Logger; 
  2. import org.slf4j.LoggerFactory; 
  3. import org.slf4j.MDC; 
  4. import org.springframework.core.annotation.Order; 
  5. import org.springframework.stereotype.Component; 
  6.  
  7. import javax.servlet.*; 
  8. import javax.servlet.http.HttpServletRequest; 
  9. import javax.servlet.http.HttpServletResponse; 
  10. import java.io.IOException; 
  11. import java.util.UUID; 
  12.  
  13. /** 
  14.  * @author felord.cn 
  15.  * @since 1.0.8.RELEASE 
  16.  */ 
  17. @Order(1) 
  18. @Component 
  19. public class MDCFilter implements Filter { 
  20.  
  21.     private final Logger LOGGER = LoggerFactory.getLogger(MDCFilter.class); 
  22.     private final String X_REQUEST_ID = "X-Request-ID"; 
  23.  
  24.     @Override 
  25.     public void doFilter(ServletRequest request, 
  26.                          ServletResponse response, 
  27.                          FilterChain chain) throws IOException, ServletException { 
  28.         HttpServletRequest req = (HttpServletRequest) request; 
  29.         HttpServletResponse res = (HttpServletResponse) response; 
  30.         try { 
  31.             addXRequestId(req); 
  32.             LOGGER.info("path: {}, method: {}, query {}", 
  33.                     req.getRequestURI(), req.getMethod(), req.getQueryString()); 
  34.             res.setHeader(X_REQUEST_ID, MDC.get(X_REQUEST_ID)); 
  35.             chain.doFilter(request, response); 
  36.         } finally { 
  37.             LOGGER.info("statusCode {}, path: {}, method: {}, query {}", 
  38.                     res.getStatus(), req.getRequestURI(), req.getMethod(), req.getQueryString()); 
  39.             MDC.clear(); 
  40.         } 
  41.     } 
  42.  
  43.     private void addXRequestId(HttpServletRequest request) { 
  44.         String xRequestId = request.getHeader(X_REQUEST_ID); 
  45.         if (xRequestId == null) { 
  46.             MDC.put(X_REQUEST_ID, UUID.randomUUID().toString()); 
  47.         } else { 
  48.             MDC.put(X_REQUEST_ID, xRequestId); 
  49.         } 
  50.     } 
  51.  
  52. } 

這里解析方式其實還可以更加精細一些。

然后所有的日志都可以結構化為json了：

  1. {"@timestamp":"2021-08-10T23:48:51.322+08:00","@version":"1","message":"statusCode 200, path: /log/get, method: GET, query foo=xxx&bar=ooo","logger_name":"cn.felord.logging.MDCFilter","thread_name":"http-nio-8080-exec-1","level":"INFO","level_value":20000,"X-Request-ID":"7c0db56c-b1f2-4d85-ad9a-7ead67660f96"} 

總結

今天介紹了不少記錄追蹤接口請求響應的方法，總有一款適合你。

本文轉載自微信公眾號「碼農小胖哥」，可以通過以下二維碼關注。轉載本文請聯系碼農小胖哥公眾號。

 

責任編輯：武曉燕 來源： 碼農小胖哥
Spring 日志手段
相關推薦

2025-06-17 07:37:53

2021-03-01 23:26:41

日志Spring BootAOP

2024-06-04 10:05:48

微服務網關日志

2022-02-08 17:07:54

Spring BooSpring Aop日志記錄

2018-11-19 14:29:17

Spring BootXML支持

2010-09-30 14:38:13

2020-10-08 14:52:37

數據網絡威脅安全

2009-07-05 21:04:02

2009-11-27 09:34:38

VS2003命令

2022-11-18 08:31:56

Spring日志工具

2023-03-01 13:54:53

Springpostion?繼承

2025-02-03 09:00:00

API接口性能

2023-09-13 08:56:51

2022-05-12 11:38:26

Java日志Slf4j

2020-09-27 11:35:16

Spring BootStarterJava

2019-04-15 08:32:25

Spring Boot日志門面模式

2024-08-01 09:10:03

2021-03-26 06:01:45

日志MongoDB存儲

2023-09-19 22:41:30

控制器HTTP

2023-12-29 18:13:27

Spring日志應用程序
點贊
收藏

51CTO技術棧公眾號

主站蜘蛛池模板： 亚洲成人一区二区 | 精品九九 | 日韩久久精品视频 | 91精品久久久久久久久 | 国产成人精品网站 | 欧美精品三区 | 亚洲欧美自拍偷拍视频 | 国产一级视屏 | 天天射美女 | 亚洲精品国产成人 | 在线免费观看黄色 | 国内自拍视频在线观看 | www在线| 亚洲一区免费在线 | 成人动慢| 亚洲精品在线免费 | 蜜桃精品视频在线 | www.色.com | 成人久久| 国产精品美女久久久久久久久久久 | 欧美一级片 | 超碰精品在线观看 | 一区二区三区中文字幕 | 日韩精品视频网 | 久久999| 精品欧美乱码久久久久久1区2区 | 日本三级电影在线观看视频 | 国产精品久久国产精品 | 久久精品视频网站 | 久在线| 久久夜色精品国产 | 欧美专区日韩专区 | 成人a免费 | 国产精品视频网 | 亚洲成人一区二区在线 | av网站在线看 | 蜜桃在线播放 | 91免费视频观看 | 91传媒在线观看 | 久久性av | 国产视频二区在线观看 |