当前位置:

首页 > 编程开发 > SpringBoot拦截器怎么配置?手把手教你实现自定义拦截器

SpringBoot拦截器怎么配置?手把手教你实现自定义拦截器

SpringBoot添加拦截器 在Web开发中,拦截器几乎是绕不开的组件。但在SpringBoot项目里,该怎么配置才能让它生效?这篇文章就来拆解一下。 和普通属性不同,拦截器本身是一个类,所以不能直接在application.properties里配置,得用Ja va Config的方式搞定。Sp

本文目录

    SpringBoot添加拦截器

    在Web开发中,拦截器几乎是绕不开的组件。但在SpringBoot项目里,该怎么配置才能让它生效?这篇文章就来拆解一下。

    SpringBoot拦截器怎么配置?手把手教你实现自定义拦截器

    和普通属性不同,拦截器本身是一个类,所以不能直接在application.properties里配置,得用Ja va Config的方式搞定。SpringBoot官方文档里其实有明确说明,摘录一段:

    If you want to keep Spring Boot MVC features and you want to add additional MVC configuration (interceptors, formatters, view controllers, and other features), you can add your own @Configuration class of type WebMvcConfigurer but without @EnableWebMvc. If you wish to provide custom instances of RequestMappingHandlerMapping, RequestMappingHandlerAdapter, or ExceptionHandlerExceptionResolver, you can declare a WebMvcRegistrationsAdapter instance to provide such components.

    If you want to take complete control of Spring MVC, you can add your own @Configuration annotated with @EnableWebMvc.

    简单翻译一下核心意思:

    • 如果你希望保留SpringBoot的默认MVC特性,同时又想自定义一些配置(比如拦截器、格式化器、视图控制器、消息转换器等),那就让一个类实现WebMvcConfigurer,并加上@Configuration注解——但千万不能加@EnableWebMvc。
    • 如果想自定义HandlerMapping、HandlerAdapter、ExceptionResolver这些底层组件,可以通过创建一个WebMvcRegistrationsAdapter实例来实现。
    • 如果打算完全接管SpringMVC,不保留SpringBoot的任何默认配置,那就自己写一个配置类,加上@Configuration和@EnableWebMvc两个注解。

    清楚了文档的前提,接下来就是实操。

    首先,定义一个拦截器

    @Component
    //继承HandlerInterceptor
    public class MyInterceptor implements HandlerInterceptor {
        @Override
        public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
            System.out.println("preHandle method is running!");
            return true;
        }
    
        @Override
        public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
            System.out.println("postHandle method is running!");
        }
    
        @Override
        public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
            System.out.println("afterCompletion method is running!");
        }
    }
    

    这个拦截器实现了HandlerInterceptor接口,覆盖了三个方法:preHandle(请求处理之前)、postHandle(请求处理之后、视图渲染之前)、afterCompletion(整个请求完成之后)。这里只是简单打印日志,方便验证。

    然后,定义配置类,注册拦截器

    @Configuration
    //实现`WebMvcConfigurer`,并且添加`@Configuration`注解
    public class MvcConfiguration implements WebMvcConfigurer {
    
        //注入定义的拦截器
        @Autowired
        private HandlerInterceptor myInterceptor;
    
        /**
         * 重写接口中的addInterceptors方法,添加自定义拦截器
         * @param registry
         */
        @Override
        public void addInterceptors(InterceptorRegistry registry) {
    /*拦截路径*/        registry.addInterceptor(myInterceptor).addPathPatterns("/**");
        }
    }
    

    关键点:配置类实现WebMvcConfigurer,重写addInterceptors方法,将拦截器注册进去,并指定拦截路径(这里用/**表示所有请求)。注意不要遗漏@Configuration注解,也一定不要加@EnableWebMvc,否则会关掉SpringBoot的自动配置。

    运行看看效果

    启动项目,访问任意一个接口,控制台输出:

    preHandle method is running!

    postHandle method is running!

    afterCompletion method is running!

    拦截器生效了。不过你会发现只有这三行打印,SpringMVC本身的日志信息并没有出现。原因很简单:SpringMVC的日志级别默认是debug,而SpringBoot默认只显示info及以上级别,所以需要手动调整日志配置。

    在application.properties或application.yml中加一行:

    # 设置org.springframework包的日志级别为debug
    logging.level.org.springframework=debug
    

    再次运行,你就会看到SpringMVC更详细的内部日志了。

    总结

    配置拦截器其实就两步:写一个拦截器类,再写一个配置类注册它。只要记住不加@EnableWebMvc这个关键点,就不会掉坑里。另外,日志级别调一下,调试时能省不少事。

    本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系bd@zhengruan.com
    作者最新文章
    编程开发
    相关文章 更多
    SpringBoot拦截器怎么用?从入门到多拦截器链式调用详解
    SpringBoot拦截器怎么用?从入门到多拦截器链式调用详解

    SpringBoot拦截器通过实现HandlerInterceptor接口,在请求前后执行预处理和后处理,实现权限校验、日志记录等功能。多拦截器按注册顺序执行preHandle,反向执行postHandle与afterCompletion。过滤器基于Servlet容器,范围更广;拦截器聚焦SpringMVC业务处理,两者常配合使用。

    SpringBoot中的拦截器使用详解
    SpringBoot中的拦截器使用详解

    拦截器 还记得我们之前的图书管理系统吗?当时我们实现了强制登录的功能。原理其实很直观:用户登录成功后,后端就把用户信息存到 Session 里,然后程序根据 Session 来判断用户是否登录。听起来挺简单的,对吧?但实际操作起来,你可能会觉得有点麻烦: • 每个接口的处理逻辑都得改一遍 • 每个接

    QQ影音怎么加速播放视频课程
    QQ影音怎么加速播放视频课程

    播放时右键选播放速度,或点控制条倍速,1.25 到 1.5 倍看课最舒服;公式代码类内容别超过 1.25 倍。

    企业微信创建企业提示失败怎么办 实名与填写检查
    企业微信创建企业提示失败怎么办 实名与填写检查

    先看提示属于哪类:名称占用就加后缀,实名不一致就重填本人信息,证件不清晰就重拍。统一社会信用代码逐位核对,连续三次失败别改材料重投,直接联系客服人工核。

    Modern Web Guidance 的 legacy-scan 反转建议应该怎样判断?
    Modern Web Guidance 的 legacy-scan 反转建议应该怎样判断?

    说明源码提交对字符串、生成器和数组的识别边界,以及扫描命令与发行包核验限制。

    Codex 0.170.0 正式版的语音与连接更新,适用范围有哪些限制?
    Codex 0.170.0 正式版的语音与连接更新,适用范围有哪些限制?

    0.170.0 的语音更新限于终端通话协商能力的明确新增,同名工具服务器跨环境支持仍标注实验性质;连接部分则修复大请求回退、认证竞态和云端重连等具体问题。这份正式版公告不足以证明所有账户、所有客户端都已具备完整语音功能。

    Hy4 flash 三种权重怎么选,安装和授权要注意哪些条件?
    Hy4 flash 三种权重怎么选,安装和授权要注意哪些条件?

    了解Hy4 flash、FP8与base的适用任务,阅读官方安装及图文代码,并核对资源和MaaS许可条件。

    OpenAI Python SDK 3.55.0 升级看点:Live MCP 服务配置与预算接口变化
    OpenAI Python SDK 3.55.0 升级看点:Live MCP 服务配置与预算接口变化

    OpenAI Python SDK 3.55.0 升级看点:Live MCP 服务配置与预算接口变化。说明已核实的更新范围、类型兼容性和本地版本确认方法。

    OpenAI Java SDK 4.108.0 的两项新增能力适合哪些项目?
    OpenAI Java SDK 4.108.0 的两项新增能力适合哪些项目?

    OpenAI Java SDK 4.108.0 面向 Live MCP 工具接入与 Managed Agents 预算状态处理,说明新增模型、事件含义、正式发布范围和适用限制。

    Free Claude Code 6.19.37 如何兼顾网页搜索与普通工具调用?
    Free Claude Code 6.19.37 如何兼顾网页搜索与普通工具调用?

    Free Claude Code 6.19.37 在自动搜索时保留客户端工具及选择条件,代理执行搜索后仍返回普通调用。说明适用场景、历史信息保留、请求约束与第三方项目的版本边界。

    查看更多
    精品专题 更多
    装机必备
    装机必备

    正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

    Windows
    Windows

    正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

    PDF教程
    PDF教程

    正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法,同时介绍常用PDF软件和工具的使用技巧。

    Mac软件 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    Aperty macOS版
    Aperty macOS版
    macOS

    Aperty 是 Skylum 推出的 AI 人像修图软件,支持自然肤质修饰、瑕疵处理、面部与身体调整、预设及批量同步。

    WINDOWS 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    PixTV 网页版
    PixTV 网页版
    Windows

    PixTV 是一款在浏览器中使用的 AI 视觉内容创作平台,提供图片、视频、音频、文字生成、AI 分镜、局部重绘、提示词反推和无限画布等工具,适合短剧、漫剧、广告及社交媒体内容制作。