SpringMVC 拦截器详解

短命女 2024-03-22 22:02 69阅读 0赞

**目录**

一、介绍

二、过滤器与拦截器的简单对比

三、自定义拦截器

四、注册拦截器

五、案例演示-登录拦截器

5.1 自定义拦截器

5.2 注册拦截器

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

**编写的初衷是为了自己巩固复习，如果能帮到你将是我的荣幸❣️**

## 一、介绍 ##

*  SpringMVC提供的拦截器类似于JavaWeb中的过滤器，只不过SpringMVC拦截器只拦截被前端控制器拦截的请求，即拦截控制器方法的执行，而过滤器拦截从前端发送的任意请求。
 *  熟练掌握SpringMVC拦截器对于我们开发非常有帮助，在没使用权限框架(shiro，spring security)之前，一般使用拦截器进行认证和授权操作。
 *  SpringMVC拦截器有许多应用场景，比如：登录认证拦截器，字符过滤拦截器，日志操作拦截器等等。

## 二、过滤器与拦截器的简单对比 ##

> 过滤器

*  依赖于servlet容器。
 *  在实现上基于函数回调，可以对几乎所有请求进行过滤，但是缺点是一个过滤器实例只能在容器初始化时调用一次。
 *  使用过滤器的目的是用来做一些过滤操作，获取我们想要获取的数据，比如：在过滤器中修改字符编码；在过滤器中修改HttpServletRequest的一些参数，包括：过滤低俗文字、危险字符等。

> 拦截器

*  依赖于web框架，在SpringMVC中就是依赖于SpringMVC框架。
 *  在实现上基于Java的反射机制，属于面向切面编程（AOP）的一种运用。
 *  由于拦截器是基于web框架的调用，因此可以使用Spring的依赖注入（DI）进行一些业务操作，同时一个拦截器实例在一个controller生命周期之内可以多次调用。
 *  但是缺点是只能对controller请求进行拦截，对其他的一些比如直接访问静态资源的请求则没办法进行拦截处理

## 三、自定义拦截器 ##

SpringMVC拦截器的实现一般有两种方式:

*  自定义的Interceptor类要实现了Spring的HandlerInterceptor接口。
 *  继承实现了HandlerInterceptor接口的类，比如Spring已经提供的实现了HandlerInterceptor接口的抽象类HandlerInterceptorAdapter。

public class LoginInterceptor implements HandlerInterceptor {
    
        @Override
        public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
            return true;
        }
    
        @Override
        public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) {}
    
        @Override
        public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {}
    }

HandlerInterceptor接口中定义了三个方法，我们就是通过这三个方法来对用户的请求进行拦截处理的。

*  preHandle()： 这个方法在Controller处理请求之前被调用，SpringMVC中的`Interceptor`是链式调用的，在一个应用中或者说是在一个请求中可以同时存在多个Interceptor 。每个Interceptor的调用会依据它的声明顺序依次执行，而且最先执行的都是Interceptor 中的preHandle方法，所以可以在这个方法中进行一些前置初始化操作或者是对当前请求的一个预处理，也可以在这个方法中进行一些判断来决定请求是否要继续进行下去。
    
    该方法的返回值是布尔值Boolean 类型的：
    
     *  当它返回为false 时，表示请求结束，后续的Interceptor和Controller都不会再执行；
     *  当返回值为true时就会继续调用下一个Interceptor的preHandle 方法，如果已经是最后一个Interceptor的时候就会是调用当前请求的Controller方法。
 *  postHandle()：这个方法在Controller方法处理当前请求之后执行，但是它会在DispatcherServlet进行视图返回渲染之前被调用，所以我们可以在这个方法中对Controller处理之后的ModelAndView对象进行操作。
    
     *  postHandle方法被调用的方向跟preHandle 是相反的，也就是说先声明的Interceptor的postHandle方法反而会后执行。
 *  afterCompletion()：这个方法也是需要当前对应的Interceptor的preHandle方法的返回值为true时才会执行。顾名思义，该方法将在整个请求结束之后，也就是在DispatcherServlet渲染了对应的视图之后执行。这个方法的主要作用是用于进行资源清理工作的。

> 拦截器流程图

**单个拦截器执行流程图**

![cfbf23ea2c434465946e3ba71c39c780.png][]

**多个拦截器执行流程图**

![d1e9c5c3e22a4b0483620eb3abecf0ec.png][]

我们可以配置多个拦截器，每个拦截器中都有三个方法。总结多个拦截器中的方法执行规律如下：

*  preHandle：Controller方法处理请求前执行，根据拦截器定义的顺序，**`正向执行`**。
 *  postHandle：Controller方法处理请求后执行，根据拦截器定义的顺序，**`逆向执行`**。需要所有的preHandle方法都返回true时才会调用。
 *  afterCompletion：View视图渲染后处理方法：根据拦截器定义的顺序，**`逆向执行`**。preHandle返回true就会调用。

## 四、注册拦截器 ##

自定义拦截器规则编写完成后，还不行，还需要写配置文件，或者配置类。

目的是让我们的拦截器知道，哪些控制器方法的访问需要执行拦截器，哪些不需要执行。

如今主流的都是springboot框架，我们就不需要写配置文件了，直接编写一个配置类搞定。

*  配置类需要实现**WebMvcConfigurer**接口，或者继承它的实现类**WebMvcConfigurerAdapter**
 *  然后重写里面的**addInterceptors**添加拦截器方法，具体需要添加哪个拦截器，拦截哪些路径，不拦截哪些路径，都在这里配置。

## 五、案例演示-登录拦截器 ##

接下来编写一个登录拦截器，这个拦截器可以实现认证操作。就是当我们还没有登录的时候，如果发送请求访问我们系统资源时，拦截器不放行，请求失败。只有登录成功后，拦截器放行，请求成功。登录拦截器只要在preHandle()方法中编写认证逻辑即可，因为是在请求执行前拦截。代码实现如下：

### 5.1 自定义拦截器 ###

/**
     *  登录拦截器
     */
    @Slf4j
    public class LoginInterceptor implements HandlerInterceptor {
    
        @Override
        public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
            Object user = request.getSession().getAttribute("user");
            if (user == null){
                log.info("当前无用户登录，拦截此次请求");
                response.setHeader("content-type","text/html;charset=UTF-8");//指定编码，防止乱码
                response.getWriter().write(JSON.toJSONString(Result.fail(50004,"当前无用户登录，无法访问")));
                return false;
            }else {
                log.info("当前{} 号用户已登录，放行",user);
                return true;
            }
        }
    }

### 5.2 注册拦截器 ###

@Configuration
    public class WebMVCConfig implements WebMvcConfigurer {
        @Override
        public void addInterceptors(InterceptorRegistry registry) {
            registry.addInterceptor(new LoginInterceptor())
                	.addPathPatterns("/**") // 对所有的路径都进行拦截
                    .excludePathPatterns("/common/login");
        }
    }

> 说明：

.addPathPatterns("/**")   对所有的路径都进行拦截
    .excludePathPatterns("/common/login"，"/swagger-ui.html/*");  对这两条路径进行了放行，前提是这两个路径要存在对应的控制器方法。否则一旦被添加到addPathPatterns中的路径拦截到了，即使excludePathPatterns方法放行了，也无法放行。

[cfbf23ea2c434465946e3ba71c39c780.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/db5ca6317a5e4000909182a5d47cf0c2.png
[d1e9c5c3e22a4b0483620eb3abecf0ec.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/0edb44010edd4f20a5dbac9059b67c19.png