Spring 拦截器_aftercompletion怎么监控到异常-CSDN博客

本文链接：https://blog.csdn.net/u012743772/article/details/50132615

spring 拦截器

SpringMVC 中的Interceptor 拦截器也是相当重要和相当有用的，它的主要作用是拦截用户的请求并进行相应的处理。
比如通过它来进行权限验证，判断用户是否登陆，或像12306判断当前时间是否是购票时间。

SpringMVC 中的Interceptor 拦截请求是通过HandlerInterceptor 来实现的。
定义一个Interceptor主要有两种方式，
第一种方式是要定义的Interceptor类要实现了Spring的HandlerInterceptor接口，或者是这个类继承实现了HandlerInterceptor 接口的类HandlerInterceptorAdapter ；
第二种方式是实现Spring的WebRequestInterceptor接口，或者是继承实现了WebRequestInterceptor的类。

拦截器的接口：

package org.springframework.web.servlet;  
public interface HandlerInterceptor {  
    boolean preHandle(  
            HttpServletRequest request, HttpServletResponse response,   
            Object handler)   
            throws Exception;  

    void postHandle(  
            HttpServletRequest request, HttpServletResponse response,   
            Object handler, ModelAndView modelAndView)   
            throws Exception;  

    void afterCompletion(  
            HttpServletRequest request, HttpServletResponse response,   
            Object handler, Exception ex)  
            throws Exception;  
}

有三个方法，preHandle,postHandle,afterCompletion。
preHandle是在处理器之前就要执行的。一般是检查是否登录。
spring有一个实现HandlerInterceptor的类HandlerInterceptorAdapter：

 public abstract class HandlerInterceptorAdapter implements HandlerInterceptor {  
        /** 
         * This implementation always returns <code>true</code>. 
         */  
        public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)  
            throws Exception {  
            return true;  
        }  

        /** 
         * This implementation is empty. 
         */  
        public void postHandle(  
                HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView)  
                throws Exception {  
        }  

        /** 
         * This implementation is empty. 
         */  
        public void afterCompletion(  
                HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)  
                throws Exception {  
        }       
    }

1、preHandle：预处理回调方法，实现处理器的预处理（如登录检查），第三个参数为响应的处理器；
返回值：true表示继续流程（如调用下一个拦截器或处理器）；false表示流程中断（如登录检查失败），不会继续调用其他的拦截器或处理器，此时我们需要通过response来产生响应；
2、postHandle：后处理回调方法，实现处理器的后处理（但在渲染视图之前），此时我们可以通过modelAndView（模型和视图对象）对模型数据进行处理或对视图进行处理，modelAndView也可能为null。
3、afterCompletion：整个请求处理完毕回调方法，即在视图渲染完毕时回调，如性能监控中我们可以在此记录结束时间并输出消耗时间，
还可以进行一些资源清理，类似于try-catch-finally中的finally，但仅调用处理器执行链中preHandle返回true的拦截器的afterCompletion。

public class HandlerInterceptor1 extends HandlerInterceptorAdapter {
    //此处一般继承HandlerInterceptorAdapter适配器即可  
    /** 
     * 在preHandle中，可以进行编码、安全控制等处理；  
     * 在postHandle中，有机会修改ModelAndView；  
     * 在afterCompletion中，可以根据ex是否为null判断是否发生了异常，进行日志记录。 
    */  

    @Override  
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {  
        System.out.println("===========HandlerInterceptor1 preHandle");  
        return true;  
    }  
    @Override  
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {  
        /** 
         * 修改了modelview，跳转到login这个页面中去了 
         */  
        modelAndView.setViewName("/login");  
        System.out.println("===========HandlerInterceptor1 postHandle");  
    }  
    @Override  
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {  

        System.out.println("===========HandlerInterceptor1 afterCompletion");  
    }  
}

配置文件：

<!--  
    <mvc:interceptors>:  
    这个标签用于注册一个自定义拦截器或者是WebRequestInterceptors  

    mvc:mapping:  
    可以通过定义URL来进行路径请求拦截，可以做到较为细粒度的拦截控制。拦截特有的URL请求  

    如果没有：<mvc:mapping path="/interceptorTest/**" />  
    则表示拦截所有URL请求  


