SpringMVC拦截器实现原理

最新推荐文章于 2024-06-04 23:24:10 发布

程序员小王java

最新推荐文章于 2024-06-04 23:24:10 发布

阅读量1.8k

点赞数 5

分类专栏： SpringMVC 文章标签：阿里云数据库 tomcat springmvc

程序员小王

本文链接：https://blog.csdn.net/weixin_44385486/article/details/121496829

版权

SpringMVC 专栏收录该内容

14 篇文章 3 订阅

订阅专栏

SpringMVC拦截器实现原理

一、什么是拦截器？

Spring MVC中的拦截器（Interceptor ）类似于Servlet中的过滤器（Filter ），它主要用于拦截用户请求并作相应的处理。

例如：通过拦截器可以进行权限验证、记录请求信息的日志、判断用户是否登录 ，你不登录账号,就没法查看购物车里面有什么物品 等。

要使用Spring MVC中的拦截器，就需要对拦截器类进行定义和配置。通常拦截器类可以通过两种方式来定义。

1.通过实现HandlerInterceptor接口，或继承HandlerInterceptor接口的实现类（如HandlerInterceptorAdapter）来定义。
2.通过实现WebRequestInterceptor接口，或继承WebRequestInterceptor接口的实现类来定义。

二、开发一个拦截器

1、实现 HandlerInterceptor 接口

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

/**
 * @author 王恒杰
 * @date 2021/11/23 10:25
 * @Description:处理器拦截器
 */
public class MyInterceptor implements HandlerInterceptor {
    /**
     * 在 handler 方法执行之前,运行里面的代码,可以用于用户的登录验证.
     * @param httpServletRequest
     * @param httpServletResponse
     * @param o
     * @return
     * @throws Exception
     */
    @Override
    public boolean preHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o) throws Exception {
        return false;
    }

    /**
     * 在 handler方法执行中,返回 ModelAndView 之前运行里面的代码,可以向页面提供共用的数据.
     * @param httpServletRequest
     * @param httpServletResponse
     * @param o
     * @param modelAndView
     * @throws Exception
     */
    @Override
    public void postHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, ModelAndView modelAndView) throws Exception {

    }

    /**
     * 在 handler 方法执行之后,运行里面的代码,可以进行异常处理,计算执行时间,记录日志.
     * @param httpServletRequest
     * @param httpServletResponse
     * @param o
     * @param e
     * @throws Exception
     */
    @Override
    public void afterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) throws Exception {

    }
}

定义一个拦截类,实现 HandlerInterceptor 接口,这里面一共有三个方法,

（1）preHandle 方法:

在 handler 方法执行之前,运行里面的代码,可以用于用户的登录验证.

（2）postHandle 方法:

在 handler 方法执行中,返回 ModelAndView 之前运行里面的代码,可以向页面提供共用的数据.

（3）afterCompletion 方法:

在 handler 方法执行之后,运行里面的代码,可以进行异常处理,计算执行时间,记录日志.

2、拦截器的配置

开发拦截器就像开发servlet或者filter一样，都需要在配置文件进行配置，配置代码如下：

    <mvc:interceptors>
        <!--配置拦截器-->
        <mvc:interceptor>
            <!--配置烂机器的作用路径-->
            <mvc:mapping path="/**"/>
            <mvc:exclude-mapping path=""/>
            <!--定义在<mvc:interceptor>下面的表示匹配指定路径的请求才进行拦截-->
            <bean class="com.tjcu.intercepter.MyInterceptor"></bean>
        </mvc:interceptor>
    </mvc:interceptors>

