SpringMVC-2-Spring MVC拦截器详解：从入门到精通

今日目标

能够编写拦截器并配置拦截器

1.拦截器【理解】

1 拦截器介绍

1.1 拦截器概念和作用

• 拦截器（Interceptor）是一种动态拦截方法调用的机制，在SpringMVC中动态拦截控制器方法的执行

• 作用：

  1. 在指定的方法调用前后执行预先设定的代码

  2. 阻止原始方法的执行

  3. 总结：增强

• 核心原理：AOP思想

1.2 拦截器和过滤器的区别

• 归属不同：Filter属于Servlet技术，Interceptor属于SpringMVC技术

• 拦截内容不同：Filter对所有访问进行增强，Interceptor仅针对SpringMVC的访问进行增强

1.3 拦截器应用场景

拦截器本质上是面向切面编程（AOP），符合横切关注点的功能都可以放在拦截器中来实现，主要的应用场景包括：

• 登录验证，判断用户是否登录。

• 权限验证，判断用户是否有权限访问资源，如校验token

• 日志记录，记录请求操作日志（用户ip，访问时间等），以便统计请求访问量。

• 处理cookie、本地化、国际化、主题等。

• 性能监控，监控请求处理时长等。

2 入门案例

2.1 实现步骤

1 创建web工程（Maven web结构）
2 导入坐标（SpringMVC+Servlet）
3 SpringMVCConfig 配置类 配置前缀”/pages/”和后缀”.jsp”
4 ServletConfig 配置类创建IOC容器和拦截请求路径”/”
5 自定义控制器类（StudentController）
6 开发视图页面/pages/success.jsp

2.2 代码实现

【第一步】创建web工程（Maven结构）

【第二步】导入坐标（SpringMVC+Servlet）

<dependencies> 
 <!--spring-webmvc-->  
 <dependency> 
   <groupId>org.springframework</groupId>  
   <artifactId>spring-webmvc</artifactId>  
   <version>5.3.15</version> 
 </dependency>  
 <!--servlet-->  
 <dependency> 
   <groupId>javax.servlet</groupId>  
   <artifactId>javax.servlet-api</artifactId>  
   <version>4.0.1</version>  
   <scope>provided</scope> 
 </dependency> 
</dependencies> 

【第三步】创建SpringMvc配置文件

/**
* SpringMVC配置类
*/
@Configuration //1.标识当前是配置类 指定这个类为配置类,替代application.xml
@ComponentScan("com.zbbmeta")//2.配置扫描web层包 代替<context:component-scan base-package="com.zbbmeta" />
@EnableWebMvc //如果使用接口的方式，拦截器需要添加这个注解。不建议使用这种方式，两种方式只能配置一种，否则会有冲突
public class SpringMvcConfig {
}

【第四步】创建Web容器初始化的配置类

public class ServletConfig  extends AbstractAnnotationConfigDispatcherServletInitializer {

    // 暂时不管,整合Spring才需要
    @Override
    protected Class<?>[] getRootConfigClasses() {
        return new Class[0];
    }
    //在tomcat启动时调用，用于创建springmvc框架的IOC容器对象
    //加载springmvc配置类， Tomcat会拿这个配置类去创建IoC容器,产生springmvc容器（本质还是spring容器）
    @Override
    protected Class<?>[] getServletConfigClasses() {
        return new Class[] {SpringMvcConfig.class};
    }
    // 指定SpringMVC要处理哪些请求, /表示SpringMVC处理项目中的所有请求, 静态资源不要让SpringMVC处理,要放行
    //设置DispatcherServlet绑定处理请求的路径"/"，处理除了jsp的所有资源请求
    @Override
    protected String[] getServletMappings() {
        return new String[] {"/"};
    }
}

【第五步】创建控制器

package com.zbbmeta.controller;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

@RestController
@RequestMapping("/student")//RequestMapping可以在类或者方法上添加
public class StudentController {
    /**
     * 查找Student
     */
    @RequestMapping("/find")
    public String find(HttpServletRequest request, HttpServletResponse response) {
        System.out.println("查找Student");
        return "find success";
    }
}

2.3 拦截器代码实现

【第一步】定义拦截器

做法：定义一个类，实现HandlerInterceptor接口即可

package com.zbbmeta.Iinterceptor;

import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

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

public class StudentInterceptor implements HandlerInterceptor {
    //原始方法调用前执行的内容
    //返回值类型可以拦截控制的执行，true放行，false终止
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("=================前置通知=================");
        return true;
    }
    //原始方法调用后执行的内容
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("=================后置通知=================");
    }
    //原始方法调用完成后执行的内容
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("=================最终通知=================");
    }
}

【第二步】配置加载拦截器

配置加载拦截器的方式有两种我们分别介绍：

加载拦截器方法1：

注：@Configuration注解已经包含@Component的功能

1. 在上面添加静态资源的配置类中重写addInterceptors方法

