SpringMVC框架中的拦截器

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.qcby</groupId>
    <artifactId>springMVC17</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>war</packaging>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <!--版本锁定-->
        <spring.version>5.0.2.RELEASE</spring.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-web</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-webmvc</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>servlet-api</artifactId>
            <version>2.5</version>
            <scope>provided</scope>
        </dependency>
        <dependency>
            <groupId>javax.servlet.jsp</groupId>
            <artifactId>jsp-api</artifactId>
            <version>2.0</version>
            <scope>provided</scope>
        </dependency>
    </dependencies>
</project>

3.web.xml

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
         version="4.0">
    <!--配置解决中文乱码问题的过滤器-->
    <filter>
        <filter-name>characterEncodingFilter</filter-name>
        <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
        <!--指定使用编码集-->
        <init-param>
            <param-name>encoding</param-name>
            <param-value>UTF-8</param-value>
        </init-param>
    </filter>
    <filter-mapping>
        <filter-name>characterEncodingFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>
    <!--前端控制器-->
    <servlet>
        <servlet-name>DispatcherServlet</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <!--配置初始化参数-->
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>classpath:spring-mvc.xml</param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>DispatcherServlet</servlet-name>
        <url-pattern>*.do</url-pattern>
    </servlet-mapping>
</web-app>

4.spring-mvc.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:mvc="http://www.springframework.org/schema/mvc"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="
        http://www.springframework.org/schema/beans
        http://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/mvc
        http://www.springframework.org/schema/mvc/spring-mvc.xsd
        http://www.springframework.org/schema/context
        http://www.springframework.org/schema/context/spring-context.xsd">

    <!-- 配置spring创建容器时要扫描的包 -->
    <context:component-scan base-package="com.qcby"></context:component-scan>

    <!-- 配置视图解析器 -->
    <bean id="viewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
        <property name="prefix" value="/WEB-INF/pages/"></property>
        <property name="suffix" value=".jsp"></property>
    </bean>

    <!-- 配置spring开启注解mvc的支持-->
    <!--    <mvc:annotation-driven></mvc:annotation-driven>-->
</beans>

5.controller层——DeptController类

package com.qcby.controller;

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

/*
* 测试拦截器
* */
@Controller
@RequestMapping("/dept")
public class DeptController {
    @RequestMapping("/findAll1.do")
    public String findAll1(){
        System.out.println("controller方法执行了...");
        return "success";
    }
}

6.创建类(MyInterceptor)，实现HandlerInterceptor接口，重写需要的方法

MyInterceptor类

package com.qcby.interceptor;

import org.springframework.web.servlet.HandlerInterceptor;

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

public class MyInterceptor implements HandlerInterceptor {
    /*
    * 拦截controller中的方法。放行了，执行controller中的方法
    * return true  放行
    * return false  拦截
    * */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("拦截器preHandle方法执行了");
        //手动跳转页面
        request.getRequestDispatcher("/index.jsp").forward(request,response);
        //response.sendRedirect("/index.jsp");  //这两个都是跳转的
        //拦截不放行
        return false; 
        //放行
        //return true;
    }
}

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

<!--配置拦截器们-->
<mvc:interceptors>
    <!--配置拦截器-->
    <mvc:interceptor>
        <!--该拦截器拦截哪些资源-->
        <mvc:mapping path="/dept/**"/>
        <!--哪些资源不想拦截-->
        <!--<mvc:exclude-mapping path=""/>-->
        <!--拦截器对象-->
        <bean class="com.qcby.interceptor.MyInterceptor"></bean>
    </mvc:interceptor>
</mvc:interceptors>

8.运行

(1) 6.MyInterceptor类中的----不放行，手动跳转页面

控制台：

说明，findAll1()方法被拦截了，没放行，但是设置了跳转页面，所以会跳转到index.jsp

(2) 6.MyInterceptor类中的----不放行

控制台：

说明：findAll1()方法被拦截了，输出拦截器..执行了，但是没放行，所以浏览器什么也没有

