Spring MVC 拦截器：HandlerInterceptor 接口

原创 已于 2025-04-27 18:16:13 修改 · 1.1k 阅读 · 18 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#spring #mvc #java #springboot #spring boot

于 2025-04-25 08:30:00 首次发布

文章目录


在 Spring MVC 中，拦截器可以在控制器的执行过程中进行预处理和后处理操作，从而对请求的处理进行控制和增强。Spring MVC 中提供 HandlerInterceptor 接口用于定义拦截器。

在 HandlerInterceptor 接口中定义了以下三个方法。

  1. preHandle：在控制器执行之前调用。

    可以在这个方法中进行一些预处理操作，比如身份验证、权限检查等。如果返回值为 true，则继续执行后续的拦截器链或进入控制器方法；如果返回值为 false，则中断请求处理流程，不执行后续的拦截器链和控制器方法。

  2. postHandle：在控制器执行之后、视图渲染之前调用。

    可以在这个方法中进行一些后处理操作，比如修改数据模型、添加额外的数据等。该方法中可以对 ModelAndView 对象进行修改。

  3. afterCompletion：在视图渲染完成之后调用。

    可以在这个方法中进行一些资源清理的操作，比如释放资源、记录日志等。可以获取到 Exception 对象，用于记录异常信息。

单个拦截器的实现

以下是实现单个拦截器的步骤。

定义拦截器

通过实现 HandlerInterceptor 接口定义一个拦截器：

package test;

import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

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

@Slf4j
@Component
public class MyInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 预处理逻辑，如权限检查
        log.info("preHandle方法执行");
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        // 后处理逻辑，可以修改数据模型
        log.info("postHandle方法执行");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        // 资源清理逻辑，比如释放资源或记录日志
        log.info("afterCompletion方法执行");
    }

}

配置拦截器

