Spring MVC使用拦截器实现日志记录

「爱情、让人受尽委屈。」 2022-06-05 10:16 264阅读 0赞

spring记录日志有两种，一种是通过AOP，另一种是通过拦截器interceptor,这里选择的是拦截器interceptor：

**一、Interceptor实现类**

SpringMVC 中的Interceptor 拦截请求是通过HandlerInterceptor 来实现的。在SpringMVC 中定义一个Interceptor 非常简单，主要有两种方式:

第一种方式是要定义的Interceptor类要实现了Spring 的HandlerInterceptor 接口，或者是这个类继承实现了HandlerInterceptor 接口的类，比如Spring 已经提供的实现了HandlerInterceptor 接口的抽象类HandlerInterceptorAdapter ；

第二种方式是实现Spring的WebRequestInterceptor接口，或者是继承实现了WebRequestInterceptor的类。

这里采用第一种方式。

**二、实现HandlerInterceptor接口**

HandlerInterceptor 接口中定义了三个方法，我们就是通过这三个方法来对用户的请求进行拦截处理的。

（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 渲染了对应的视图之后执行。这个方法的主要作用是用于进行资源清理工作的。

示例如下:

/**
     * @version V1.0
     * @Author fendo
     * @ClassName LogInterceptor
     * @PackageName com.xx.xxx.xx.xx.Interceptor
     * @Description 日志拦截器
     * @Data 2017-11-24 10:47
     * 记录信息: 访问时间-Controller路径-对应方法名-请求参数信息-请求相对路径-请求处理时长
     **/
    public class LogInterceptor implements HandlerInterceptor {
    
    
        public static final Logger LOGGER = Logger.getLogger(LogInterceptor.class);
    
    
        private static final ThreadLocal<Long> startTimeThreadLocal =
                new NamedThreadLocal<Long>("ThreadLocal StartTime");
    
        private String getParamString(Map<String, String[]> map) {
            StringBuilder sb = new StringBuilder();
            for(Entry<String,String[]> e:map.entrySet()){
                sb.append(e.getKey()).append("=");
                String[] value = e.getValue();
                if(value != null && value.length == 1){
                    sb.append(value[0]).append("\t");
                }else{
                    sb.append(Arrays.toString(value)).append("\t");
                }
            }
            return sb.toString();
        }
    
        /**
         * 将ErrorStack转化为String.
         */
        public static String getStackTraceAsString(Throwable e) {
            if (e == null){
                return "";
            }
            StringWriter stringWriter = new StringWriter();
            e.printStackTrace(new PrintWriter(stringWriter));
            return stringWriter.toString();
        }
    
        /**
         * 该方法将在请求处理之前进行调用。
         * 多个Interceptor，然后SpringMVC会根据声明的前后顺序一个接一个的执行，而且所有的Interceptor中的preHandle方法都会在
         * Controller方法调用之前调用。SpringMVC的这种Interceptor链式结构也是可以进行中断的，这种中断方式是令preHandle的返
         * 回值为false，当preHandle的返回值为false的时候整个请求就结束了。
         * @param request
         * @param response
         * @param handler
         * @return
         * @throws Exception
         */
        @Override
        public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
            long startTime = System.currentTimeMillis();
            request.setAttribute("startTime", startTime);
            startTimeThreadLocal.set(startTime);		//线程绑定变量（该数据只有当前请求的线程可见）
            if (handler instanceof HandlerMethod) {
                StringBuilder sb = new StringBuilder(1000);
                sb.append("-----------------------开始计时:").append(new SimpleDateFormat("hh:mm:ss.SSS").format(startTime)).append("-------------------------------------\n");
                HandlerMethod h = (HandlerMethod) handler;
                sb.append("Controller: ").append(h.getBean().getClass().getName()).append("\n");
                sb.append("Method    : ").append(h.getMethod().getName()).append("\n");
                sb.append("Params    : ").append(getParamString(request.getParameterMap())).append("\n");
                sb.append("URI       : ").append(request.getRequestURI()).append("\n");
                LOGGER.debug(sb.toString());
            }
    
            return true;
        }
    
        /**
         * 在当前请求进行处理之后，也就是Controller 方法调用之后执行，但是它会在DispatcherServlet 进行视图返回渲染之前被调用，所以我们可以在这个方法中对Controller 处理之后的ModelAndView 对象进行操作。
         * @param request
         * @param response
         * @param handler
         * @param modelAndView
         * @throws Exception
         */
        @Override
        public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
            long startTime = (Long) request.getAttribute("startTime");
            long endTime = System.currentTimeMillis();
            long executeTime = endTime - startTime;
            if(handler instanceof HandlerMethod){
                StringBuilder sb = new StringBuilder(1000);
                sb.append("CostTime  : ").append(executeTime).append("ms").append("\n");
                sb.append("-------------------------------------------------------------------------------");
                LOGGER.debug(sb.toString());
            }
        }
    
    
        /**
         * 该方法将在整个请求结束之后，也就是在DispatcherServlet 渲染了对应的视图之后执行。这个方法的主要作用是用于进行资源清理工作的。
         * @param request
         * @param response
         * @param handler
         * @param ex
         * @throws Exception
         */
        @Override
        public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
            // 打印JVM信息。
            if (LOGGER.isDebugEnabled()){
                long beginTime = startTimeThreadLocal.get();//得到线程绑定的局部变量（开始时间）
                long endTime = System.currentTimeMillis(); 	//2、结束时间
    
                //如果controller报错，则记录异常错误
                if(ex != null){
                    LOGGER.debug("Controller异常: " + getStackTraceAsString(ex));
                }
    
                LOGGER.debug("计时结束："+ new SimpleDateFormat("hh:mm:ss.SSS").format(endTime) + " 耗时：" + DateUtils.formatDateTime(endTime - beginTime) + " URI:" +
                        request.getRequestURI()+ " 最大内存: " +Runtime.getRuntime().maxMemory()/1024/1024+ "m  已分配内存: " +Runtime.getRuntime().totalMemory()/1024/1024+ "m  已分配内存中的剩余空间: " +Runtime.getRuntime().freeMemory()/1024/1024+ "m  最大可用内存: " +
                        (Runtime.getRuntime().maxMemory()-Runtime.getRuntime().totalMemory()+Runtime.getRuntime().freeMemory())/1024/1024 + "m");
                startTimeThreadLocal.remove();
            }
        }
    }

**三、spring-mvc.xml文件中配置拦截器**

<mvc:interceptors>
            <mvc:interceptor>
                <mvc:mapping path="/**"/>
                
                <bean class="com.gz.xx.xx.xx.Interceptor.LogInterceptor"/>
            </mvc:interceptor>
        </mvc:interceptors>