1. 拦截器概念

介绍拦截器的概念之前，先看一张图：

在这里插入图片描述

(1)浏览器发送一个请求会先到Tomcat的web服务器

(2)Tomcat服务器接收到请求以后，会去判断请求的是静态资源还是动态资源

(3)如果是静态资源，会直接到Tomcat的项目部署目录下去直接访问

(4)如果是动态资源，就需要交给项目的后台代码进行处理

(5)在找到具体的方法之前，我们可以去配置过滤器(可以配置多个)，按照顺序进行执行

(6)然后进入到到中央处理器(SpringMVC中的内容)，SpringMVC会根据配置的规则进行拦截

(7)如果满足规则，则进行处理，找到其对应的controller类中的方法进行执行,完成后返回结果

(8)如果不满足规则，则不进行处理

(9)这个时候，如果我们需要在每个Controller方法执行的前后添加业务，具体该如何来实现？

这个就是拦截器要做的事。

拦截器（Interceptor）是一种动态拦截方法调用的机制，在SpringMVC中动态拦截控制器方法的执行
作用：
- 在指定的方法调用前后执行预先设定的代码
- 阻止原始方法的执行
- 总结：拦截器就是用来做增强

看完以后，大家会发现：

拦截器和过滤器在作用和执行顺序上也很相似

所以这个时候，就有一个问题需要思考：拦截器和过滤器之间的区别是什么？

归属不同：Filter属于Servlet技术，Interceptor属于SpringMVC技术
拦截内容不同：Filter对所有访问进行增强，Interceptor仅针对SpringMVC的访问进行增强

在这里插入图片描述

2. 拦截器入门案例

2.1 环境准备

创建一个Web的Maven项目

pom.xml添加SSM整合所需jar包

<?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.dcxuexi</groupId>
  <artifactId>springmvc_08_interceptor</artifactId>
  <version>1.0-SNAPSHOT</version>
  <packaging>war</packaging>

  <name>springmvc_08_interceptor Maven Webapp</name>
  <!-- FIXME change it to the project's website -->
  <url>http://www.example.com</url>

  <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>
  </properties>

<dependencies>
  <dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-webmvc</artifactId>
    <version>5.2.15.RELEASE</version>
  </dependency>
  <dependency>
    <groupId>javax.servlet</groupId>
    <artifactId>javax.servlet-api</artifactId>
    <version>3.1.0</version>
    <scope>provided</scope>
  </dependency>
  <dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>2.9.8</version>
  </dependency>
</dependencies>
  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.tomcat.maven</groupId>
        <artifactId>tomcat7-maven-plugin</artifactId>
        <version>2.1</version>
        <configuration>
          <port>80</port>
          <path>/springmvc</path>
          <uriEncoding>UTF-8</uriEncoding>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>

创建对应的配置类

@Configuration
@ComponentScan("com.dcxuexi.controller")
@EnableWebMvc
public class SpringMvcConfig {
}

public class ServlertConfig extends AbstractAnnotationConfigDispatcherServletInitializer {
    @Override
    protected Class<?>[] getRootConfigClasses() {
        return new Class[0];
    }

    @Override
    protected Class<?>[] getServletConfigClasses() {
        return new Class[]{SpringMvcConfig.class};
    }

    @Override
    protected String[] getServletMappings() {
        return new String[]{"/"};
    }

    @Override
    protected Filter[] getServletFilters() {
        CharacterEncodingFilter characterEncodingFilter = new CharacterEncodingFilter();
        characterEncodingFilter.setEncoding("UTF-8");
        return new Filter[]{characterEncodingFilter};
    }
}

创建模型类User

public class User {
    private Integer userId;
    private String email;
    private String userName;
    private Integer age;

    public Integer getUserId() {
        return userId;
    }

    public void setUserId(Integer userId) {
        this.userId = userId;
    }

    public String getEmail() {
        return email;
    }

    public void setEmail(String email) {
        this.email = email;
    }

    public String getUserName() {
        return userName;
    }

    public void setUserName(String userName) {
        this.userName = userName;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    @Override
    public String toString() {
        return "User{" +
                "userId=" + userId +
                ", email='" + email + '\'' +
                ", userName='" + userName + '\'' +
                ", age=" + age +
                '}';
    }
}

编写UserController

@RestController
@RequestMapping("/user")
public class UserController {