2. 添加拦截器和多个拦截路径：/book和/book/**

3. 要注入拦截器对象

package com.zbbmeta.config;

import com.zbbmeta.Iinterceptor.StudentInterceptor;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;

@Configuration
public class SpringMvcSupport extends WebMvcConfigurationSupport {

    @Override
    protected void addInterceptors(InterceptorRegistry registry) {
        //注解拦截器和拦截地址   表示添加 StudentInterceptor  取拦截路径是 /student/* 所有请求
        registry.addInterceptor(new StudentInterceptor()).addPathPatterns("/student/*");
    }
}

加载拦截器方法2：

使用标准接口WebMvcConfigurer简化开发（注意：侵入式较强）

1. 在SpringMvcConfig主配置类上实现WebMvcConfigurer接口，接口中全是默认方法

2. 注入拦截器对象，重写addInterceptors方法

注：与方式一两者只能选一种，不然会有冲突，如果方式一起作用会导致第二种方式的拦截器不起使用。

即：如果项目中出现了一次 extends WebMvcConfigurationSupport ，其他的 extends WebMvcConfigurationSupport 和 implements WebMvcConfigurer 会失效 。

/**
 * SpringMVC配置类
 */
@Configuration //1.标识当前是配置类 指定这个类为配置类,替代application.xml
@ComponentScan("com.zbbmeta")//2.配置扫描web层包 代替<context:component-scan base-package="com.zbbmeta" />
@EnableWebMvc //如果使用接口的方式，拦截器需要添加这个注解。不建议使用这种方式，两种方式只能配置一种，否则会有冲突
public class SpringMvcConfig  implements WebMvcConfigurer {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        //注解拦截器和拦截地址   表示添加 StudentInterceptor  取拦截路径是 /student/* 所有请求
        registry.addInterceptor(new StudentInterceptor()).addPathPatterns("/student/*");
    }
}

2.4 拦截器流程分析

3 拦截器参数

3.1 前置处理

//原始方法调用前执行的内容
//返回值类型可以拦截控制的执行，true放行，false终止
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
    System.out.println("=================前置通知=================");
    return true;
}

• 参数

  1. request:请求对象

  2. response:响应对象

  3. handler:被调用的处理器对象，本质上是一个方法对象，对反射技术中的Method对象进行了再包装

• 返回值 返回值为false，被拦截的处理器将不执行。

3.2 后置处理

//原始方法调用后执行的内容
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
    System.out.println("=================后置通知=================");
}

• 参数 modelAndView：如果处理器执行完成具有返回结果，可以读取到对应数据与页面信息，并进行跳转

注意：如果处理器方法出现异常了，该方法不会执行

3.3 完成后处理

//原始方法调用完成后执行的内容
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
    System.out.println("=================最终通知=================");
}

• 参数 ex:如果处理器执行过程中出现异常对象，可以针对异常情况进行单独处理

注意：无论处理器方法内部是否出现异常，该方法都会执行。

**思考:postHandle()和afterCompletion()方法都是处理器方法执行之后执行，有什么区别？

4 拦截器链配置

4.1 多个拦截器配置

• 定义第二个拦截器

package com.zbbmeta.Iinterceptor;

import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

public class StudentInterceptor2 implements HandlerInterceptor {
    //原始方法调用前执行的内容
    //返回值类型可以拦截控制的执行，true放行，false终止
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("=================Student2前置通知=================");
        return true;
    }
    //原始方法调用后执行的内容
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("=================Student2后置通知=================");
    }
    //原始方法调用完成后执行的内容
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("=================Student2最终通知=================");
    }
}

• 配置加载第二个拦截器

/**
 * SpringMVC配置类
 */
@Configuration //1.标识当前是配置类 指定这个类为配置类,替代application.xml
@ComponentScan("com.zbbmeta")//2.配置扫描web层包 代替<context:component-scan base-package="com.zbbmeta" />
@EnableWebMvc //如果使用接口的方式，拦截器需要添加这个注解。不建议使用这种方式，两种方式只能配置一种，否则会有冲突
public class SpringMvcConfig  implements WebMvcConfigurer {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        //注解拦截器和拦截地址   表示添加 StudentInterceptor  取拦截路径是 /student/* 所有请求
        registry.addInterceptor(new StudentInterceptor()).addPathPatterns("/student/*");
        registry.addInterceptor(new StudentInterceptor2()).addPathPatterns("/student/*");
    }
}

提示：可以使用excludePathPatterns()方法排除某些地址不被拦截

• 执行效果

4.2 多个连接器工作流程分析

• 当配置多个拦截器时，形成拦截器链

• 拦截器链的运行顺序参照拦截器添加顺序为准

• 当拦截器中出现对原始处理器的拦截，后面的拦截器均终止运行

• 当拦截器运行中断，仅运行配置在前面的拦截器的afterCompletion操作