Spring学习笔记(7)一Spring MVC拦截器

爱被打了一巴掌 2022-09-26 01:45 182阅读 0赞

# 一、什么是拦截器 #

--------------------

Spring MVC中的拦截器（Interceptor）类似于Servlet中的过滤器（Filter），它主要用于拦截用户请求并作相应的处理。例如通过拦截器可以进行权限验证、记录请求信息的日志、判断用户是否登录等。

要使用Spring MVC中的拦截器，就需要对拦截器类进行定义和配置。通常拦截器类可以通过两种方式来定义。  
1.通过实现HandlerInterceptor接口，或继承HandlerInterceptor接口的实现类如HandlerInterceptorAdapter来定义。  
2.通过实现WebRequestInterceptor接口，或继承WebRequestInterceptor接口的实现类来定义。

以实现HandlerInterceptor接口方式为例，自定义拦截器类的代码如下：

public class CustomInterceptor implements HandlerInterceptor{
            public boolean preHandle(HttpServletRequest request, 
                                     HttpServletResponse response, Object handler)throws Exception {
                return false;
            }
            public void postHandle(HttpServletRequest request, 
                                   HttpServletResponse response, Object handler,
                                   ModelAndView modelAndView) throws Exception {
                
            }
            public void afterCompletion(HttpServletRequest request,
                                        HttpServletResponse response, Object handler,
                                        Exception ex) throws Exception {
            }
        }

上述代码中，自定义拦截器实现了HandlerInterceptor接口，并实现了接口中的三个方法：

*  **preHandle() 方法：**该方法会在控制器方法前执行，其返回值表示是否中断后续操作。当其返回值为true时，表示继续向下执行；  
    当其返回值为false时，会中断后续的所有操作（包括调用下一个拦截器和控制器类中的方法执行等）。
 *  **postHandle()方法：**该方法会在控制器方法调用之后，且解析视图之前执行（DispatcherServlet渲染ModelAndView视图之前）。可以通过此方法对请求域中的模型和视图做出进一步的修改。
 *  **afterCompletion()方法：**该方法会在整个请求完成，即视图渲染结束之后执行（DispatcherServlet渲染了ModelAndView视图之后）。可以通过此方法实现一些资源清理、记录日志信息等工作。

# 二、拦截器配置 #

--------------------

开发拦截器就像开发servlet或者filter一样，都需要在配置.

## 1、web.xml中注册拦截器 ##

文件进行配置，配置代码如下：

<mvc:interceptors>
            
            
            <mvc:interceptor>
                
                <mvc:mapping path="/**"/>
                <mvc:exclude-mapping path=""/>
                
                <bean class="com.ma.interceptor.Intercptor1"/>
            </mvc:interceptor>
            
            <mvc:interceptor>
                <mvc:mapping path="/hello"/>
                <bean class="com.ma.interceptor.Interceptor2"/>
            </mvc:interceptor>

上面的代码中，<mvc:interceptors>元素用于配置一组拦截器，基子元素<bean>中定义的是全局拦截器，它会拦截所有的请求；而<mvc:interceptor>元素中定义的是指定路径的拦截器，它会对指定路径下的请求生效。<mvc:interceptor>元素的子元素<mvc:mapping>用于配置拦截器作用的路径，该路径在其属性path 中定义。如上述代码中 path 的属性值“/\*\*” 表示拦截所有路径，“/hello” 表示拦截所有以 “/hello” 结尾的路径。如果在请求路径中包含不需要拦截的内容，还可以通过<mvc:exclude-mapping>元素进行配置。

>   
> **注意：<mvc:interceptor>中的子元素必须按照上述代码中的配置顺序进行编写，即<mvc:mapping> <mvc:exclude-mapping> <bean>，否则文件会报错。**

## 2、springboot使用拦截器 ##

**1)、实现接口HandlerInterceptor**, 使用@Component注解让spring boot识别拦截类

package com.demo.springboot2.web.service;
    
    import org.springframework.web.servlet.HandlerInterceptor;
    import javax.servlet.http.HttpServletRequest;
    import javax.servlet.http.HttpServletResponse;
    import javax.servlet.http.HttpSession;
    import org.springframework.stereotype.Component;
    @Component
    public class DemoInterceptor1 implements HandlerInterceptor{
        @Override
        public boolean preHandle(HttpServletRequest request,
                                 HttpServletResponse response, Object handler)throws Exception {
            return false;
        }
    
        public void postHandle(HttpServletRequest request,
                               HttpServletResponse response, Object handler,
                               Object arg2) throws Exception {
            System.out.println("************DemoInterceptor1 postHandle executed**********");
    
        }
        @Override
        public void afterCompletion(HttpServletRequest request,
                                    HttpServletResponse response, Object handler,
                                    Exception ex) throws Exception {
        }
    }

2、在WebConfigurer中注入拦截器

**实现接口HandlerInterceptor**之后，并不能直接使用，需要在配置类里面进行配置。同时修改配置继`WebMvcConfigurerAdapter`,然后覆盖`addInterceptors`方法。  
首先将 DemoInterceptor1注入到 WebConfigurer 中。然后在 WebConfigurer 中的 addInterceptors 中`注册`拦截器，使其生效。

