SpringMVC(四)

目录

九.拦截器

9.1 拦截器概念

9.2 拦截器的使用步骤

9.3 拦截器的执行流程

9.4 静态资源放行

9.4 拦截器参数

9.4.1 前置处理方法

9.4.2 后置处理方法

9.4.3 完成处理方法

9.5 拦截器链配置

9.5.1 配置多个拦截器

9.5.2 拦截器链中拦截器的执行顺序

---

九.拦截器

9.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的访问进行增强

9.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("preHandle...");
        return true;
    }
​
    @Override
    //原始方法调用后执行的内容
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("postHandle...");
    }
​
    @Override
    //原始方法调用完成后执行的内容
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("afterCompletion...");
    }
}

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

步骤2：配置拦截器类

配置拦截器类有二种方法，分别是：

• 通过继承 WebMvcConfigurationSupport 类来配置拦截器类
• 通过实现 WebMvcConfigurer 接口来配置拦截器类，但是要多加一个@EnableWebMvc注解

@Configuration
public class SpringMvcSupport extends WebMvcConfigurationSupport {
    @Autowired
    private ProjectInterceptor projectInterceptor;
​
    @Override
    protected void addInterceptors(InterceptorRegistry registry) {
        //配置拦截器
        registry.addInterceptor(projectInterceptor).addPathPatterns("/books","/books/*" );
    }
}

@Configuration
@EnableWebMvc
public class SpringMvcConfig implements WebMvcConfigurer {
    @Autowired
    private ProjectInterceptor projectInterceptor;
​
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        //配置多拦截器
        registry.addInterceptor(projectInterceptor).addPathPatterns("/books","/books/*");
    }
}

对于springboot来讲，继承WebMvcConfigure无需再加@EnableWebMvc注解。

步骤3：SpringMVC 添加 SpringMvcSupport 包扫描

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

9.3 拦截器的执行流程

1. 当有拦截器后，请求会先进入preHandle方法，
2. 如果方法返回true，则放行继续执行后面的handle[controller的方法]和后面的方法，如果返回false，则直接跳过后面方法的执行。

9.4 静态资源放行

当浏览器访问我们项目的静态资源时，必须允许其对静态资源的访问，有二种方式允许其对静态资源的访问

方式一：将静态资源放到resource文件夹下的static目录下

方式二：在配置拦截器类的地方做如下配置即可

@Configuration
public class SpringMvcSupport extends WebMvcConfigurationSupport {
    @Autowired
    private ProjectInterceptor projectInterceptor;
​
    @Override
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        //静态资源放行
        registry.addResourceHandler("/pages/**").addResourceLocations("/pages/");
    }
​
    @Override
    protected void addInterceptors(InterceptorRegistry registry) {
        //配置拦截器
        registry.addInterceptor(projectInterceptor).addPathPatterns("/books" );
    }
}

9.4 拦截器参数

9.4.1 前置处理方法

原始方法之前运行preHandle

public boolean preHandle(HttpServletRequest request,
                         HttpServletResponse response,
                         Object handler) throws Exception {
    System.out.println("preHandle");
    return true;
}

• request:请求对象

• response:响应对象

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

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

public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
    String contentType = request.getHeader("Content-Type");
    System.out.println("preHandle..."+contentType);
    return true;
}

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

public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
    HandlerMethod hm = (HandlerMethod)handler;
    String methodName = hm.getMethod().getName();//可以获取方法的名称
    System.out.println("preHandle..."+methodName);
    return true;
}

9.4.2 后置处理方法

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

public void postHandle(HttpServletRequest request,
                       HttpServletResponse response,
                       Object handler,
                       ModelAndView modelAndView) throws Exception {
    System.out.println("postHandle");
}

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

modelAndView：如果处理器执行完成具有返回结果，可以读取到对应数据与页面信息，并进行调整，因为咱们现在都是返回json数据，所以该参数的使用率不高。

9.4.3 完成处理方法

拦截器最后执行的方法，在 preHandle 返回 true 的前提下，无论原始方法是否执行，此方法都会执行，多用于清理资源。

public void afterCompletion(HttpServletRequest request,
                            HttpServletResponse response,
                            Object handler,
                            Exception ex) throws Exception {
    System.out.println("afterCompletion");
}

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

ex：如果处理器执行过程中出现异常对象，可以针对异常情况进行单独处理。因为我们现在已经有全局异常处理器类，所以该参数的使用率也不高。

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

9.5 拦截器链配置

9.5.1 配置多个拦截器

步骤1：创建拦截器类

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

@Component
public class ProjectInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("preHandle...");
        return true;
    }
​
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("postHandle...");
    }
​
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("afterCompletion...");
    }
}

@Component
public class ProjectInterceptor2 implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("preHandle...222");
        return false;
    }
​
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("postHandle...222");
    }
​
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("afterCompletion...222");
    }
}

步骤2：配置拦截器类

@Configuration
@ComponentScan({"com.itheima.controller"})
@EnableWebMvc
//实现WebMvcConfigurer接口可以简化开发，但具有一定的侵入性
public class SpringMvcConfig implements WebMvcConfigurer {
    @Autowired
    private ProjectInterceptor projectInterceptor;
    @Autowired
    private ProjectInterceptor2 projectInterceptor2;
​
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        //配置多拦截器
        registry.addInterceptor(projectInterceptor).addPathPatterns("/books","/books/*");
        registry.addInterceptor(projectInterceptor2).addPathPatterns("/books","/books/*");
    }
}

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

9.5.2 拦截器链中拦截器的执行顺序

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

• 拦截器链的运行顺序是和配置顺序有关，先配置的拦截器的 preHandle 方法先执行，postHandle和afterCompletion方法后执行。

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

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