Spring MVC 拦截器

Spring MVC 拦截器

---

---

一. 拦截器基本概念

Spring MVC中的拦截器（Interceptor）类似于Servlet中的过滤器（Filter），它主要用于拦截用户请求并作相应的处理。例如通过拦截器可以进行权限验证、记录请求信息的日志、判断用户是否登录等。

要使用Spring MVC中的拦截器，就需要对拦截器类进行定义和配置。通常拦截器类可以通过两种方式来定义。

1.通过实现HandlerInterceptor接口
2.继承HandlerInterceptor接口的实现类（如：HandlerInterceptorAdapter）来定义。

二. SpringMVC 过滤器、监听器、拦截器的对比

• Servlet:处理Reequest请求和Response响应

• 过滤器(Filter):对Request请求起到过滤作用，作用在Servlet之前，如果配置为/*可以为所有的资源(servlet、js/css静态资源等)进行过滤处理

• 监听器(Listener):实现了javax.servlet.ServletContextListener接口的服务器端组件，它随Web应用的启动而启动，只初始化一次，然后一直监视，随Web应用的停止而销毁

  • 作用一：做初始化工作，web应用中spring容器启动ContextLoaderListener
  • 作用二：监听web中的特定事件，比如HttpSession,ServletRequest的创建和销毁；变量的创建、销毁和修改等可以在某些动作
    前后增加处理，实现监控，比如说统计在线人数，利用HttpSessionListener等

• 拦截器(Interceptor):是Spring
  MVC、Struts等表现层框架自己的，不会拦截jsp/html/css/image等的访问，只会拦截访问的控制器方法(Handler)

• servlet、filter、listener是配置在web.xml中，interceptor是配置在表现层框架自己的配置文件中

• 在Handler业务逻辑执行之前拦截一次 在Handler逻辑执行完但是还没有跳转页面之前拦截一次

• 在跳转页面后拦截一次

三. 拦截器实现

public class MyInterceptor implements HandlerInterceptor {
    /**
     * 在目标Handler(方法)执行前执行
     * 返回true:执行Handler方法
     * 返回false:阻止目标Handler方法执行
     * @param request
     * @param response
     * @param handler
     * @return
     * @throws Exception
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("目标Handler执行前执行MyInterceptor---->preHandle方法...");
        return true;
    }

    /**
     * 在目标Handler(方法)执行后，视图生成前执行
     * @param request
     * @param response
     * @param handler
     * @param modelAndView
     * @throws Exception
     */
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("目标Handler执行后，视图执行前执行MyInterceptor---->postHandle方法...");
    }

    /**
     * 在目标方法执行后，视图生成后执行
     * @param request
     * @param response
     * @param handler
     * @param ex
     * @throws Exception
     */
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("目标Handler执行后，视图执行后执行MyInterceptor---->afterCompletion方法...");
    }
}

  <!-- 拦截器配置 -->
    <mvc:interceptors>
        <!--定义在mvc:interceptor下面,可以自定义需要拦截的请求
            如果有多个拦截器满足拦截处理的要求，则依据配置的先后顺序来执行
            -->
        <mvc:interceptor>
            <!--通过mvc:mapping配置需要拦截的资源。支持通配符，可以配置多个 -->
            <mvc:mapping path="/**"/> <!-- /**表示拦截所有的请求-->
            <!--通过mvc:exclude-mapping配置不需要拦截的资源。支持通配符，可以配置多个 -->
            <mvc:exclude-mapping path="/hello/*"/> <!-- /hello/*表示放行hello路径下的请求 -->
            <bean class="com.zyh.interceptor.MyInterceptor"></bean>
        </mvc:interceptor>
    </mvc:interceptors>

四. 多个拦截器的实现

Spring MVC框架支持多个拦截器的配置，从而构成拦截器链，对客户端进行多次拦截操作

过滤器配置

 <mvc:interceptors>
        <mvc:interceptor>
            <mvc:mapping path="/**"/>
            <bean class="com.zyh.interceptor.MyInterceptor"></bean>
        </mvc:interceptor>
        <mvc:interceptor>
            <mvc:mapping path="/**"/>
            <bean class="com.zyh.interceptor.MyInterceptor2"></bean>
        </mvc:interceptor>
    </mvc:interceptors>

public class MyInterceptor2 implements HandlerInterceptor {
    /**
     * 在目标Handler(方法)执行前执行
     * 返回true:执行Handler方法
     * 返回false:阻止目标Handler方法执行
     * @param request
     * @param response
     * @param handler
     * @return
     * @throws Exception
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("2.目标Handler执行前执行MyInterceptor2---->preHandle方法...");
        return true;
    }

    /**
     * 在目标Handler(方法)执行后，视图生成前执行
     * @param request
     * @param response
     * @param handler
     * @param modelAndView
     * @throws Exception
     */
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("3.目标Handler执行后，视图执行前执行MyInterceptor2---->postHandle方法...");
    }

    /**
     * 在目标方法执行后，视图生成后执行
     * @param request
     * @param response
     * @param handler
     * @param ex
     * @throws Exception
     */
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("5.目标Handler执行后，视图执行后执行MyInterceptor2---->afterCompletion方法...");
    }
}

Handler

@RequestMapping("/hello")
@Controller
public class HelloController 
    @RequestMapping("/packageType")
    @ResponseBody
    public String packageType(@RequestParam(value = "id", required = true) Integer id) {
        System.out.println("拦截的方法...");
        return "id=" + id;
    }
}