<!--
上面的代码中，mvc:interceptors元素用于配置一组拦截器
mvc:interceptor元素中定义的是指定路径的拦截器，它会对指定路径下的请求生效。
mvc:interceptor元素的子元素
    mvc:mapping用于配置拦截器作用的路径，该路径在其属性path 中定义。
    如上述代码中 path 的属性值“/**” 表示拦截所有路径，“/user” 表示拦截所有以 “/user” 结尾的路径。
    如果在请求路径中包含不需要拦截的内容，还可以通过mvc:exclude-mapping元素进行配置。
    注意：mvc:interceptor中的子元素必须按照上述代码中的配置顺序进行编写，
    即mvc:mapping mvc:exclude-mapping <bean>，否则文件会报错。
-->

上面的代码中，mvc:interceptors元素用于配置一组拦截器

mvc:interceptor元素中定义的是指定路径的拦截器，它会对指定路径下的请求生效。

mvc:interceptor元素的子元素

mvc:mapping用于配置拦截器作用的路径，该路径在其属性path 中定义。

如上述代码中 path 的属性值“/**” 表示拦截所有路径，“/user” 表示拦截所有以 “/user” 结尾的路径。

如果在请求路径中包含不需要拦截的内容，还可以通过mvc:exclude-mapping元素进行配置。

注意：mvc:interceptor中的子元素必须按照上述代码中的配置顺序进行编写，

即mvc:mapping——》mvc:exclude-mapping——》 <bean>，否则文件会报错。

三、拦截器的执行流程

1、单个拦截器的执行流程

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

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

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

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

（1）案例:Springmvc和Ajax交互通过id查询用户

新建一个web项目，准备好SpringMVC程序运行所需要的依赖，在web.xml中配置前端过虑器和初始化加载信息。

前端页面，代码如下：

  <%--
  User: 王恒杰
  Date: 2021/11/22
  --%>
<%@ page contentType="text/html;charset=UTF-8" language="java" isELIgnored="false" %>
<html>
<head>
    <script type="text/javascript" src="${pageContext.request.contextPath}/js/jquery-1.8.3.min.js"></script>
    <script>
        $(function () {
            $("#del").click(function () {
                $.get("${pageContext.request.contextPath}/user/showById?id=" + $("input[name='id']").val(), function (result) {
                    console.log(result);
                    // 创建ul标签
                    var ul = $("<ul></ul>");
                    //    创建li当前获取到的值
                    var idLi = $("<li>" + result.id + "</li>");
                    var usernameLi = $("<li>" + result.username + "</li>");
                    var passwordLi = $("<li>" + result.password + "</li>");
                    var salaryLi = $("<li>" + result.salary + "</li>");
                    var birthdayLi = $("<li>" + result.birthday + "</li>");
                //    将li子标签添加到ul上
                    ul.append(idLi);
                    ul.append(usernameLi);
                    ul.append(passwordLi);
                    ul.append(salaryLi);
                    ul.append(birthdayLi);
                    $("#body").append(ul)
                }, "json");
            })
        })
    </script>
</head>
<body id="body">

ID：<input type="text" name="id" placeholder="请输入用户的ID">
<input type="button" name="id" value="提交" id="del">
</body>
</html>

新建一个测试controller，代码如下：

/**
 * @author 王恒杰
 * @date 2021/11/22 20:37
 * @Description:
 */
@Controller
@RequestMapping("user")
public class QueryUser {

    @RequestMapping("showById")
    public  @ResponseBody User showUserById(HttpServletResponse response,Integer id) throws IOException {

        User user1 = new User(1,"王恒杰1","123",2000d,new Date());
        User user2 = new User(2,"王恒杰2","123",20000d,new Date());
        User user3 = new User(3,"王恒杰3","123",200000d,new Date());
        User user4 = new User(4,"王恒杰4","123",2000000d,new Date());
        User user5 = new User(5,"王恒杰5","123",20000000d,new Date());
        List<User> users = Arrays.asList(user1, user2, user3, user4, user5);
        for (User user : users) {
            if(id.equals(user.getId())){
                return  user;
            }
        }
        return null;

    }

}

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

/**
 * @author 王恒杰
 * @date 2021/11/23 10:25
 * @Description:实现HandlerInterCceptor接口的自定义拦截器
 */
public class MyInterceptor implements HandlerInterceptor {
    /**
     * 在 handler 方法执行之前,运行里面的代码,可以用于用户的登录验证.
     * @param httpServletRequest
     * @param httpServletResponse
     * @param o
     * @return
     * @throws Exception
     */
    @Override
    public boolean preHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o) throws Exception {
        System.out.println("MyInterceptor preHandle 拦截器");
        //对浏览器的请求进行放行处理
        return true;
    }

    /**
     * 在 handler方法执行中,返回 ModelAndView 之前运行里面的代码,可以向页面提供共用的数据.
     * @param httpServletRequest
     * @param httpServletResponse
     * @param o
     * @param modelAndView
     * @throws Exception
     */
    @Override
    public void postHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, ModelAndView modelAndView) throws Exception {
        System.out.println("MyInterceptor postHandler 拦截器");
    }

    /**
     * 在 handler 方法执行之后,运行里面的代码,可以进行异常处理,计算执行时间,记录日志.
     * @param httpServletRequest
     * @param httpServletResponse
     * @param o
     * @param e
     * @throws Exception
     */
    @Override
    public void afterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) throws Exception {
        System.out.println("MyInterceptor afterCompletion 拦截器");
    }
}

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

   <!--1、配置组件-->
    <context:component-scan base-package="com.tjcu"></context:component-scan>

    <!--2、处理器映射器和处理器适配器-->
    <mvc:annotation-driven/>
    <!--3.视图解析器-->
    <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
        <property name="prefix" value="/"></property>
        <property name="suffix" value=".jsp"></property>
     </bean>
    <!--4.静态资源拦截器-->
    <mvc:default-servlet-handler></mvc:default-servlet-handler>
      <!--文件解析器-->
      <bean id="multipartResolver" class="org.springframework.web.multipart.commons.CommonsMultipartResolver">
        <!--控制文件上传大小单位字节 默认没有大小限制 这里是2M-->
        <property name="maxUploadSize" value="2097152"/>
    </bean>
     <!--配置拦截器-->
    <mvc:interceptors>
       <bean class="com.tjcu.interceptor.MyInterceptor"></bean>
    </mvc:interceptors>

