如何使用HandlerInterceptorAdapter拦截器

目录

前言

一、什么是拦截器

二、使用步骤

---

前言

本文希望以最简明的方式说明如何使用拦截器

---

一、什么是拦截器

拦截器是面向切面编程的使用，利用AOP的思想来集中处理一类事情。关于AOP的理解可查看什么是AOP（面向切面编程）-CSDN博客https://blog.csdn.net/u011529483/article/details/141865235?spm=1001.2014.3001.5501

Spring MVC的拦截器使用需要继承HandlerInterceptorAdapter类，在请求到达Controller之前执行拦截器的流程。然后重写父类的3个方法：

preHandle()：预处理方法，请求进来预先执行的拦截处理逻辑写在里面。返回true继续执行完所有拦截器的preHandle()方法后到达Controller，返回false时停止后续拦截器的preHandle()方法执行。

---

postHandle：后处理方法，此时得到了ModelAndView，但未进行页面渲染，此时还可以对ModelAndView进行修改。

---

afterCompletion：在请求处理完毕后执行，即得到了请求页面之后。

二、使用步骤

1. 新建springMVC项目

springmvc项目新建并运行成功后。（我的示例项目沿用记Spring HTTP Invoker远程调用的使用（一）基于Url映射方式，DispatcherServlet统一处理实现-CSDN博客https://blog.csdn.net/u011529483/article/details/141678510?spm=1001.2014.3001.5501）文章中的项目。

2. 新建ProtectionInterceptor.java类

实现一个记录执行时间的拦截器。

package com.wqbr.showebsite.handler;

import org.springframework.stereotype.Component;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;

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

/**
 *
 * @author lv
 * @date 2024年8月30日
 *
 */
@Component
public class ProtectionInterceptor extends HandlerInterceptorAdapter {
    private long currentTimeMillis;
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        currentTimeMillis= System.currentTimeMillis();
        System.out.println("preHandle方法执行-------"+request.getRequestURI());
        return true;
    }
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("postHandle方法执行。。。-"+request.getRequestURI());
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        currentTimeMillis=System.currentTimeMillis()-currentTimeMillis;
        System.out.println("afterCompletion 方法执行====****"+request.getRequestURI()+"耗时时间："+currentTimeMillis);
    }
}

3. 配置springmvc.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:mvc="http://www.springframework.org/schema/mvc"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="
http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/mvc
http://www.springframework.org/schema/mvc/spring-mvc.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context.xsd">

    <!--配置spring创建容器时要扫描的包-->
    <!-- use-default-filters 属性不写默认是为true,表示使用默认的过滤器规则
    use-default-filters="false"表示不扫描base-package指定下的所有java类，并不将注解annotation标注的类注册成IOC容器的bean。
    use-default-filters="true"表示扫描base-package指定下的所有java类，并将注解annotation标注的类注册成IOC容器的bean。
    要注意的是：若使用include-filter去定制扫描内容，要在use-default-filters="false"的情况下，不然会“失效”，被默认的过滤机制所覆盖
    <context:exclude-filter>：与<context:include-filter> 相反,用来告知哪些类不需要注册成Spring Bean，
    同样注意的是：在use-default-filters="false"的情况下，exclude-filter是针对include-filter里的内容进行排除。
    base-package="com.wqbr.wqdemotwo.controller"
    -->
    <context:component-scan base-package="com.wqbr.showebsite">
        <!--include-filter设置只扫描Controller注解的类-->
        <!--<context:include-filter type="annotation" expression="org.springframework.stereotype.Controller"/>-->
    </context:component-scan>

    <!--处理映射器-->
    <bean class="org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping"/>
    <!--处理器适配器-->
    <bean class="org.springframework.web.servlet.mvc.SimpleControllerHandlerAdapter"/>

    <!--配置JSP视图解析器-->
    <bean id="internalResourceViewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
        <property name="prefix" value="/"></property> <!--规定跳转页面路径的前缀-->
        <property name="suffix" value=".jsp"></property> <!--规定跳转页面的后缀-->
    </bean>

    <!-- 配置spring开启注解mvc的支持  默认就是开启的 ，要想让其他组件（不包含映射器、适配器、处理器）生效就必须需要配置了-->
    <mvc:annotation-driven/>
    <!-- 让默认servlet处理静态资源。将springMVC不能处理的请求交给servlet，一般用来放行静态资源 -->
    <mvc:default-servlet-handler/>

    <!-- 拦截器 -->
    <mvc:interceptors>
        <mvc:interceptor>
            <mvc:mapping path="/**"/>
            <bean class="com.wqbr.showebsite.handler.ProtectionInterceptor" />
        </mvc:interceptor>
    </mvc:interceptors>

</beans>

一定注意指定你的自定义拦截器 和 配置spring容器扫描加载到你的拦截器：

<!--配置spring创建容器时要扫描的包-->
<context:component-scan base-package="com.wqbr.showebsite">
</context:component-scan>

<!-- 拦截器 -->
<mvc:interceptors>
    <mvc:interceptor>
        <mvc:mapping path="/**"/>
        <bean class="com.wqbr.showebsite.handler.ProtectionInterceptor" />
    </mvc:interceptor>
</mvc:interceptors>

拦截器的使用已经配置完毕，下面我们来运行项目试试效果。

MyTestController.java控制器的代码也贴出方便查看测试结果：

运行项目后的页面：

 点击【入门程序】发出请求后，控制台打印执行顺序结果如下：

完，谢谢！