在 Spring MVC 中，需要声明实现 WebMvcConfigurer 接口的配置类，并在配置类中配置拦截器才能使拦截器生效。以下是一个示例，将拦截器配置为拦截所有请求（/**）。

package test;

import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

import javax.annotation.Resource;

@Configuration
public class MyWebMvcConfig implements WebMvcConfigurer {

    @Resource
    private MyInterceptor myInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(myInterceptor)
                .addPathPatterns("/**");
    }

}

测试拦截器

定义一个控制器，用于测试拦截器是否生效。

package test;

import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@Slf4j
public class MyController {

    @GetMapping("/test")
    public String test() {
        log.info("控制器方法执行");
        return "OK";
    }
    
}

通过 HTTP 请求方式访问控制器方法，控制台输出的结果为：

在这里插入图片描述

多个拦截器的实现

定义拦截器

定义多个拦截器，如下例中定义 3 个拦截器。

第一个拦截器：

package test;

import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

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

@Slf4j
@Component
public class MyInterceptor1 implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 预处理逻辑，如权限检查
        log.info("【我的拦截器1】preHandle方法执行");
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        // 后处理逻辑，可以修改数据模型
        log.info("【我的拦截器1】postHandle方法执行");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        // 资源清理逻辑，比如释放资源或记录日志
        log.info("【我的拦截器1】afterCompletion方法执行");
    }

}

第二个拦截器：

package test;

import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

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

@Slf4j
@Component
public class MyInterceptor2 implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 预处理逻辑，如权限检查
        log.info("【我的拦截器2】preHandle方法执行");
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        // 后处理逻辑，可以修改数据模型
        log.info("【我的拦截器2】postHandle方法执行");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        // 资源清理逻辑，比如释放资源或记录日志
        log.info("【我的拦截器2】afterCompletion方法执行");
    }

}

第三个拦截器：

package test;

import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

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

@Slf4j
@Component
public class MyInterceptor3 implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 预处理逻辑，如权限检查
        log.info("【我的拦截器3】preHandle方法执行");
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        // 后处理逻辑，可以修改数据模型
        log.info("【我的拦截器3】postHandle方法执行");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        // 资源清理逻辑，比如释放资源或记录日志
        log.info("【我的拦截器3】afterCompletion方法执行");
    }

}

配置拦截器

为上述 3 个拦截器进行配置，指定每个拦截器拦截指定的路径。

package test;

import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

import javax.annotation.Resource;

@Configuration
public class MyMultipleInterceptorConfig implements WebMvcConfigurer {

    @Resource
    private MyInterceptor1 myInterceptor1;

    @Resource
    private MyInterceptor2 myInterceptor2;

    @Resource
    private MyInterceptor3 myInterceptor3;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(myInterceptor1)
                .addPathPatterns("/test1");
        registry.addInterceptor(myInterceptor2)
                .addPathPatterns("/test2");
        registry.addInterceptor(myInterceptor3)
                .addPathPatterns("/test3");
    }

}

测试拦截器

在控制器中为上述的路径增加映射。

package test;

import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@Slf4j
public class MyMultipleInterceptorTestController {

    @GetMapping("/test1")
    public String test1() {
        log.info("控制器test1方法执行");
        return "OK";
    }

    @GetMapping("/test2")
    public String test2() {
        log.info("控制器test2方法执行");
        return "OK";
    }

    @GetMapping("/test3")
    public String test3() {
        log.info("控制器test3方法执行");
        return "OK";
    }

}

通过 HTTP 请求方式访问映射路径为 /test2 的控制器方法，控制台输出的结果为：

在这里插入图片描述

说明访问指定路径（/test2）时，只会生效指定的拦截器（MyInterceptor2）。

多个拦截器的执行顺序

如果配置了多个拦截器，它们之间的执行顺序是什么样的？

修改上例拦截器配置，指定将多个拦截器拦截同一个路径：

package test;

import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

import javax.annotation.Resource;

@Configuration
public class MyMultipleInterceptorConfig implements WebMvcConfigurer {

    @Resource
    private MyInterceptor1 myInterceptor1;

    @Resource
    private MyInterceptor2 myInterceptor2;

    @Resource
    private MyInterceptor3 myInterceptor3;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(myInterceptor1)
                .addPathPatterns("/test2");
        registry.addInterceptor(myInterceptor2)
                .addPathPatterns("/test2");
        registry.addInterceptor(myInterceptor3)
                .addPathPatterns("/test2");
    }

}

输出的结果为：

在这里插入图片描述

说明在定义多个拦截器拦截同一个路径时，拦截器的 preHandle 方法是按照拦截器的定义顺序执行，而 postHandle 和 afterCompletion 方法则是按照拦截器的定义顺序倒序执行。

某个拦截器拒绝放行的情况

如果请求被某个拦截器拦截，即在某个拦截器中被拒绝放行，那么会出现什么情况？

继续对上例中的 MyInterceptor2 拦截器进行修改，将 preHandle 方法的返回值修改为 false，使请求在 MyInterceptor3 中被拦截。

package test;

import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

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

@Slf4j
@Component
public class MyInterceptor2 implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 预处理逻辑，如权限检查
        log.info("【我的拦截器2】preHandle方法执行");
        return false;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        // 后处理逻辑，可以修改数据模型
        log.info("【我的拦截器2】postHandle方法执行");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        // 资源清理逻辑，比如释放资源或记录日志
        log.info("【我的拦截器2】afterCompletion方法执行");
    }

}

通过 HTTP 请求访问 /test2，输出的结果为：

在这里插入图片描述

上述结果说明在定义了多个拦截器的情况下：

  • 请求被任何一个拦截器拦截，目标控制器方法都不会执行；
  • 对于拦截请求的拦截器之前的拦截器，它们的 preHandle 方法将会执行，afterCompletion 方法也会执行；
  • 对于拦截请求的拦截器，它自身的 preHandle 方法将会执行，但是 afterCompletion 方法不会执行；
  • 对于拦截请求的拦截器之后的拦截器，所有的方法都不会执行；
  • 对于所有的拦截器，它们的 postHandle 方法都不会执行。
拦截器（HandlerInterceptor）
爪哇人的博客
10-12 2万+
拦截器是相对于Spring中来说的，它和过滤器不一样，过滤器的范围更广一些是相对于Tomcat容器来说的。拦截器可以对用户进行拦截过滤处理。请求进入Controller之前，通过拦截器执行代码逻辑Controller执行之后（只是Controller执行完毕，视图还没有开始渲染），通过拦截器执行代码逻辑Controller完全执行完毕（整个请求全部结束），通过拦截器执行代码逻辑。
Spring MVC 拦截器 interceptor（实现 HandlerInterceptor 接口）
Java_c#
01-11 1479
一、拦截器（interceptor）的作用 SpringMVC的拦截器类似于Servlet 开发中的过滤器 Filter 二、拦截器和过滤器区别 JavaWeb三大组件（Servlet、Filter、Listener）
拦截器HandlerInterceptor
2401_85480529的博客
10-07 876
是 Spring MVC 框架中的一个接口，主要用于在处理 HTTP 请求的不同阶段进行拦截和处理。它类似于 Servlet 过滤器，但作用范围更加精细，可以在请求到达控制器之前、请求处理之后以及视图渲染之前进行拦截。truefalse。
深度解析Spring中的HandlerInterceptor：从原理到高级应用
最新发布
hi星尘的博客
06-19 946
HandlerInterceptor是Spring MVC中强大的拦截机制，合理使用可以实现横切关注点的统一处理，同时保持业务代码的整洁性。掌握其原理和高级用法，能够显著提升Web应用的可维护性和扩展性。的核心接口，它提供了对控制器方法执行的前后过程进行拦截的能力，是AOP思想在Web层的具体实现。HandlerInterceptor是Spring MVC框架中用于。返回ModelAndView。
Springboot 拦截器(HandlerInterceptor)
baidu_38945557的博客
12-30 3401
拦截器就是面向切面编程----AOP的具体实现。可以使用Interceptor来执行某些任务，丽日再Controller处理之前编写日志，权限校验，通用行为（读取cookie得到用户信息并将用户对象放入请求，方便后续使用）等。在Spring中，当请求发送到Controller时，在被Controller处理之前，它经过Interceptors（0个或多个）拦截器。
15. 拦截器-HandlerInterceptor
要学就学灰太狼的博客
08-07 1039
在 Spring Boot 项目中， 拦截器是开发中常用手段，要来做登陆验证、性能检查、日志记录等基本步骤：① 编写一个拦截器实现 HandlerInterceptor 接口② 拦截器注册到配置类中(实现 WebMvcConfigurer 的 addInterceptors)③ 指定拦截规则④ 回顾 SpringMVC ==>文章链接。......
详细分析SpringMvc中HandlerInterceptor拦截器的基本知识（附Demo）
码农研究僧的博客
09-24 1773
HandlerInterceptor 是 Spring MVC 提供的一种机制，用来在请求处理的不同阶段进行拦截 它通常用于日志记录、权限校验、性能监控等操作 继承 HandlerInterceptor 允许定义自定义的逻辑，在请求被处理之前、之后以及完成后执行额外的任务
Spring拦截器HandlerInterceptor接口代码解析
08-28
Spring拦截器HandlerInterceptor接口代码解析 Spring拦截器HandlerInterceptor接口代码解析是Spring框架中的一种重要机制，它允许开发者在请求处理过程中执行自定义逻辑，以达到验证、日志记录、性能监控、安全检查...
详解Spring MVC拦截器实现session控制
08-31
Spring MVC拦截器是Spring Web框架的一个重要组成部分，它允许开发者在处理请求之前或之后执行自定义的操作，例如权限校验、日志记录等。在本篇文章中，我们详细探讨了如何通过Spring MVC拦截器实现session的控制，...
Spring mvc拦截器实现原理解析
08-19
Spring MVC拦截器实现原理解析 Spring MVC拦截器是Spring MVC框架中的一种机制，可以对处理器进行预处理和后处理。它类似于Servlet开发中的过滤器Filter，用于对处理器进行预处理和后处理。开发者可以自己定义一些...
springMVC拦截器HandlerInterceptor用法代码示例
08-28
主要介绍了springMVC拦截器HandlerInterceptor用法代码示例，具有一定借鉴价值,需要的朋友可以参考下
HandlerInterceptor 拦截器
weixin_43434182的博客
09-16 186
拦截器编写： package com.demon.springmvc.Interceptor; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.web.servlet.HandlerInterceptor; import org.springframework.web.servlet.ModelAndView; import javax.servlet.http.HttpServl
HandlerInterceptor拦截器
热门推荐
echo0127的博客
10-19 2万+
一、什么是拦截器： 什么是拦截器：在AOP（Aspect-Oriented Programming）中用于在某个方法或字段被访问之前，进行拦截然后在之前或之后加入某些操作。拦截是AOP的一种实现策略 为什么需要拦截器：在做身份认证或者是进行日志的记录时，我们需要通过拦截器达到我们的目的。最常用的登录拦截、或是权限校验、或是防重复提交、或是根据业务像12306去校验购票时间,总之可以去做很多的事情 如何用拦截器：在spring中用拦截器需要实现HandlerInterceptor接口或者它的实现子类：Han
HandlerInterceptor、Filter处理器拦截器机制全解
变个魔术
11-14 1259
当当前某个拦截器的preHandle方法返回false 时，DispatcherServlet 会假定拦截器本身已处理完毕请求（例如，已经渲染了合适的视图），此时将尝试直接倒序执行此前已放行的拦截器链的afterCompletion 方法，随后retrun结束处理，不会继续执行执行链中的后续其他拦截器和Handler实际处理程序（业务逻辑）以及后续其他流程。拦截器链和过滤器链的预处理和后处理的调用顺序都是相反的，即预处理调用时按照链从前向后调用，而后处理调用时则按照链从后向前调用。
SpringMVC中的拦截器
Fzxey的博客
07-18 332
文章目录SpringMVC中的拦截器概念工作原理图自定义拦截器配置拦截条件测试 SpringMVC中的拦截器 概念 SpringMVC中的拦截器与servlet中过滤器功能差不多。不过拦截器与过滤器是有区别的。 过滤器依赖容器，而拦截器基于java反射。不依赖容器。 拦截器与过滤器的区别： 工作原理图 自定义拦截器 通过实现HandlerInterceptor /** * 自定义拦截...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

JiaHao汤

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值