springmvc的拦截器Interceptor案例

1、创建maven项目，选择archetype-webapp

  <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.2</version>
      <scope>provided</scope>
    </dependency>
  </dependencies>

2、web.xml

servlet是springmvc的入口，用来激活 DispatcherServlet，且激活springmvc.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>

  <!--  解决中文乱码的过滤器-->
  <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>

  <!--  springmvc必须先配置前端控制器 DisPatcherServlet，任何请求都会经过servlet-->
  <servlet>
    <servlet-name>dispatcherServlet</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <!--    将 springmvc.xml 文件交给servlet加载后才可生效-->
    <init-param>
      <param-name>contextConfigLocation</param-name>
      <param-value>classpath:springmvc.xml</param-value>
    </init-param>
    <!--    服务器启动就会创建 DispatcherServlet 类-->
    <load-on-startup>1</load-on-startup>
  </servlet>
  <servlet-mapping>
    <servlet-name>dispatcherServlet</servlet-name>
    <url-pattern>/</url-pattern>
  </servlet-mapping>

</web-app>

3、springmvc.xml

xml方式

开启springmvc框架注解，配置拦截器类（拦截器类才可生效）、注解扫描等

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:mvc="http://www.springframework.org/schema/mvc"
       xmlns:context="http://www.springframework.org/schema/context"
       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的ioc容器管理，将其注入spring容器中-->
    <context:component-scan base-package="com.lian.springmvc"/>

    <!--    配置试图解析器对象，使返回的success找到success.jsp页面的路径-->
    <bean id="internalResourceViewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
        <property name="prefix" value="/WEB-INF/pages/"/>
        <property name="suffix" value=".jsp"/>
    </bean>

    <!--前端控制器，哪些静态资源不拦截-->
    <mvc:resources mapping="/css/**/" location="/css/"/>
    <mvc:resources mapping="/images/**/" location="/images/"/>
    <mvc:resources mapping="/js/**/" location="/js/"/>

    <!--配置异常处理器-->
    <bean id="myExceptionResolver" class="com.lian.springmvc.exception.MyExceptionResolver"/>

    <!--
        配置拦截器
        拦截器是springmvc的功能，只能对controller起作用
        过滤器可以对所有的页面起作用，范围大于拦截器
    -->
    <mvc:interceptors>
        <mvc:interceptor>
            <!--要拦截的具体方法-->
            <mvc:mapping path="/user/*"/>
            <!--不要拦截的方法
            <mvc:exclude-mapping path=""/>-->
            <!--配置拦截器对象-->
            <bean class="com.lian.springmvc.config.MyInterceptor"/>
        </mvc:interceptor>

        <!--配置第二个拦截器-->
        <mvc:interceptor>
            <!--要拦截的具体方法-->
            <mvc:mapping path="/user/*"/>
            <!--不要拦截的方法
            <mvc:exclude-mapping path=""/>-->
            <!--配置拦截器对象-->
            <bean class="com.lian.springmvc.config.MyInterceptor2"/>
        </mvc:interceptor>
    </mvc:interceptors>

    <!--开启springmvc的框架注解支持，默认会开启处理器适配器和处理器映射器，@RequestMapping就是springmvc的注解-->
    <mvc:annotation-driven/>

</beans>

配置类方式

/**
 * 拦截器配置
 * 给拦截器的注册链表里添加拦截器
 * /** 代表拦截所有请求
 */
@Configuration
public class gulimallWebConfig implements WebMvcConfigurer {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new CartIntercept()).addPathPatterns("/**");
    }
}

4、controller

package com.lian.springmvc.controller;

import com.lian.springmvc.exception.MyException;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

@Controller
@RequestMapping("/user")
public class MyController {

    /**
     * 测试拦截器，拦截器只能拦截controller的方法
     * 1、正常没有配置拦截器的话，会直接执行controller的方法，跳转到 success页面
     * 2、配置拦截器后，会先执行拦截器方法，拦截器放行后会再执行controller中的方法
     * @return
     * @throws MyException
     */
    @RequestMapping("/testInterceptor")
    public String testInterceptor() throws MyException{
        System.out.println("controller run...");
        return "success";
    }
}

5、拦截器配置类

package com.lian.springmvc.config;

import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

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

/**
 * 自定义拦截器
 * 拦截器只作用于 controller
 */
@Configuration
public class MyInterceptor implements HandlerInterceptor {

    /**
     * return false;代表不放行
     * return true 放行，执行下一个拦截器，如果没有，执行controller中的方法
     * controller 方法执行前
     * @param request
     * @param response
     * @param handler
     * @return
     * @throws Exception
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("interceptor run..before 11");
        //request.getRequestDispatcher("/WEB-INF/pages/error.jsp").forward(request,response);
        //return false; //不放行，直接只执行拦截器方法，可以通过转发或重定向到其他页面

        return true; //放行，会执行controller中方法
    }

    /**
     * controller 方法执行后，success页面跳转之前
     * @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("interceptor run..after 11");
    }

    /**
     * success.jsp 页面执行后该方法会执行
     * @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("interceptor run..end 11");
    }
}

6、success.jsp

<%--
  Created by IntelliJ IDEA.
  User: 13754
  Date: 2021-07-14
  Time: 18:13
  To change this template use File | Settings | File Templates.
--%>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Title</title>
</head>
<body>
    <h1>执行成功</h1>

    <% System.out.println("success.jsp run"); %>
</body>
</html>

7、测试结果

一个拦截器演示结果

interceptor run..before
controller run...
interceptor run..after
success.jspִ    
interceptor run..end

两个拦截器演示结果

interceptor run..before 11
interceptor run..before 22
controller run...
interceptor run..after 22
interceptor run..after 11
success.jsp run
interceptor run..end 22
interceptor run..end 11