2、多个拦截器的执行流程

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

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

第一个拦截器：

package com.tjcu.interceptor;

import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
 * @author 王恒杰
 * @date 2021/11/23 10:25
 * @Description:实现HandlerInterCceptor接口的自定义拦截器
 */
public class Interceptor1 implements HandlerInterceptor {
    /**
     * 在 handler 方法执行之前,运行里面的代码,可以用于用户的登录验证.
     * @param httpServletRequest
     * @param httpServletResponse
     * @param o
     * @return
     * @throws Exception
     */
    @Override
    public boolean preHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o) throws Exception {
        System.out.println("Interceptor1 preHandle 拦截器");
        //对浏览器的请求进行放行处理
        return true;
    }

    /**
     * 在 handler方法执行中,返回 ModelAndView 之前运行里面的代码,可以向页面提供共用的数据.
     * @param httpServletRequest
     * @param httpServletResponse
     * @param o
     * @param modelAndView
     * @throws Exception
     */
    @Override
    public void postHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, ModelAndView modelAndView) throws Exception {
        System.out.println("Interceptor1 postHandler 拦截器");
    }

    /**
     * 在 handler 方法执行之后,运行里面的代码,可以进行异常处理,计算执行时间,记录日志.
     * @param httpServletRequest
     * @param httpServletResponse
     * @param o
     * @param e
     * @throws Exception
     */
    @Override
    public void afterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) throws Exception {
        System.out.println("Interceptor1 afterCompletion 拦截器");
    }
}

第二个拦截器

package com.tjcu.interceptor;

import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
 * @author 王恒杰
 * @date 2021/11/23 10:25
 * @Description:实现HandlerInterCceptor接口的自定义拦截器
 */
public class Interceptor2 implements HandlerInterceptor {
    /**
     * 在 handler 方法执行之前,运行里面的代码,可以用于用户的登录验证.
     * @param httpServletRequest
     * @param httpServletResponse
     * @param o
     * @return
     * @throws Exception
     */
    @Override
    public boolean preHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o) throws Exception {
        System.out.println("Interceptor2 preHandle 拦截器");
        //对浏览器的请求进行放行处理
        return true;
    }

    /**
     * 在 handler方法执行中,返回 ModelAndView 之前运行里面的代码,可以向页面提供共用的数据.
     * @param httpServletRequest
     * @param httpServletResponse
     * @param o
     * @param modelAndView
     * @throws Exception
     */
    @Override
    public void postHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, ModelAndView modelAndView) throws Exception {
        System.out.println("Interceptor2 postHandler 拦截器");
    }

    /**
     * 在 handler 方法执行之后,运行里面的代码,可以进行异常处理,计算执行时间,记录日志.
     * @param httpServletRequest
     * @param httpServletResponse
     * @param o
     * @param e
     * @throws Exception
     */
    @Override
    public void afterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) throws Exception {
        System.out.println("Interceptor2 afterCompletion 拦截器");
    }
}

添加配置信息：

    <!--配置拦截器-->
    <mvc:interceptors>
      <mvc:interceptor>
          <mvc:mapping path="/**"/>
         <bean class="com.tjcu.interceptor.Interceptor1"></bean>
      </mvc:interceptor>
  <mvc:interceptor>
      <mvc:mapping path="/user/showById"/>
      <bean class="com.tjcu.interceptor.Interceptor2"></bean>
  </mvc:interceptor>
    </mvc:interceptors>

程序员小王java

关注

5
点赞
踩
8

收藏

觉得还不错? 一键收藏
打赏
2
评论
SpringMVC拦截器实现原理

SpringMVC拦截器实现原理一、什么是拦截器？Spring MVC中的拦截器（Interceptor ）类似于Servlet中的过滤器（Filter ），它主要用于拦截用户请求并作相应的处理。例如：通过拦截器可以进行权限验证、记录请求信息的日志、判断用户是否登录，你不登录账号,就没法查看购物车里面有什么物品等。要使用Spring MVC中的拦截器，就需要对拦截器类进行定义和配置。通常拦截器类可以通过两种方式来定义。1.通过实现HandlerInterceptor接口，或继承Handle
复制链接

扫一扫