詳解如何為SpringBoot Web應用的日志方便追蹤

更新時間：2023年11月01日 08:33:32 作者：JAVA旭陽

在Web應用程序領域,有效的請求監(jiān)控和可追溯性對于維護系統(tǒng)完整性和診斷問題至關重要,SpringBoot是一種用于構建Java應用程序的流行框架,在本文中,我們探討了在SpringBoot中向日志添加唯一ID的重要性,需要的朋友可以參考下

前言

在 Web 應用程序領域，有效的請求監(jiān)控和可追溯性對于維護系統(tǒng)完整性和診斷問題至關重要。Spring Boot 是一種用于構建 Java 應用程序的流行框架，它提供了強大的日志記錄功能，可以通過為每個傳入請求合并唯一標識符來進一步豐富這些功能。這種簡潔而強大的實踐使開發(fā)人員能夠跟蹤和分析單個請求流，從而簡化調試并增強整體系統(tǒng)的可靠性。在本文中，我們探討了在 Spring Boot 中向日志添加唯一 ID 的重要性，深入了解其實現(xiàn)以及它為應用程序開發(fā)和維護帶來的眾多好處。

問題

如今，我們通常為每項服務配備多個服務器?，F(xiàn)在有兩種檢查日志的方法，第一種是進入單個服務器實例并檢查日志。還有另一種方法可以從所有服務器收集日志，并且可以在一個地方查看它們。人們通常使用第二種方法來搜索和分析日志?，F(xiàn)在，單個服務的多個服務器有如此多的日志，跟蹤日志變得很困難。

此外，即使我們有一個服務的單個服務器，由于并發(fā)請求/線程，也會打印許多日志。面臨的一個主要問題是跟蹤，因為日志以交錯方式打印。跟蹤打印的日志變得非常困難。

解決方案

為了解決上述問題，我們需要某種與每個日志條目關聯(lián)的標識符。我們可以生成一個唯一的 ID，然后將該 ID 分配給特定請求的所有日志。因此，為特定請求生成的所有日志都將具有唯一的 ID。借助這個ID，我們可以輕松地通過日志進行追蹤。我們可以在日志中搜索這個ID并獲取特定請求的所有日志。為了在 Spring Boot 中實現(xiàn)這一點，我們可以使用 AOP。

面向方面編程（AOP）是一種編程范式，允許開發(fā)人員將橫切關注點（例如日志記錄、安全性和事務管理）模塊化，與核心業(yè)務邏輯分開，從而提高代碼的可重用性和可維護性。它通過引入“方面”來實現(xiàn)這一點，這些“方面”可以應用于代碼庫的不同部分，而無需更改原始代碼。

首先，您必須創(chuàng)建一個如下所示的請求過濾器。

/**
 * A filter that adds a key to the Mapped Diagnostic Context (MDC) to each request so you can print a unique id in the log messages of each request
 **/
@EqualsAndHashCode(callSuper = false)
@Component
@Slf4j
public class Slf4jMDCFilter extends OncePerRequestFilter {

    @Override
    protected void doFilterInternal(final HttpServletRequest request, final HttpServletResponse response, final FilterChain chain) {
        try {
            MDC.put(MDC_UUID_TOKEN_KEY, UUID.randomUUID().toString());
            chain.doFilter(request, response);
        } catch (Exception ex) {
            log.error(ERROR_FORMAT, "Exception occurred in filter while setting UUID for logs", ex);
        } finally {
            MDC.remove(MDC_UUID_TOKEN_KEY);
        }
    }

    @Override
    protected boolean isAsyncDispatch(final HttpServletRequest request) {
        return false;
    }

    @Override
    protected boolean shouldNotFilterErrorDispatch() {
        return false;
    }
}

上述代碼針對每個 API 請求運行一次，并將相同的唯一 ID 添加到為特定請求生成的所有日志中。接下來，您必須將上述 AOP 過濾器注冊為 bean，如下所示：

@Configuration
@RequiredArgsConstructor
public class BeanConfig {
    private final Slf4jMDCFilter slf4jMDCFilter;

    @Bean
    public FilterRegistrationBean<Slf4jMDCFilter> servletRegistrationBean() {
        final FilterRegistrationBean<Slf4jMDCFilter> filterRegistrationBean = new FilterRegistrationBean<>();
        filterRegistrationBean.setFilter(slf4jMDCFilter);
        filterRegistrationBean.setOrder(2);
        return filterRegistrationBean;
    }
}

之后，您需要在日志文件中添加一個附加程序，如下所示：

<appender name="Console"
  class="ch.qos.logback.core.ConsoleAppender">
  <layout class="ch.qos.logback.classic.PatternLayout">
    <Pattern>
      %black(%d{ISO8601}) %X{Slf4jMDCFilter.UUID} %highlight(%-5level) [%blue(%t)] %yellow(%C{1.}): %msg%n%throwable
    </Pattern>
  </layout>
</appender>