Springmvc拦截器

  在SpringMVC 中定义一个Interceptor有两种方式,第一种方式是要定义的Interceptor类要实现Spring 的HandlerInterceptor 接口,或者是这个类继承实现HandlerInterceptor 接口的类,比如Spring 已经提供的实现了HandlerInterceptor 接口的抽象类HandlerInterceptorAdapter ;第二种方式是实现Spring的WebRequestInterceptor接口,或者是继承实现了WebRequestInterceptor的类

       Springmvc的处理器拦截器类似于Servlet 开发中的过滤器Filter,用于对处理器进行预处理和后处理。

  在springmvc中,定义拦截器要实现HandlerInterceptor接口,并实现该接口中提供的三个方法,如下:

public class HandlerInterceptor1 implements HandlerInterceptor{

    @Override
    public boolean preHandle(HttpServletRequest request,
            HttpServletResponse response, Object handler) throws Exception {

        System.out.println("HandlerInterceptor1....preHandle");
//false表示拦截,不向下执行;true表示放行 return true; } @Override public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception { System.out.println("HandlerInterceptor1....postHandle"); } @Override public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception { System.out.println("HandlerInterceptor1....afterCompletion"); } }
preHandle方法:进入Handler方法之前执行,可以用于身份认证、身份授权。比如如果认证没有通过表示用户没有登陆,需要此方法拦截不再往下执行(return false),否则就放行
(return true)
postHandle方法:进入Handler方法之后,返回ModelAndView之前执行。可以看到该方法中有个modelAndView的形参。
    应用场景:从modelAndView出发,将公用的模型数据
(比如菜单导航之类的)在这里传到视图,也可以在这里统一指定视图
afterCompletion方法:执行Handler完成之后执行,应用场景:统一异常处理,统一日志处理等。

springmvc拦截器的配置

  在springmvc中,拦截器是针对具体的HandlerMapping进行配置的,也就是说如果在某个HandlerMapping中配置拦截,经过该 HandlerMapping映射成功的handler最终使用该拦截器。比如,在配置文件中配置的映射器是org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping,可以这样来配置拦截器:

<bean class="org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping">
    <property name="interceptors">
        <list>
            <ref bean="handlerInterceptor1"/>
            <ref bean="handlerInterceptor2"/>
        </list>
    </property>
</bean>
<bean id="handlerInterceptor1" class="ssm.intercapter.HandlerInterceptor1"/>
<bean id="handlerInterceptor2" class="ssm.intercapter.HandlerInterceptor2"/>

       在mvc:interceptors标签下声明interceptor主要有两种方式:

                    (1)直接定义一个Interceptor实现类的bean对象。使用这种方式声明的Interceptor拦截器将会对所有的请求进行拦截

                    (2)使用mvc:interceptor标签进行声明。使用这种方式进行声明的Interceptor可以通过mvc:mapping子标签来定义需要进行拦截的请求路径。

  springmvc框架将配置的类似全局的拦截器注入到每个HandlerMapping中,这样就可以成为全局的拦截器了。配置如下:

<!-- 配置拦截器 -->
<mvc:interceptors>
    <!-- 多个拦截器,按顺序执行 -->        
    <mvc:interceptor>
        <mvc:mapping path="/**"/> <!-- 表示拦截所有的url包括子url路径 -->
        <bean class="ssm.interceptor.HandlerInterceptor1"/>
    </mvc:interceptor>
    <mvc:interceptor>
        <mvc:mapping path="/**"/>
        <bean class="ssm.interceptor.HandlerInterceptor2"/>
    </mvc:interceptor>
    <mvc:interceptor>
        <mvc:mapping path="/**"/>
        <bean class="ssm.interceptor.HandlerInterceptor3"/>
    </mvc:interceptor>
</mvc:interceptors>

   三个拦截器的preHandle方法中返回值都改成true,来测试一下拦截器的执行顺序,测试结果如下:

HandlerInterceptor1….preHandle 
HandlerInterceptor2….preHandle 
HandlerInterceptor3….preHandle

HandlerInterceptor3….postHandle 
HandlerInterceptor2….postHandle 
HandlerInterceptor1….postHandle

HandlerInterceptor3….afterCompletion 
HandlerInterceptor2….afterCompletion 
HandlerInterceptor1….afterCompletion

  当所有拦截器都放行的时候,preHandle方法是按照配置的顺序执的;而另外两个方法按照配置的顺序逆向执行的。

  第三个拦截器的preHandle方法中返回值改成false,前两个还是true,来测试一下拦截器的执行顺序,测试结果如下:

HandlerInterceptor1….preHandle 
HandlerInterceptor2….preHandle 
HandlerInterceptor3….preHandle

HandlerInterceptor2….afterCompletion 
HandlerInterceptor1….afterCompletion

打印的结果做一个总结: 

  1. 由于拦截器1和2放行,所以拦截器3的preHandle才能执行。也就是说前面的拦截器放行,后面的拦截器才能执行preHandle。
  2. 拦截器3不放行,所以其另外两个方法没有被执行。即如果某个拦截器不放行,那么它的另外两个方法就不会被执行。
  3. 只要有一个拦截器不放行,所有拦截器的postHandle方法都不会执行,但是只要执行过preHandle并且放行的,就会执行afterCompletion方法。

三个拦截器都不放行

  HandlerInterceptor1….preHandle

  只执行了第一个拦截器的preHandle方法,因为都不放行,所以没有一个执行postHandle方法和afterCompletion方法

应用

  现在要写一个统一异常处理的逻辑,那么要将该拦截器放在拦截器链的第一个位置,且一定要放行,因为只有放行了,才会去执行afterCompletion,而且放在拦截器链的第一个的话,afterCompletion方法会最后执行,才能在里面执行统一异常处理的逻辑。 

  再比如,登陆认证拦截器,放在拦截器链接中第一个位置(如果有统一异常处理,那么应该放在统一异常处理的后面)。权限校验拦截器,放在登陆认证拦截器之后(因为登陆通过后才校验权限)

实现WebRequestInterceptor 接口

    WebRequestInterceptor 中也定义三个方法,也是通过这三个方法来实现拦截的。这三个方法都传递同一个参数WebRequest ,那么WebRequest 是什么呢?这个WebRequest 是Spring 定义的一个接口,里面的方法定义都基本跟HttpServletRequest 一样,在WebRequestInterceptor 中对WebRequest 进行的所有操作都将同步到HttpServletRequest 中,然后在当前请求中一直传递

  (1 )preHandle(WebRequest request) 方法。该方法将在请求处理之前进行调用,也就是说会在Controller 方法调用之前被调用。这个方法跟HandlerInterceptor 中的preHandle 是不同的,主要区别在于该方法的返回值是void ,也就是没有返回值,一般主要进行资源的准备工作,比如在使用Hibernate 的时候 ,在这个方法中准备一个Hibernate 的Session 对象,然后利用WebRequest的setAttribute(name, value, scope) 把它放到WebRequest 的属性中。这个setAttribute方法的第三个参数scope ,该参数是一个Integer 类型的。在WebRequest 的父层接口RequestAttributes中对它定义三个常量:

     SCOPE_REQUEST :值是0 ,代表只有在request 中可以访问。

     SCOPE_SESSION :值是1 ,如果环境允许的话它代表的是一个局部的隔离的session,否则就代表普通的session,并且在该session范围内可以访问。

     SCOPE_GLOBAL_SESSION :值是2 ,如果环境允许的话,代表的是一个全局共享的session,否则就代表普通的session,并且在该session 范围内可以访问。

   (2 )postHandle(WebRequest request, ModelMap model) 方法。该方法将在请求处理之后,在Controller 方法调用之后被调用,但是会在视图返回被渲染之前被调用,所以可以在这个方法里面通过改变数据模型ModelMap 来改变数据的展示。该方法有两个参数,WebRequest 对象是用于传递整个请求数据的,比如在preHandle 中准备的数据都可以通过WebRequest 来传递和访问;ModelMap 就是Controller 处理之后返回的Model 对象,可以通过改变它的属性来改变返回的Model 模型。

   (3 )afterCompletion(WebRequest request, Exception ex) 方法。该方法会在整个请求处理完成,也就是在视图返回并被渲染之后执行。所以在该方法中可以进行资源的释放操作。而WebRequest 参数就可以把在preHandle 中准备的资源传递到这里进行释放。Exception 参数表示的是当前请求的异常对象,如果在Controller 中抛出的异常已经被Spring 的异常处理器给处理了的话,那么这个异常对象就是是null 。

     

 

参考:

https://blog.csdn.net/eson_15/article/details/51749880

https://elim.iteye.com/blog/1750680

posted on 2018-11-08 10:56  溪水静幽  阅读(188)  评论(0)    收藏  举报