SpringMVC中的拦截器

拦截器的作用

SpringMVC的处理器拦截器（Interceptor）类似于Servlet开发中的过滤器Filter，用于对处理器进行预处理和后处理，用户可以自己定义一些拦截器来实现特定的功能。

而拦截器链就是将拦截器按一定的顺序联结成一条链【servlet中有过滤器链】。

拦截器和过滤器的区别：

　　过滤器是servlet规范中的一部分（sun公司定义的），任何java web工程都可以使用。

　　拦截器是SpringMVC框架自己的，只有使用了SpringMVC框架的工程才能用。

　　过滤器在url-pattern中配置了/*之后，可以对所有要访问的资源拦截。

　　拦截器它是只会拦截访问的控制器方法，如果访问的是jsp，html,css,image 或者js是不会进行拦截的。

应用场景：日志处理、登录权限验证

自定义拦截器

要想自定义拦截器，必须实现HandlerInterceptor接口

package com.qzcsbj.interceptor;

import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;


public class HandlerInterceptorDemo1 implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("执行preHandle方法了。。。");
        return true; // true表示放行，继续后续的操作
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("执行postHandle方法了。。。");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("执行afterCompletion方法了。。。");
    }
}

控制器

package com.qzcsbj.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

@Controller
public class TestController {

    @RequestMapping("/testInterceptor")
    public String testInterceptor(){
        System.out.println("控制器中的方法执行了。。。");
        return "success";
    }
}

springmvc.xml中配置拦截器

    <!-- 配置拦截器 -->
    <mvc:interceptors>
        <mvc:interceptor>
            <!--拦截的资源URI-->
            <mvc:mapping path="/**"/>
            <bean id="handlerInterceptorDemo1"
                  class="com.qzcsbj.interceptor.HandlerInterceptorDemo1">
            </bean>
        </mvc:interceptor>
    </mvc:interceptors>

测试

请求：http://localhost:8080/testInterceptor

日志

拦截器详解

拦截器中方法

HandlerInterceptor有3个方法

preHandle是前置操作，Handle执行前执行，返回布尔值，表示是否通过拦截器。如果该拦截器对请求进行拦截处理后还要调用其他的拦截器，或者是业务处理器去进行处理，则返回true；如果不需要再调用其他的组件去处理请求，则返回false；

postHandle是后置操作，Handle执行后执行，也就是DispatcherServlet向客户端返回响应前被调用；

afterCompletion是最终操作，在DispatcherServlet完全处理完请求后被调用，可以在该方法中进行一些资源清理的操作；

拦截器的作用路径

可以通过在配置文件中配置

    <!-- 配置拦截器 -->
    <mvc:interceptors>
        <mvc:interceptor>
            <!--拦截的资源URI-->
            <mvc:mapping path="/**"/>
            <!--不拦截哪些-->
            <!--<mvc:exclude-mapping path="" />-->
            <bean id="handlerInterceptorDemo1"
                  class="com.qzcsbj.interceptor.HandlerInterceptorDemo1">
            </bean>
        </mvc:interceptor>
    </mvc:interceptors>

多个拦截器的执行顺序

定义两个拦截器

拦截器1

package com.qzcsbj.interceptor;

import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

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


public class HandlerInterceptorDemo1 implements HandlerInterceptor {


    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("拦截器1：执行preHandle方法了。。。");
        return true; // true表示放行，继续后续的操作
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("拦截器1：执行postHandle方法了。。。");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("拦截器1：执行afterCompletion方法了。。。");
    }
}

拦截器2

package com.qzcsbj.interceptor;

import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

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


public class HandlerInterceptorDemo2 implements HandlerInterceptor {


    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("拦截器2：执行preHandle方法了。。。");
        return true; // true表示放行，继续后续的操作
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("拦截器2：执行postHandle方法了。。。");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("拦截器2：执行afterCompletion方法了。。。");
    }
}

springmvc.xml中配置拦截器

下面拦截器1在拦截器2前面

    <!-- 配置拦截器 -->
    <mvc:interceptors>
        <mvc:interceptor>
            <!--拦截的资源URI-->
            <mvc:mapping path="/**"/>
            <!--不拦截哪些-->
            <!--<mvc:exclude-mapping path="" />-->
            <bean id="handlerInterceptorDemo1"
                  class="com.qzcsbj.interceptor.HandlerInterceptorDemo1">
            </bean>
        </mvc:interceptor>

        <mvc:interceptor>
            <mvc:mapping path="/**"/>
            <bean id="handlerInterceptorDemo2"
                  class="com.qzcsbj.interceptor.HandlerInterceptorDemo2">
            </bean>
        </mvc:interceptor>
    </mvc:interceptors>

结果

请求：http://localhost:8080/testInterceptor

下面拦截器1在拦截器2后面

    <!-- 配置拦截器 -->
    <mvc:interceptors>
        <mvc:interceptor>
            <mvc:mapping path="/**"/>
            <bean id="handlerInterceptorDemo2"
                  class="com.qzcsbj.interceptor.HandlerInterceptorDemo2">
            </bean>
        </mvc:interceptor>
        
        <mvc:interceptor>
            <!--拦截的资源URI-->
            <mvc:mapping path="/**"/>
            <!--不拦截哪些-->
            <!--<mvc:exclude-mapping path="" />-->
            <bean id="handlerInterceptorDemo1"
                  class="com.qzcsbj.interceptor.HandlerInterceptorDemo1">
            </bean>
        </mvc:interceptor>
    </mvc:interceptors>

重启tomcat

请求：http://localhost:8080/testInterceptor