(3）6.MyInterceptor类中的----放行，手动跳转页面

控制台：

说明

①findAll1()方法被拦截了，输出拦截器..执行了，②但是放行了，所以再执行findAll1()方法，输出controller方法执行了... , ③且是在preHandle方法里手动设置了跳转页面，那么controller方法中跳转的页面将不会显示，所以跳转到index.jsp页面

(4）6.MyInterceptor类中的----放行

控制台：

说明

这次没有设置手动跳转页面，所以它返回的是success

三、HandlerInterceptor接口中的方法

1.preHandle方法是controller方法执行前拦截的方法

(1)可以使用

request( request.getRequestDispatcher("/index.jsp").forward(request,response); )或者response( response.sendRedirect("/index.jsp") )跳转到指定的页面

(2)如果指定了跳转的页面，那么controller方法跳转的页面将不会显示

(3)return true放行，执行下一个拦截器，如果没有拦截器，执行controller中的方法

(4)return false不放行，不会执行controller中的方法

2.postHandle是controller方法执行后执行的方法，在jsp视图执行前

(1)在JSP试图执行前(controller方法中页面跳转之前执行)

(2)可以使用request或者response跳转到指定的页面

(3)如果指定了跳转的页面，那么controller方法跳转的页面将不会显示

3.afterCompletion方法是在JSP执行后执行

(1)JSP执行后执行(controller方法中页面跳转之后执行)

(2)request或者response不能再跳转页面了

4.代码

MyInterceptor类

package com.qcby.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 MyInterceptor implements HandlerInterceptor {
    /*
    * (controller方法执行前拦截)
    * 拦截controller中的方法。放行了，执行controller中的方法
    * return true  放行
    * return false  拦截
    * */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("MyInterceptor中的preHandle方法执行了");
        //手动跳转页面
        //request.getRequestDispatcher("/index.jsp").forward(request,response);
        //response.sendRedirect("/index.jsp");
        //拦截不放行
        //return false;
        //放行
        return true;
    }
    /*
    * controller方法执行后要拦截的方法
    * */
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("MyInterceptor中的postHandle方法执行了...");
        //也可以进行页面跳转
        request.getRequestDispatcher("/postHandle.jsp").forward(request,response);
        //response.sendRedirect("/postHandle.jsp");
        return;
    }
    /*
    * controller跳转的jsp页面都执行完了，最后执行该方法
    * */
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response,Object handler,Exception ex) throws Exception{
        System.out.println("MyInterceptor中的afterCompletion方法执行了...");
    }
}

5.运行

(1)放行--preHandle设置request跳转，postHandle也设置request跳转

控制台

(2)放行--preHandle设置response跳转，postHandle设置request跳转

报错：因为response提交有页面显示后仍然含请求转向

控制台：

(3)放行--preHandle设置request跳转，postHandle设置response跳转

控制台：

(4)放行--preHandle设置response跳转，postHandle也设置response跳转

报错500

控制台：

(5)放行--preHandle不设置跳转，postHandle设置跳转

控制台：

说明

①findAll1()方法被拦截了，输出拦截器preHandle方法执行了，②但是放行了，所以再执行findAll1()方法，输出controller方法执行了... , ③且在postHandle方法里手动设置了跳转页面，那么controller方法中跳转的页面将不会显示，所以跳转到postHandle.jsp页面

(6)不放行--都是request

控制台：

说明：

当不放行时，postHandle方法和afterCompletion方法不会执行

6.总结：（放行）

preHandle方法	postHandle方法
request	request	跳转preHandle方法中的页面
response	request	500
request	response	跳转preHandle方法中的页面
response	response	500

四、配置多个拦截器

1.再写一个拦截器的类——MyInterceptor2类

package com.qcby.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 MyInterceptor2 implements HandlerInterceptor {
    /*
     * (controller方法执行前拦截)
     * 拦截controller中的方法。放行了，执行controller中的方法
     * return true  放行
     * return false  拦截
     * */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("MyInterceptor2中的preHandle方法执行了");
        //放行
        return true;
    }
    /*
     * controller方法执行后要拦截的方法
     * */
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("MyInterceptor2中的postHandle方法执行了...");
        return;
    }
    /*
     * controller跳转的jsp页面都执行完了，最后执行该方法
     * */
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response,Object handler,Exception ex) throws Exception{
        System.out.println("MyInterceptor2中的afterCompletion方法执行了...");
    }
}

2.配置两个拦截器

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:mvc="http://www.springframework.org/schema/mvc"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="
        http://www.springframework.org/schema/beans
        http://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/mvc
        http://www.springframework.org/schema/mvc/spring-mvc.xsd
        http://www.springframework.org/schema/context
        http://www.springframework.org/schema/context/spring-context.xsd">

    <!-- 配置spring创建容器时要扫描的包 -->
    <context:component-scan base-package="com.qcby"></context:component-scan>

    <!-- 配置视图解析器 -->
    <bean id="viewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
        <property name="prefix" value="/WEB-INF/pages/"></property>
        <property name="suffix" value=".jsp"></property>
    </bean>

    <!--配置拦截器们-->
    <mvc:interceptors>
        <!--配置拦截器-->
        <mvc:interceptor>
            <!--该拦截器拦截哪些资源-->
            <mvc:mapping path="/dept/**"/>
            <!--哪些资源不想拦截-->
            <!--<mvc:exclude-mapping path=""/>-->
            <!--拦截器对象-->
            <bean class="com.qcby.interceptor.MyInterceptor"></bean>
        </mvc:interceptor>
        <!--配置拦截器-->
        <mvc:interceptor>
            <mvc:mapping path="/**"/>
            <bean class="com.qcby.interceptor.MyInterceptor2" />
        </mvc:interceptor>
    </mvc:interceptors>

    <!-- 配置spring开启注解mvc的支持-->
    <!--    <mvc:annotation-driven></mvc:annotation-driven>-->
</beans>