SpringMVC拦截器

1、 拦截器简介

问题导入

问题1：拦截器拦截的对象是谁？

问题2：拦截器和过滤器有什么区别？

1.1 拦截器概念和作用

• 拦截器（Interceptor）是一种动态拦截方法调用的机制，在SpringMVC中动态拦截控制器方法的执行
• 作用：
  1. 在指定的方法调用前后执行预先设定的代码
  2. 阻止原始方法的执行
  3. 总结：增强
• 核心原理：AOP思想

1.2 拦截器和过滤器的区别

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

2 、入门案例

问题导入

定义拦截器需要实现什么接口？

搭建环境

1. pom.xml文件

   <dependencies>
       <!--servlet的包-->
       <dependency>
           <groupId>javax.servlet</groupId>
           <artifactId>javax.servlet-api</artifactId>
           <version>4.0.1</version>
           <scope>provided</scope>
       </dependency>
   
       <!-- springmvc的包 -->
       <dependency>
           <groupId>org.springframework</groupId>
           <artifactId>spring-webmvc</artifactId>
           <version>5.2.10.RELEASE</version>
       </dependency>
   </dependencies>
   

2. 创建SpringMvc配置文件

   @Configuration
   //同时扫描控制器和配置类所在的包
   @ComponentScan({"com.demo.controller","com.demo.config"})
   @EnableWebMvc  //如果使用接口的方式，拦截器需要添加这个注解。不建议使用这种方式，两种方式只能配置一种，否则会有冲突
   public class SpringMvcConfig {
   }
   

3. 创建Web容器初始化的配置类

   public class ServletConfigInitializer extends AbstractAnnotationConfigDispatcherServletInitializer {
       @Override
       protected Class<?>[] getRootConfigClasses() {
           return new Class[0];
       }
   
       @Override
       protected Class<?>[] getServletConfigInitializerClasses() {
           return new Class[]{SpringMvcConfig.class};
       }
   
       @Override
       protected String[] getServletMappings() {
           return new String[]{"/"};
       }
   }
   

4. 创建控制器

   @RestController
   @RequestMapping("/book")
   public class BookController {
   
       /**
        * 查找书籍
        */
       @RequestMapping("/find")
       public String find() {
           System.out.println("查找书籍");
           return "find success";
       }
   }
   

2.1 拦截器代码实现

【第一步】定义拦截器

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

public class BookInterceptor implements HandlerInterceptor { //定义拦截器类，实现HandlerInterceptor接口
    @Override
    //原始方法调用前执行的内容
    //返回值类型可以拦截控制的执行，true放行，false终止
    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. 要注入拦截器对象

@Configuration
public class SpringMvcSupport extends WebMvcConfigurationSupport {

    @Override
    protected void addInterceptors(InterceptorRegistry registry) {
        //注解拦截器和拦截地址
        registry.addInterceptor(new BookInterceptor()).addPathPatterns("/book/*");
    }
}

方法2：

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

1. 在SpringMvcConfig主配置类上实现WebMvcConfigurer接口，接口中全是默认方法
2. 注入拦截器对象，重写addInterceptors方法

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

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

@Configuration
//同时扫描控制器和配置类所在的包
@ComponentScan({"com.demo.controller","com.demo.config"})
@EnableWebMvc
public class SpringMvcConfig implements WebMvcConfigurer {

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

2.2 拦截器流程分析

3 拦截器参数

问题导入

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

3.1 前置处理

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

• 参数

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

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

3.2 后置处理

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

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

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

3.3 完成后处理

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

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

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

4 拦截器链配置

问题导入

什么是拦截器链？

4.1 多个拦截器配置

• 定义第二个拦截器

public class BookInterceptor2 implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("拦截器2：前置通知");
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("拦截器2：后置通知");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("拦截器2：最终通知");
    }
}

• 配置第二个拦截器

@Configuration
//同时扫描控制器和配置类所在的包
@ComponentScan({"com.itheima.controller","com.itheima.config"})
@EnableWebMvc
public class SpringMvcConfig implements WebMvcConfigurer {

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

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

执行效果

拦截器1：前置通知
拦截器2：前置通知
查找书籍
拦截器2：后置通知
拦截器1：后置通知
拦截器2：最终通知
拦截器1：最终通知

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

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