SpringMVC拦截器Interceptor

SpringMVC拦截器Interceptor

springmvc中的拦截器interceptor类似于web开发中的filter，一般用于处理器的方法进行预处理和后处理

一、拦截器(interceptor)和过滤器(filter)的区别

过滤器(filter)

Filter属于Servlet技术，只要是web工程都可以使用
filter主要由于对所有请求过滤
Filter的执行时机早于Interceptor

拦截器(interceptor)

Interceptor属于SpringMVC技术，必须要有SpringMVC环境才可以使用
Interceptor通常由于对处理器Controller进行拦截
Interceptor只能拦截dispatcherServlet处理的请求

二、拦截器基本使用：

1.Controller环境准备

public class InterceptorController {
    @RequestMapping("/handleRun")
    public String handleRun() {
        System.out.println("业务处理器运行------------main");
        return "/page.jsp";
    }
}

2.自定义拦截器类

实现HandlerInterceptor接口，可根据选择重写preHandle,postHandle,afterCompletion方法

public class MyInterceptor1 implements HandlerInterceptor {
    // 预处理方法，在控制器的方法执行之前执行
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("preHandle1");
        //return false;// 返回true代表放行，返回false代表不放行
        return true;
    }

    // 后处理方法，在处理器执行之后，但是页面跳转之前执行
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("postHandle1");
    }

    // 视图跳转结束之后执行
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("afterCompletion1");
    }
}

3.在spring-mvc-xml中配置拦截器

<!--配置拦截器-->
<mvc:interceptors>
    <!--配置具体的拦截器-->
    <mvc:interceptor>
        <!--配置拦截的资源-->
        <mvc:mapping path="/**"/>
        <!--配置拦截器bean对象-->
        <bean class="com.itheima.interceptor.MyInterceptor1"/>
    </mvc:interceptor>
</mvc:interceptors>

三、拦截器方法详解

preHandle方法
作用：用于对拦截到的请求进行预处理，方法接收布尔(true,false)类型的返回值，返回true：放行，false：不放行。
执行时机：在处理器方法执行前执行 
方法参数：
                request请求对象
                response响应对象
                handler拦截到的方法处理

postHandle方法
作用：用于对拦截到的请求进行后处理，可以在方法中对模型数据和视图进行修改
执行时机：在处理器的方法执行后，视图渲染之前
方法参数：
                request请求对象
                response响应对象
                handler拦截到的处理器方法
                ModelAndView处理器方法返回的模型和视图对象，可以在方法中修改模型和视图

afterCompletion方法
作用：用于在整个流程完成之后进行最后的处理，如果请求流程中有异常，可以在方法中获取对象
执行时机：视图渲染完成后(整个流程结束之后)
方法参数：
                request请求参数
                response响应对象
                handler拦截到的处理器方法
                ex异常对象

四、各个方法执行时机图

五、拦截器链(多拦截器)

拦截器链的概念
如果多个拦截器能够对相同的请求进行拦截，则多个拦截器会形成一个拦截器链，主要理解拦截器链中各个拦截器的执行顺序。

拦截器链中多个拦截器的执行顺序
拦截器链中的多个拦截器的执行顺序，根拦截器的配置顺序有关，先配置的先执行，测试代码如下

MyInterceptor2.java


public class MyInterceptor2 implements HandlerInterceptor {
    // 预处理方法，在控制器的方法执行之前执行
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("preHandle2");
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("postHandle2");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("afterCompletion2");
    }
}

配置顺序如下：

<!--配置拦截器们-->
<mvc:interceptors>
    <!--配置具体的拦截器-->
    <mvc:interceptor>
        <!--配置拦截的资源-->
        <mvc:mapping path="/**"/>
        <!--配置拦截器bean对象-->
        <bean class="com.itheima.interceptor.MyInterceptor1"/>
    </mvc:interceptor>

    <mvc:interceptor>
        <!--配置拦截的资源-->
        <mvc:mapping path="/**"/>
        <!--配置拦截器bean对象-->
        <bean class="com.itheima.interceptor.MyInterceptor2"/>
    </mvc:interceptor>
</mvc:interceptors>

访问http://localhost/handleRun控制台输出顺序如下：

preHandle1
preHandle2
业务处理器运行------------main
postHandle2
postHandle1
afterCompletion2
afterCompletion1

六、执行顺序图示

注意：只要preHandle方法返回true，对应拦截器的afterCompletion方法坑定会执行。
例如：仅修改MyInterceptor2的preHandle方法的返回值为true，虽然整体没有放行，但是MyInterceptor的afterCompletion方法还是会执行

七、拦截器配置排除静态资源

注意：两种方式都需要有默认放行的规则，我已经在本文最开始配置好，如果不配置的话，不会放行静态资源，静态资源会被拦截器拦截

<!--1 默认放行静态资源-->
<servlet-mapping>
    <servlet-name>default</servlet-name>
    <!--配置不需要拦截的资源，用于外部不能访问WEB-INF，所以可以提前放行-->
    <url-pattern>*.jpg</url-pattern>
</servlet-mapping>

<!--2 默认放行静态资源，此方法和上面类似，但有些地方不一样-->
<mvc:default-servlet-handler/>

因为：默认情况下，如果dispatcherServlet的url-pattern配置为/，拦截器的拦截路径配置为/**，那么拦截器会拦截静态资源。

但是在实际场景中，拦截器只负责拦截对于处理器Controller的访问，所以需要排除静态资源，配置方式有两种：

方式一 : 配置拦截器只拦截对指定前缀Controller方法的访问

<mvc:interceptor>
    <!--配置拦截的资源,只拦截资源路径以/user开始的访问-->
    <mvc:mapping path="/user/**"></mvc:mapping>
    <mvc:mapping path="/dept/**"></mvc:mapping>
    ....
    <!--配置拦截器bean对象-->
    <bean class="com.itheima.interceptor.MyInterceptor1"></bean>
</mvc:interceptor>

这种方式的缺陷是，首先Controller必须配置一级访问目录。其次，一旦项目中的Controller过多，会出现大量的配置

方式二 : 配置拦截器排除指定资源的拦截

<mvc:interceptor>
    <!--配置拦截的资源-->
    <mvc:mapping path="/**"/>
    <!--配置拦截器不拦截的资源-->
    <mvc:exclude-mapping path="/**/*.png"/>
    <mvc:exclude-mapping path="/*/*.css"/>
    <mvc:exclude-mapping path="/**/*.js"/>
    <!--配置拦截器bean对象-->
    <bean class="com.itheima.interceptor.MyInterceptor1"/>
</mvc:interceptor>

上述配置中/**/*.png类似的配置，含义为，访问当前项目中任意层级的以.png结尾的资源拦截器都不拦

posted @ 2021-02-04 20:23 造化三境修行者阅读(247) 评论(0) 收藏举报

刷新页面返回顶部

造化三境修行者

强者恒强

SpringMVC拦截器Interceptor