    @PostMapping
    public String save(@RequestBody User user){
        System.out.println("user save ===>" + user);
        return "{'module':'user save'}";
    }

    @PutMapping
    public String update(@RequestBody User user){
        System.out.println("user update ===>" + user);
        return "{'module':'user update'}";
    }

    @DeleteMapping("/{userId}")
    public String delete(@PathVariable Integer userId){
        System.out.println("user delete ===>" + userId);
        return "{'module':'user delete'}";
    }

    @GetMapping("/{userId}")
    public String findByUserId(@PathVariable Integer userId){
        System.out.println("user findByUserId ===>" + userId);
        return "{'module':'user findByUserId'}";
    }

    @GetMapping
    public String findAll(){
        System.out.println("user findByUserId ===> ......");
        return "{'module':'user findAll'}";
    }

}

最终创建好的项目结构如下：

在这里插入图片描述

2.2 拦截器开发

步骤1:创建拦截器类

让类实现HandlerInterceptor接口，重写接口中的三个方法。

@Component
//定义拦截器类，实现HandlerInterceptor接口
//注意当前类必须受Spring容器控制
public class ProjectInterceptor implements HandlerInterceptor {

    //原始方法调用前执行的内容
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("interceptor  preHandle .......");
        return true;
    }

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

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

**注意:**拦截器类要被SpringMVC容器扫描到。

步骤2:配置拦截器类

@Configuration
public class SpringMvcSupport  extends WebMvcConfigurationSupport {

    @Autowired
    private ProjectInterceptor projectInterceptor;


    @Override
    protected void addInterceptors(InterceptorRegistry registry) {
        //配置拦截器
        registry.addInterceptor(projectInterceptor).addPathPatterns("/user" );
    }

