SpringMVC案例07--自定义拦截器

项目说明

• 要使用自定义拦截器，需要实现HandlerInterceptor接口
• 在拦截器中方法如果存在跳转相关代码，页面会直接进行跳转，如果后续还有页面跳转的代码存在，程序会执行，但在浏览器只会显示第一次跳转的页面。
• 如果拦截器的preHandle()方法直接拦截了请求，那么后续的【拦截器后处理方法】，【拦截器最终处理方法】，【页面跳转】都不会再执行。拦截器链亦是如此。

环境搭建

pom文件

 <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <maven.compiler.source>1.8</maven.compiler.source>
    <maven.compiler.target>1.8</maven.compiler.target>
    <!--    设置版本锁定-->
    <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>

配置web.xml

<!DOCTYPE web-app PUBLIC
 "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
 "http://java.sun.com/dtd/web-app_2_3.dtd" >

<web-app>
  <display-name>Archetype Created Web Application</display-name>
  <!--  配置前端核心控制器-->
  <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:springmvc.xml</param-value>
    </init-param>
    <!--    应用启动时创建servlet-->
    <load-on-startup>1</load-on-startup>
  </servlet>
  <servlet-mapping>
    <servlet-name>dispatcherServlet</servlet-name>
    <!--    所有请求通过控制器-->
    <url-pattern>/</url-pattern>
  </servlet-mapping>
  <!--    配置解决乱码问题的过滤器-->
  <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>
</web-app>

配置springmvc.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.cncs"></context:component-scan>
    <!--    配置视图解析器-->
    <bean id="internalResourceViewResolver" 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="/user/**"/>
            <bean class="com.cncs.interceptor.MyInterceptor1"></bean>
        </mvc:interceptor>
    </mvc:interceptors>
    <!--开启springmvc框架对注解的支持-->
    <mvc:annotation-driven/>
</beans>

编码编写

jsp代码

<a href="user/testInterceptor">拦截器</a>

自定义拦截器处理器类

• 拦截器内的三个方法执行顺序：【preHandle()】>【postHandle()】>【afterCompletion()】

• preHandle()方法如果返回值是false，后续的流程都不再执行。

• 在preHandle()方法中如果有页面跳转，浏览器页面会直接跳转。如果后续还有要跳转的页面，程序会执行，但浏览器不再显示，只显示第一次跳转的页面。

public class MyInterceptor1 implements HandlerInterceptor {

    /**
     * 预处理
     *
     * @param request
     * @param response
     * @param handler
     * @return true 放行
     * false 拦截
     * @throws Exception
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("111拦截器方法执行了。。。。前");
//        request.getRequestDispatcher("/WEB-INF/pages/error.jsp").forward(request,response);
//        System.out.println(request.getContextPath());
//        response.sendRedirect(request.getContextPath()+"/WEB-INF/pages/error.jsp");
        return true;
    }


    /**
     * 方法后处理
     *
     * @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("111拦截器方法执行了。。。。后");
//        request.getRequestDispatcher("/WEB-INF/pages/error.jsp").forward(request, response);

    }

    /**
     * 最后执行
     *
     * @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("111拦截器方法执行了。。。。最后");
    }
}

controller代码

@Controller
@RequestMapping("/user")
public class UserController {
    @RequestMapping("/testInterceptor")
    public String testInterceptor(){
        System.out.println("testInterceptor executing...");
        return "success";
    }
}

执行顺序

只有一个拦截器时执行顺序

【浏览器发出请求】> 【拦截器1预处理方法】 > 【控制器中相关方法】>【拦截器1后处理方法】 > 【跳转后的页面】 > 【拦截器1最终处理方法】

拦截器链

复制一个拦截器类MyInterceptor2作为拦截器2

然后配置拦截器链，注意拦截器链的顺序

<!--    配置拦截器组-->
    <mvc:interceptors>
        <!--        配置第一个拦截器-->
        <mvc:interceptor>
            <mvc:mapping path="/user/**"/>
            <bean class="com.cncs.interceptor.MyInterceptor1"></bean>
        </mvc:interceptor>

        <!--        配置第2个拦截器-->
        <mvc:interceptor>
            <mvc:mapping path="/user/**"/>
            <bean class="com.cncs.interceptor.MyInterceptor2"></bean>
        </mvc:interceptor>
    </mvc:interceptors>

最后拦截器链的执行流程

111拦截器方法执行了。。。。前
222拦截器方法执行了。。。。前
testInterceptor executing...
222拦截器方法执行了。。。。后
111拦截器方法执行了。。。。后
success.jsp 执行了。。。
222拦截器方法执行了。。。。最后
111拦截器方法执行了。。。。最后