请求日志拦截器

1.背景

spring记录日志有两种，一种是通过AOP，另一种是通过拦截器interceptor；SpringMVC 中的Interceptor 拦截请求是通过HandlerInterceptor 来实现的。在SpringMVC 中定义一个Interceptor 非常简单，主要有两种方式:

• 第一种方式是要定义的Interceptor类要实现了Spring 的HandlerInterceptor 接口，或者是这个类继承实现了HandlerInterceptor 接口的类，比如Spring 已经提供的实现了HandlerInterceptor 接口的抽象类HandlerInterceptorAdapter ；
• 第二种方式是实现Spring的WebRequestInterceptor接口，或者是继承实现了WebRequestInterceptor的类。
  本文将重点介绍通过实现HandlerInterceptor接口实现拦截器类

2.理论实现

为了更好的定位用户发送的请求，我们单独定义一个日志类型，用户记录系统所有的请求日志；
（1 ）preHandle (HttpServletRequest request, HttpServletResponse response, Object handle) 方法，顾名思义，该方法将在请求处理之前进行调用。SpringMVC 中的Interceptor 是链式的调用的，在一个应用中或者说是在一个请求中可以同时存在多个Interceptor 。每个Interceptor 的调用会依据它的声明顺序依次执行，而且最先执行的都是Interceptor 中的preHandle 方法，所以可以在这个方法中进行一些前置初始化操作或者是对当前请求的一个预处理，也可以在这个方法中进行一些判断来决定请求是否要继续进行下去。该方法的返回值是布尔值Boolean 类型的，当它返回为false 时，表示请求结束，后续的Interceptor 和Controller 都不会再执行；当返回值为true 时就会继续调用下一个Interceptor 的preHandle 方法，如果已经是最后一个Interceptor 的时候就会是调用当前请求的Controller 方法。

（2 ）postHandle (HttpServletRequest request, HttpServletResponse response, Object handle, ModelAndView modelAndView) 方法，由preHandle 方法的解释我们知道这个方法包括后面要说到的afterCompletion 方法都只能是在当前所属的Interceptor 的preHandle 方法的返回值为true 时才能被调用。postHandle 方法，顾名思义就是在当前请求进行处理之后，也就是Controller 方法调用之后执行，但是它会在DispatcherServlet 进行视图返回渲染之前被调用，所以我们可以在这个方法中对Controller 处理之后的ModelAndView 对象进行操作。postHandle 方法被调用的方向跟preHandle 是相反的，也就是说先声明的Interceptor 的postHandle 方法反而会后执行。

（3 ）afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handle, Exception ex) 方法，该方法也是需要当前对应的Interceptor 的preHandle 方法的返回值为true 时才会执行。顾名思义，该方法将在整个请求结束之后，也就是在DispatcherServlet 渲染了对应的视图之后执行。这个方法的主要作用是用于进行资源清理工作的。

3.代码实现

1.定义记录请求日志的文件类型
private final static Logger log = LoggerFactory.getLogger("ED-TRACE");

2.preHandle- - -生成请求唯一标识reqId（用于日志全链路追踪），记录请求开始时间（用于计算请求结束时请求的耗时计算），将reqId注入到所有日志中（用于日志全链路追踪）。

@Override
  public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
      throws Exception {
    String reqId = request.getParameter(LogConstant.REQ_ID);
    if (StringUtils.isBlank(reqId)) {
      reqId = UUID.randomUUID().toString().replace("-", "");
    }
    request.setAttribute(LogConstant.REQ_ID, reqId);
    request.setAttribute(LogConstant.REQ_START_TIME, System.currentTimeMillis());
    MDC.put(LogConstant.REQ_ID, reqId);
    return true;
  }

3.afterCompletion—记录请求结束时间、耗时，获取请求url，获取请求参数，请求用户相关信息，生成该条请求日志。

@Override
  public void afterCompletion(HttpServletRequest request, HttpServletResponse response,
      Object handler, Exception ex) throws Exception {

    try {
      long startTime = (long) request.getAttribute(LogConstant.REQ_START_TIME);
      long endTime = System.currentTimeMillis();
      long cost = endTime - startTime;
      String reqId = MDC.get(LogConstant.REQ_ID);
      MDC.remove(LogConstant.REQ_ID);
      UserDto user = EdContext.get(ContextConstant.USER);
      String ip = HttpUtil.getClientIP(request);
      Map<String, Object> map = Maps.newHashMap();
      map.put("currentTime", endTime);
      map.put("ip", ip);
      map.put("reqId", reqId);
      map.put("requestUri", URLDecoder.decode(request.getRequestURI(), "UTF-8"));
      map.put("queryString", URLDecoder.decode(request.getQueryString(), "UTF-8"));
      map.put("cost", cost);
      if (null != user) {
        map.put("email", user.getEmail());
      }

      log.info(JSONUtil.toJson(map));
    } catch (Exception ignored) { }
  }