-->  
<mvc:interceptors>  
     <mvc:interceptor>  
            <mvc:mapping path="/interceptorTest/**" />  
            <bean class="com.boventech.learning.intercepter.HandlerInterceptor1" />  
     </mvc:interceptor>  
   </mvc:interceptors>

1.DispatcherServlet
SpringMVC具有统一的入口DispatcherServlet，所有的请求都通过DispatcherServlet。
DispatcherServlet是前置控制器，配置在web.xml文件中的。拦截匹配的请求，Servlet拦截匹配规则要自已定义，把拦截下来的请求，依据某某规则分发到目标Controller来处理。所以我们现在web.xml中加
初始化 DispatcherServlet时，该框架在 web应用程序WEB-INF目录中寻找一个名为[servlet-名称]-servlet.xml的文件，
并在那里定义相关的Beans，重写在全局中定义的任何Beans

 <servlet>  
     <servlet-name>springMybatis</servlet-name>  
     <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>  
     <load-on-startup>1</load-on-startup>  
   </servlet>  
   <servlet-mapping>  
     <servlet-name>springMybatis</servlet-name>  
     <!-- 所有的的请求，都会被DispatcherServlet处理 -->  
     <url-pattern>/</url-pattern>  
   </servlet-mapping>

2.静态资源不拦截
如果只配置拦截类似于*.do格式的url，则对静态资源的访问是没有问题的，但是如果配置拦截了所有的请求（如我们上面配置的“/”），就会造成js文件、css文件、图片文件等静态资源无法访问。
一般实现拦截器主要是为了权限管理，主要是拦截一些url请求，所以不对静态资源进行拦截。要过滤掉静态资源一般有两种方式，
第一种是采用，（一般Web应用服务器默认的Servlet名称是”default”，所以这里我们激活Tomcat的defaultServlet来处理静态文件，在web.xml里配置如下代码即可：）

<!--　该servlet为tomcat,jetty等容器提供,将静态资源映射从/改为/static/目录，如原来访问　http://localhost/foo.css　,现在http://localhost/static/foo.css　-->  
<!-- 不拦截静态文件 -->  
<servlet-mapping>  
    <servlet-name>default</servlet-name>  
    <url-pattern>/js/*</url-pattern>  
    <url-pattern>/css/*</url-pattern>  
    <url-pattern>/images/*</url-pattern>  
    <url-pattern>/fonts/*</url-pattern>  
</servlet-mapping>

    Tomcat, Jetty, JBoss, and GlassFish  默认 Servlet的名字 -- "default"
    Resin 默认 Servlet的名字 -- "resin-file"
    WebLogic 默认 Servlet的名字  -- "FileServlet"
    WebSphere  默认 Servlet的名字 -- "SimpleFileServlet"

   如果你所有的Web应用服务器的默认Servlet名称不是"default"，则需要通过default-servlet-name属性显示指定：

<mvc:default-servlet-handler default-servlet-name="所使用的Web服务器默认使用的Servlet名称" />  

      第二种是采用<mvc:resources />，在springmvc的配置文件中加入以下代码：
[html] view plaincopyprint?
<mvc:resources mapping="/js/**" location="/static_resources/javascript/"/>    
<mvc:resources mapping="/styles/**" location="/static_resources/css/"/>    
<mvc:resources mapping="/images/**" location="/static_resources/images/"/>

3.自定义拦截器
SpringMVC的拦截器HandlerInterceptorAdapter对应提供了三个preHandle，postHandle，afterCompletion方法。preHandle在业务处理器处理请求之前被调用，
postHandle在业务处理器处理请求执行完成后,生成视图之前执行，afterCompletion在DispatcherServlet完全处理完请求后被调用,可用于清理资源等。所以要想实现自己的权限管理逻辑，需要继承HandlerInterceptorAdapter并重写其三个方法。
首先在springmvc.xml中加入自己定义的拦截器我的实现逻辑CommonInterceptor，

<!--配置拦截器, 多个拦截器,顺序执行 -->  
<mvc:interceptors>    
    <mvc:interceptor>    
        <!-- 匹配的是url路径， 如果不配置或/**,将拦截所有的Controller -->  
        <mvc:mapping path="/" />  
        <mvc:mapping path="/user/**" />  
        <mvc:mapping path="/test/**" />  
        <bean class="com.alibaba.interceptor.CommonInterceptor"></bean>    
    </mvc:interceptor>  
    <!-- 当设置多个拦截器时，先按顺序调用preHandle方法，然后逆序调用每个拦截器的postHandle和afterCompletion方法 -->  
</mvc:interceptors>

我的拦截逻辑是“在未登录前，任何访问url都跳转到login页面；登录成功后跳转至先前的url”，具体代码如下：

package com.alibaba.interceptor;  

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

import org.slf4j.Logger;  
import org.slf4j.LoggerFactory;  
import org.springframework.web.servlet.ModelAndView;  
import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;  

import com.alibaba.util.RequestUtil;  


/** 
 * @author tfj 
 * 2014-8-1 
 */  
