使用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库帮助我们高效的开发日志接口，进一步增强了我们在开发及维护过程中的效率和代码质量。