    @Override
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/user/**").addResourceLocations("/user/");

    }
}

步骤3:SpringMVC添加SpringMvcSupport包扫描

@Configuration
@ComponentScan({"com.itheima.controller","com.itheima.config"})
@EnableWebMvc
public class SpringMvcConfig{
   
}

步骤4:运行程序测试

使用PostMan发送http://localhost/springmvc/user

{
    "userName": "zhangsan",
    "userId": 10,
    "email": "zhangsan@foxmail.com",
    "age": 22
}

在这里插入图片描述

如果发送http://localhost/springmvc/user会发现拦截器没有被执行，原因是拦截器的addPathPatterns方法配置的拦截路径是/user，我们现在发送的是/user/10，所以没有匹配上，因此没有拦截，拦截器就不会执行。

在这里插入图片描述

步骤5:修改拦截器拦截规则

@Configuration
public class SpringMvcSupport  extends WebMvcConfigurationSupport {

    @Autowired
    private ProjectInterceptor projectInterceptor;


    @Override
    protected void addInterceptors(InterceptorRegistry registry) {
        //配置拦截器
        registry.addInterceptor(projectInterceptor).addPathPatterns("/user" ,"/user/*");
    }

    @Override
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/user/**").addResourceLocations("/user/");

    }
}

这个时候，如果再次访问http://localhost/books/10，拦截器就会被执行。

在这里插入图片描述

最后说一件事，就是拦截器中的preHandler方法，如果返回true,则代表放行，会执行原始Controller类中要请求的方法，如果返回false，则代表拦截，后面的就不会再执行了。

在这里插入图片描述

步骤6:简化SpringMvcSupport的编写

@Configuration
//@ComponentScan({"com.dcxuexi.controller","com.dcxuexi.config"})
@ComponentScan("com.dcxuexi.controller")
@EnableWebMvc
//实现WebMvcConfigurer接口可以简化开发，但具有一定的侵入性
public class SpringMvcConfig implements WebMvcConfigurer {

    @Autowired
    private ProjectInterceptor projectInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        //配置拦截器
        registry.addInterceptor(projectInterceptor).addPathPatterns("/user" ,"/user/*");
    }
}

此后咱们就不用再写SpringMvcSupport类了。

最后我们来看下拦截器的执行流程：

在这里插入图片描述

当有拦截器后，请求会先进入preHandle方法，

如果方法返回true，则放行继续执行后面的handle[controller的方法]和后面的方法

如果返回false，则直接跳过后面方法的执行。

3. 拦截器参数

3.1 前置处理方法

原始方法之前运行preHandle

    //原始方法调用前执行的内容
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("interceptor  preHandle .......");
        return true;
    }

request：请求对象
response：响应对象
handler：被调用的处理器对象，本质上是一个方法对象，对反射中的Method对象进行了再包装

使用request对象可以获取请求数据中的内容，如获取请求头的Content-Type

    //原始方法调用前执行的内容
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("interceptor  preHandle .......");
        String contentType = request.getHeader("Content-Type");
        System.out.println("preHandle..."+contentType);
        return true;
    }

使用handler参数，可以获取方法的相关信息

    //原始方法调用前执行的内容
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("interceptor  preHandle .......");
        
        String contentType = request.getHeader("Content-Type");
        System.out.println("preHandle..."+contentType);
        
        HandlerMethod hm = (HandlerMethod)handler;
        String methodName = hm.getMethod().getName();//可以获取方法的名称
        System.out.println("preHandle..."+methodName);
        
        return true;
    }

3.2 后置处理方法

原始方法运行后运行，如果原始方法被拦截，则不执行

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

前三个参数和上面的是一致的。

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

因为咱们现在都是返回json数据，所以该参数的使用率不高。

3.3 完成处理方法

拦截器最后执行的方法，无论原始方法是否执行

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

前三个参数与上面的是一致的。

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

因为我们现在已经有全局异常处理器类，所以该参数的使用率也不高。

这三个方法中，最常用的是preHandle，在这个方法中可以通过返回值来决定是否要进行放行，我们可以把业务逻辑放在该方法中，如果满足业务则返回true放行，不满足则返回false拦截。

4. 拦截器链配置

目前，我们在项目中只添加了一个拦截器，如果有多个，该如何配置？配置多个后，执行顺序是什么？

4.1 配置多个拦截器

步骤1:创建拦截器类

实现接口，并重写接口中的方法

@Component
//定义拦截器类，实现HandlerInterceptor接口
//注意当前类必须受Spring容器控制
public class ProjectInterceptor02 implements HandlerInterceptor {

    //原始方法调用前执行的内容
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("ProjectInterceptor02  preHandle .......");

        return true;
    }

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

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

步骤2:配置拦截器类

@Configuration
//@ComponentScan({"com.dcxuexi.controller","com.dcxuexi.config"})
@ComponentScan("com.dcxuexi.controller")
@EnableWebMvc
//实现WebMvcConfigurer接口可以简化开发，但具有一定的侵入性
public class SpringMvcConfig implements WebMvcConfigurer {

    @Autowired
    private ProjectInterceptor projectInterceptor;

    @Autowired
    private ProjectInterceptor02 projectInterceptor02;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        //配置拦截器
        registry.addInterceptor(projectInterceptor).addPathPatterns("/user" ,"/user/*");
        registry.addInterceptor(projectInterceptor02).addPathPatterns("/user" ,"/user/*");
    }
}

步骤3:运行程序，观察顺序

在这里插入图片描述

拦截器执行的顺序是和配置顺序有关。先进后出。

当配置多个拦截器时，形成拦截器链
拦截器链的运行顺序参照拦截器添加顺序为准
当拦截器中出现对原始处理器的拦截，后面的拦截器均终止运行
当拦截器运行中断，仅运行配置在前面的拦截器的afterCompletion操作

在这里插入图片描述

preHandle：与配置顺序相同，必定运行

postHandle：与配置顺序相反，可能不运行

afterCompletion：与配置顺序相反，可能不运行。

只需要把握住一个原则即可：以最终的运行结果为准

项目代码

本文含有隐藏内容，请开通VIP 后查看

SpringMVC项目拦截器

1. 拦截器概念

2. 拦截器入门案例

2.1 环境准备

2.2 拦截器开发

步骤1:创建拦截器类

步骤2:配置拦截器类

步骤3:SpringMVC添加SpringMvcSupport包扫描

步骤4:运行程序测试

步骤5:修改拦截器拦截规则

步骤6:简化SpringMvcSupport的编写

3. 拦截器参数

3.1 前置处理方法

3.2 后置处理方法

3.3 完成处理方法

4. 拦截器链配置

4.1 配置多个拦截器

步骤1:创建拦截器类

步骤2:配置拦截器类

项目代码

网站公告

今日签到

热门文章

最新发布