package com.demo.springboot2.web.service;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
    import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
    import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
    
    @Configuration
    public class WebConfigurer implements WebMvcConfigurer {
    
        @Autowired
        private DemoInterceptor1 demoInterceptor1;
    
        @Autowired
        private DemoInterceptor2 demoInterceptor2;
    
        // 这个方法是用来配置静态资源的，比如html，js，css，等等
        @Override
        public void addResourceHandlers(ResourceHandlerRegistry registry) {
        }
    
        // 这个方法用来注册拦截器，我们自己写好的拦截器需要通过这里添加注册才能生效
        @Override
        public void addInterceptors(InterceptorRegistry registry) {
            // addPathPatterns("/**") 表示拦截所有的请求，
            // excludePathPatterns("/login", "/register") 表示除了登陆与注册之外，因为登陆注册不需要登陆也可以访问
            registry.addInterceptor(demoInterceptor1).addPathPatterns("/**").excludePathPatterns("/**");
            registry.addInterceptor(demoInterceptor2).addPathPatterns("/**").excludePathPatterns("/**");
        }
    }

# 三. 拦截器的执行流程 #

--------------------

## 2.1 单个拦截器的执行流 ##

在运行程序时，拦截器的执行是有一定顺序的，该顺序与配置文件中所定义的拦截器的顺序相关。  
单个拦截器，在程序中的执行流程如下图所示：

![20200703222255726.png][]

1.程序先执行preHandle()方法，如果该方法的返回值为true，则程序会继续向下执行处理器中的方法，否则将不再向下执行。

2.在业务处理器（即控制器Controller类）处理完请求后，会执行postHandle()方法，然后会通过DispatcherServlet向客户端返回响应。

3.在DispatcherServlet处理完请求后，才会执行afterCompletion()方法。

测试案例：  
通过一个测试程序来验证它的执行流程。  
新建一个web项目，准备好SpringMVC程序运行所需要的JAR包，在web.xml中配置前端过虑器和初始化加载信息。  
新建一个测试controller，代码如下：

@Controller
    public class HelloController {
    
        @RequestMapping("/hello")
        public String Hello() {
            System.out.println("Hello!");
            return "success";
        }
    }

然后，新建一个拦截器，实现HandlerInterceptor接口，并实现其中的方法。

/**
     * @author mz
     * @version V1.0
     * @Description: 实现了HandlerInterceptor接口的自定义拦截器类
     */
    public class CustomeInterceptor implements HandlerInterceptor {
        @Override
        public boolean preHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o)
                throws Exception {
            System.out.println("CustomInterceptor....preHandle");
            //对浏览器的请求进行放行处理
            return true;
        }
    
        @Override
        public void postHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, ModelAndView modelAndView)
                throws Exception {
            System.out.println("CustomInterceptor....postHandle");
        }
    
        @Override
        public void afterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e)
                throws Exception {
            System.out.println("CustomInterceptor....afterCompletion");
        }
    }

在配置文件中配置拦截器。

把项目发布到tomcat中，运行测试：  
![format_png][]

## 2.2 多个拦截器的执行流程 ##

多个拦截器（假设有两个拦截器Interceptor1和Interceptor2，并且在配置文件中， Interceptor1拦截器配置在前），在程序中的执行流程如下图所示：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hndWlzdQ_size_16_color_FFFFFF_t_70][]

从图可以看出，当有多个拦截器同时工作时，它们的preHandle()方法会按照配置文件中拦截器的配置顺序执行，而它们的postHandle()方法和afterCompletion()方法则会按照配置顺序的反序执行。  
测试案例：  
新建两个拦截器：

/**
     * @author mz
     * @version V1.0
     * @Description: 第一个拦截器
     */
    public class Intercptor1 implements HandlerInterceptor {
        @Override
        public boolean preHandle(HttpServletRequest httpServletRequest,
                                 HttpServletResponse httpServletResponse, Object o) throws Exception {
            System.out.println("Interceptor1....preHandle");
            return true;
        }
    
        @Override
        public void postHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, ModelAndView modelAndView) throws Exception {
            System.out.println("Interceptor1....postHandle");
        }
    
        @Override
        public void afterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) throws Exception {
            System.out.println("Interceptor1....afterCompletion");
        }

/**
     * @author mz
     * @version V1.0
     * @Description: 第二个拦截器
     */
    public class Interceptor2 implements HandlerInterceptor {
        @Override
        public boolean preHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o) throws Exception {
            System.out.println("Interceptor2....preHandle");
            return true;
        }
    
        @Override
        public void postHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, ModelAndView modelAndView) throws Exception {
            System.out.println("Interceptor2....postHandle");
        }
    
        @Override
        public void afterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) throws Exception {
            System.out.println("Interceptor2....afterCompletion");
        }
    }

添加配置信息：

<mvc:interceptor>
                
                <mvc:mapping path="/**"/>
                
                <bean class="com.ma.interceptor.Intercptor1"/>
            </mvc:interceptor>
            
            <mvc:interceptor>
                <mvc:mapping path="/hello"/>
                <bean class="com.ma.interceptor.Interceptor2"/>
            </mvc:interceptor>

测试运行：  
![format_png 1][]  
从结果可以看出，执行的顺序和图片中是一样的。

如果第一个拦截器return true; 而第二个拦截器 return false;结果如下：  
![format_png 2][]

## 小结 ##

首先学习如何在Spring MVC项目中定义和配置拦截器，然后了解单个拦截器和多个拦截器的执行流程。

[20200703222255726.png]: /images/20220717/6a0252b532f246f5989ce345cd3fb656.png
[format_png]: /images/20220717/a22ad62f79cf41bfa15fbcf24b304286.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hndWlzdQ_size_16_color_FFFFFF_t_70]: /images/20220717/eeec7687d3b54c458d68ae3311aae236.png
[format_png 1]: /images/20220717/1555a4a5a68549ffa296a960d801ba55.png
[format_png 2]: /images/20220717/b858b449f13c4565be9f0b9fad7705f9.png