log4j的MDC配合Spring-mvc进行日志追踪

跳槽后，接到的第一个需求是在项目里给每个请求加一个唯一字符串，能够通过日志追踪到请求的整个流程。一个很简单的需求，上网查找资料考虑半天后，决定用log4j的MDC进行请求追踪。（logback和slf4j也是支持MDC）
因为我们项目是Spring-mvc和mybatis搭建的，页面请求都是直接转发到我们的controller层，所以考虑使用Spring的拦截器(interceptor)。inteceptor拦截所有请求，在preHandle中给请求赋唯一序列值，在afterCompletion中remove MDC的序列值。然后再log4j的配置文件中使用%X{logkey}输出请求的序列值。
另外唯一序列值我们采用的是随机数Math.abs(random.nextLong())，当然也可以采用UUID或者其他的都是OK的。
说了这么多，接下来就直接上代码吧。

第一步：新建一个日志工具类

import org.apache.log4j.MDC;
import java.util.Random;

/**

• @description 日志工具类
  *@author jerry
  @date 2018-08
  /
  public class LoggerTools {
  /
  *@description 日志序列号
  *@author jerry
  @date 2018-08-03
  /
  public static void logger(){
  Random random=new Random();
  MDC.put(“logkey”,Math.abs(random.nextLong()));
  }
  /
  • @description 删除本次请求的日志序列号
  • @author jerry
  • @date 2018-08
    */
    public static void remove(String key){
    MDC.remove(key);
    }
    }

第二步新建拦截器

import org.apache.log4j.Logger;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**

• @param

• @author jerry

• @description 日志拦截器

• @date 2018-08
  **/
  public class LoggerInterceptor implements HandlerInterceptor {
  private static Logger logger=Logger.getLogger(LoggerInterceptor.class);

  @Override
  public boolean preHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o) throws Exception {
  LoggerTools.logger();
  logger.info(“preHandle start”);
  return true;
  }

  @Override
  public void postHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, ModelAndView modelAndView) throws Exception {

  }

  @Override
  public void afterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) throws Exception {
  logger.info(“afterCompletion end”);
  LoggerTools.remove(“logkey”);
  }
  }

第三步在spring-mvc.xml中配置拦截器

如果已有其他拦截器，可以在其下面增加就可以了
第四步
在log4j的properties文件中配置日志输出格式
log4j.appender.Console.layout = org.apache.log4j.PatternLayout
log4j.appender.Console.layout.ConversionPattern=[%p] [%X{logkey}] [%d{yyyy-MM-dd HH:mm:ss,SSS}] [%t] [%c]%m%n

这样就可以了。

注意事项：

1、此处使用的是拦截器，也可以使用过滤器。另外拦截器是默认是按配置顺序执行的，只能拦截controller的请求。

2、我们使用的是log4j-1.2.11
3、如果是其他接口的请求，目前这种方式还不支持，大家有知道的可以指点一下哈