public class CommonInterceptor extends HandlerInterceptorAdapter{  
    private final Logger log = LoggerFactory.getLogger(CommonInterceptor.class);  
    public static final String LAST_PAGE = "com.alibaba.lastPage";  
    /* 
     * 利用正则映射到需要拦截的路径     

    private String mappingURL; 

    public void setMappingURL(String mappingURL) {     
               this.mappingURL = mappingURL;     
    }    
  */  
    /**  
     * 在业务处理器处理请求之前被调用  
     * 如果返回false  
     *     从当前的拦截器往回执行所有拦截器的afterCompletion(),再退出拦截器链 
     * 如果返回true  
     *    执行下一个拦截器,直到所有的拦截器都执行完毕  
     *    再执行被拦截的Controller  
     *    然后进入拦截器链,  
     *    从最后一个拦截器往回执行所有的postHandle()  
     *    接着再从最后一个拦截器往回执行所有的afterCompletion()  
     */    
    @Override    
    public boolean preHandle(HttpServletRequest request,    
            HttpServletResponse response, Object handler) throws Exception {    
        if ("GET".equalsIgnoreCase(request.getMethod())) {  
            RequestUtil.saveRequest();  
        }  
        log.info("==============执行顺序: 1、preHandle================");    
        String requestUri = request.getRequestURI();  
        String contextPath = request.getContextPath();  
        String url = requestUri.substring(contextPath.length());  

        log.info("requestUri:"+requestUri);    
        log.info("contextPath:"+contextPath);    
        log.info("url:"+url);    

        String username =  (String)request.getSession().getAttribute("user");   
        if(username == null){  
            log.info("Interceptor：跳转到login页面！");  
            request.getRequestDispatcher("/WEB-INF/jsp/login.jsp").forward(request, response);  
            return false;  
        }else  
            return true;     
    }    

    /** 
     * 在业务处理器处理请求执行完成后,生成视图之前执行的动作    
     * 可在modelAndView中加入数据，比如当前时间 
     */  
    @Override    
    public void postHandle(HttpServletRequest request,    
            HttpServletResponse response, Object handler,    
            ModelAndView modelAndView) throws Exception {     
        log.info("==============执行顺序: 2、postHandle================");    
        if(modelAndView != null){  //加入当前时间    
            modelAndView.addObject("var", "测试postHandle");    
        }    
    }    

    /**  
     * 在DispatcherServlet完全处理完请求后被调用,可用于清理资源等   
     *   
     * 当有拦截器抛出异常时,会从当前拦截器往回执行所有的拦截器的afterCompletion()  
     */    
    @Override    
    public void afterCompletion(HttpServletRequest request,    
            HttpServletResponse response, Object handler, Exception ex)    
            throws Exception {    
        log.info("==============执行顺序: 3、afterCompletion================");    
    }    

}

注：上述代码里我写了一个RequestUtil,主要实现获取当前Request、Session对象，保存和加密页面，取出等功能。

至此，拦截器已经实现了，效果如图：
我直接访问/test/hello，会被拦截

登录成功后会跳转至/test/hello对应的页面