系列五、拦截器_methodinterceptor handlerinterceptor-优快云博客

本文详细介绍了Spring框架中的拦截器（HandlerInterceptor和MethodInterceptor）及其使用，比较了与Filter的区别，包括触发时机、功能范围和应用场景，并提供了示例代码和配置方法。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

一、简介

1.1、概述

拦截器是Spring中的概念，和过滤器类似，可以对用户的请求进行拦截处理。但是相对于过滤器而言拦截器控制的粒度更细一些，拦截器可以在三个地方进行执行，即：

preHandle: 在请求到达Controller控制器之前，通过拦截器执行一段代码；
postHandle: 在控制器执行之后，通过拦截器执行一段代码，此时Controller执行完毕，视图还没有开始渲染；
afterCompletion: 在整个请求结束的时候，通过拦截器执行一段代码；

1.2、流程图

1.3、拦截器分类

HandlerInterceptor、MethodInterceptor。

1.4、HandlerInterceptor

1.4.1、概述

HandlerInterceptor 是SpringMVC中的拦截器，它拦截的目标是请求的地址，相较于MethodInterceptor，HandlerInterceptor的优先级更高，即：项目中如果同时配置了HandlerInterceptor 和 MethodInterceptor，HandlerInterceptor会先执行。

1.4.2、实现步骤

（1）写一个类实现 HandlerInterceptor 接口；

（2）注册为bean（加入ioc容器）；

（3）在mvc的配置类中注册拦截器；

/**
 * @Author : 一叶浮萍归大海
 * @Date: 2023/12/7 13:04
 * @Description:
 */
@Slf4j
public class MyHandlerInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest httpServletRequest, HttpServletResponse response, Object handler) throws Exception {
        
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        
    }
}

/**
 * @Author : 一叶浮萍归大海
 * @Date: 2023/12/7 14:03
 * @Description: 将【继承 or 实现】第三方接口的类注入ioc容器
 */
@Configuration
public class MyExtendConfig {

    /**
     * 将自定义的拦截器加入ioc容器
     * @return
     */
    @Bean
    public MyHandlerInterceptor myHandlerInterceptor() {
        MyHandlerInterceptor myHandlerInterceptor = new MyHandlerInterceptor();

        return myHandlerInterceptor;
    }
}

/**
 * @Author : 一叶浮萍归大海
 * @Date: 2023/12/7 13:11
 * @Description: 自定义mvc配置
 */
@Configuration
public class MyWebMvcConfigurer implements WebMvcConfigurer {

    @Resource
    private MyHandlerInterceptor myHandlerInterceptor;

    /**
     * 注册自定义的拦截器
     * @param registry
     * 注意事项：
     *      addPathPatterns("/**")：拦截所有
     *      excludePathPatterns("/user/*")：放行以/user打头的请求
     *      excludePathPatterns("/helloWorld")：放行/helloWorld请求
     */
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry
                .addInterceptor(myHandlerInterceptor)
                .addPathPatterns("/**")
                .excludePathPatterns("/helloWorld")
                .order(1);
    }
}

1.5、MethodInterceptor

1.5.1、概述

MethodInterceptor是spring aop中的拦截器，它拦截的是目标方法。

1.5.2、实现步骤

        （1）自定义MethodInterceptor（实现）；

        （2）自定义注解；

        （3）匹配自定义注解中的方法（继承StaticMethodMatcherPointcut）；

        （4）自定义AbstractBeanFactoryPointcutAdvisor（继承）

        （5）将【MyStaticMethodMatcherPointcut、MyAbstractBeanFactoryPointcutAdvisor】加入 spring ioc 容器管理；

（6）要拦截的方法上添加自定义注解；

/**
 * @Author : 一叶浮萍归大海
 * @Date: 2023/12/7 13:19
 * @Description:
 */
@Slf4j
public class MyMethodInterceptor implements MethodInterceptor {

    @Override
    public Object invoke(MethodInvocation invocation) throws Throwable {
        log.info("MyMethodInterceptor invoke executed!");
        String methodName = invocation.getMethod().getName();
        List<Object> args = Arrays.asList(invocation.getArguments());
        log.info("MyMethodInterceptor invoke methodName:{},args:{}", methodName, args);
        // 说明：invocation.proceed()如果不执行的话，则被拦截的方法不被执行
        return invocation.proceed();
    }
}

