使用mdcjava創建高質量Java項目

一、快速了解mdcjava

mdcjava 是一個基於spring boot的快速開發代碼庫。在構建高質量Java Web應用和RESTful Web服務時，在Spring上下文環境中輕鬆實現良好的應用日誌記錄，提供簡單而強大的MDC功能。

在開發web應用程序時，我們通常需要為用戶打印一些錯誤日誌。但是在生產環境中，多個線程並發運行的情況下，錯誤可能是異步的，並且需要日誌中記錄相關的Userid或Sessionid等等內容。

對於日誌記錄來說，這非常重要，因為我們需要了解在特定的時間點，哪些用戶遇到了哪些問題。這個問題可以通過MDC（Mapped Diagnostic Contexts） 來解決。

二、MDC的使用

mdcjava 提供了一種簡單而有效的方式將相關信息在同一線程中傳遞，保證在日誌中記錄MDC的值。首先，我們需要在應用程序中定義一個MDC的key。MDC中的每個鍵都被映射為特定的值。

接下來，使用下列語句，可以在MDC中存儲一個具有特定值的鍵：

org.slf4j.MDC.put("mykey", "myvalue");

如果您想確保刪除鍵，則可以使用MDC。remove函數，它將鍵從MDC中刪除：

org.slf4j.MDC.remove("mykey");

三、在 Spring Boot 中集成 MDCJava

集成MDCjava 的過程非常簡單，只需要在 pom.xml 中添加依賴項。

<dependency>
    <groupId>com.github.dtroupe18</groupId>
    <artifactId>mdcjava-starter</artifactId>
    <version>1.0.0</version>
</dependency>

四、使用 MDCjava 在 web 應用程序中記錄日誌

下面的示例介紹了在Web應用程序中使用MDC記錄日誌的方法。

在應用程序中定義MDC的key ：

public enum MDCKey{
    USER_ID
}

在Spring Boot應用程序中添加配置類:

@Configuration
public class MDCConfig {

    @Bean
    public MdcInjectionFilter logbackMdcInsertingServletFilter() {
        MdcInjectionFilter filter = new MdcInjectionFilter();
        filter.setMdcKeyPattern(MDCKey.USER_ID.name());
        return filter;
    }

    @Bean
    public FilterRegistrationBean servletRegistrationBean() {
        FilterRegistrationBean registrationBean = new FilterRegistrationBean();
        //構造 filter
        registrationBean.setFilter(logbackMdcInsertingServletFilter());
        //添加過濾規則
        registrationBean.addUrlPatterns("/*");
        registrationBean.setName("logbackMDCFilter");
        return registrationBean;
    }
}

在代碼中記錄日誌，這將自動在日誌中記錄MDC值：

Logger logger = LoggerFactory.getLogger(MyClass.class);
MDC.put(MDCKey.USER_ID.name(), "12345");
logger.info("some info message");
MDC.remove(MDCKey.USER_ID.name());

五、使用 MDCJava 和Spring AOP實現統一攔截處理

在應用程序的各個方面使用AOP和MDC的一個好處是能夠快速且高效地記錄應用程序性能日誌，甚至可以在運行時確定應用程序的瓶頸。

在這裡，我們使用了 @around注釋來自定義一個運行器，每當方法被調用時，會首先記錄MDC中的相關信息，然後執行目標方法，最後清除日誌記錄器上的MDC。

@Aspect
@Component
public class LoggingAspect {

  @Around("execution(* com.example..*Controller.*(..))")
  public Object logAroundControllerMethods(ProceedingJoinPoint joinPoint) throws Throwable {
      String methodName = joinPoint.getSignature().getName();
      String className = joinPoint.getTarget().getClass().getName();
      MDC.put("method", methodName);
      MDC.put("class", className);
      try {
          return joinPoint.proceed();
      } finally {
          MDC.remove("method");
          MDC.remove("class");
      }
  }
}

六、結語

通過使用mdcjava，我們能夠輕鬆記錄完整的應用日誌，並提供簡單而強大的MDC功能。Spring 的AOP機制和MDCJava庫幫助我們高效的開發日誌接口，進一步增強了我們在開發及維護過程中的效率和代碼質量。