/**
 * @Author : 一叶浮萍归大海
 * @Date: 2023/12/7 13:54
 * @Description:
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
public @interface InterceptorAnnotation {

    String value() default "";

}

/**
 * @Author : 一叶浮萍归大海
 * @Date: 2023/12/7 13:55
 * @Description: 匹配被 InterceptorAnnotation 注解的方法
 */
public class MyStaticMethodMatcherPointcut extends StaticMethodMatcherPointcut {

    @Override
    public boolean matches(Method method, Class<?> targetClass) {
        Method specificMethod = AopUtils.getMostSpecificMethod(method, targetClass);
        AnnotationAttributes attributes = AnnotatedElementUtils.findMergedAnnotationAttributes(specificMethod, InterceptorAnnotation.class, false, false);
        return attributes != null;
    }
}

/**
 * @Author : 一叶浮萍归大海
 * @Date: 2023/12/7 13:57
 * @Description:
 */
public class MyAbstractBeanFactoryPointcutAdvisor extends AbstractBeanFactoryPointcutAdvisor {

    private final MyStaticMethodMatcherPointcut pointcut;

    public MyAbstractBeanFactoryPointcutAdvisor(MyStaticMethodMatcherPointcut pointcut) {
        this.pointcut = pointcut;
    }

    @Override
    public Pointcut getPointcut() {
        return pointcut;
    }
}

/**
 * @Author : 一叶浮萍归大海
 * @Date: 2023/12/7 14:03
 * @Description: 将【继承 or 实现】第三方接口的类注入ioc容器
 */
@Configuration
public class MyExtendConfig {

    /**
     * 将自定义的【MyHandlerInterceptor】加入spring ioc容器
     * @return
     */
    @Bean
    public MyHandlerInterceptor myHandlerInterceptor() {
        MyHandlerInterceptor myHandlerInterceptor = new MyHandlerInterceptor();

        return myHandlerInterceptor;
    }

    /**
     * 将自定义的【MyStaticMethodMatcherPointcut】加入spring ioc容器
     * @return
     */
    @Bean
    public MyStaticMethodMatcherPointcut matcherPointcut() {
        return new MyStaticMethodMatcherPointcut();
    }

    /**
     * 将自定义的【MyAbstractBeanFactoryPointcutAdvisor】加入spring ioc容器
     * @return
     */
    @Bean
    public MyAbstractBeanFactoryPointcutAdvisor pointcutAdvisor() {
        MyAbstractBeanFactoryPointcutAdvisor pointcutAdvisor = new MyAbstractBeanFactoryPointcutAdvisor(matcherPointcut());
        // 注册拦截器
        pointcutAdvisor.setAdvice(new MyMethodInterceptor());
        return pointcutAdvisor;
    }

}

/**
 * @Author : 一叶浮萍归大海
 * @Date: 2023/12/7 9:00
 * @Description:
 */
@Slf4j
@Service
public class LoginService {

    @InterceptorAnnotation
    public void login(UserDTO param) {
        log.info("LoginService login param:{}", param);
    }

}

1.5.3、参考

https://zhuanlan.zhihu.com/p/608791648

1.6、过滤器 vs 拦截器

1.6.1、区别

        （1）触发时机不一样，过滤器是在请求进入容器后Servlet之前进行预处理的，请求结束返回也是，是在Servlet处理完后，返回给前端之前；

        （2）过滤器可以对几乎所有的请求起作用，拦截器只能对action请求起作用；

        （3）过滤器不能访问action的上下文，而拦截器可以；

        （4）过滤器依赖于Servlet容器，拦截器不依赖；

        （5）过滤器是基于函数回调，而拦截器是基于Java的反射机制；

1.6.2、应用场景

过滤器应用场景：

        （1）过滤敏感词汇；

        （2）设置字符编码；

        （3）URL级别的权限访问控制；

        （4）压缩响应信息；

拦截器应用场景：

        （1）登录验证：判断用户是否登录；

        （2）权限验证：判断用户是否有权限访问资源，如校验Token；

        （3）日志记录：记录请求操作日志（用户的IP、访问时间等），以便统计请求访问量；

        （4）处理Cookie、本地化、国际化、主题等；

        （5）性能监控：监控请求处理时长；

        （6）通用行为：读取cookie得到用户信息并将用户对象放入请求，从而方便后续流程使用，还有如提取Locale、Theme信息等，只要是多个处理器都需要的即可使用拦截器实现；

1.6.3、参考

https://blog.youkuaiyun.com/weixin_44830949/article/details/127493342
 
https://zhuanlan.zhihu.com/p/484289805?utm_id=0