SpringBoot拦截器不生效的问题解决
更新时间：2024年09月05日 08:52:44 作者：True_aFalse
很多开发者会遇到一个常见的问题,拦截器配置了却不生效,本文主要介绍了SpringBoot拦截器不生效的问题解决,具有一定的参考价值,感兴趣的可以了解一下
在使用 Spring Boot 开发 Web 应用时，我们常常需要使用拦截器（Interceptor）来对请求进行预处理。例如，验证用户是否登录。然而，很多开发者会遇到一个常见的问题：拦截器配置了却不生效。本文将讨论一种常见的原因及其解决方案——将配置类移入正确的包下。
问题描述
我们创建了一个 LoginCheckInterceptor 类，并在 WebConfig 类中进行注册。但是，启动应用后发现拦截器并没有生效。
示例代码：
LoginCheckInterceptor 类：
package com.itheima.interceptor;
import com.alibaba.fastjson.JSONObject;
import com.itheima.pojo.Result;
import com.itheima.utils.JwtUtils;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;
import org.springframework.util.StringUtils;
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 LoginCheckInterceptor implements HandlerInterceptor {
@Override
public boolean preHandle(HttpServletRequest req, HttpServletResponse resp, Object handler) throws Exception {
String url = req.getRequestURL().toString();
log.info("请求的url: {}", url);
if (url.contains("login")) {
log.info("登录操作, 放行...");
return true;
}
String jwt = req.getHeader("token");
if (!StringUtils.hasLength(jwt)) {
log.info("请求头token为空,返回未登录的信息");
Result error = Result.error("NOT_LOGIN");
String notLogin = JSONObject.toJSONString(error);
resp.getWriter().write(notLogin);
return false;
}
try {
JwtUtils.parseJWT(jwt);
} catch (Exception e) {
e.printStackTrace();
log.info("解析令牌失败, 返回未登录错误信息");
Result error = Result.error("NOT_LOGIN");
String notLogin = JSONObject.toJSONString(error);
resp.getWriter().write(notLogin);
return false;
}
log.info("令牌合法, 放行");
return true;
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
System.out.println("postHandle ...");
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
System.out.println("afterCompletion...");
}
}
WebConfig 类：
package com.config;
import com.itheima.interceptor.LoginCheckInterceptor;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
@Configuration
public class WebConfig implements WebMvcConfigurer {
@Autowired
private LoginCheckInterceptor loginCheckInterceptor;
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(loginCheckInterceptor).addPathPatterns("/**");
}
}
解决方案
将 WebConfig 类移到 itheima 包下即可解决问题。原因在于 Spring Boot 的默认包扫描机制。
原因分析
Spring Boot 使用 @SpringBootApplication 注解的主应用类启动应用。该注解包含了 @ComponentScan，默认扫描主应用类所在包及其子包中的所有组件。如果 WebConfig 类不在主应用类所在包或其子包下，Spring Boot 将无法自动扫描到它，从而导致拦截器不生效。
解决方法
将 WebConfig 类移到 com.itheima 包下，确保其在主应用类的扫描路径内。
调整后的目录结构：
src/main/java
└── com
└── itheima
├── MyApplication.java
├── interceptor
│ └── LoginCheckInterceptor.java
└── config
└── WebConfig.java代码调整
将 WebConfig 类从 com.config 包移到 com.itheima.config 包下：
package com.itheima.config;
import com.itheima.interceptor.LoginCheckInterceptor;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
@Configuration
public class WebConfig implements WebMvcConfigurer {
@Autowired
private LoginCheckInterceptor loginCheckInterceptor;
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(loginCheckInterceptor).addPathPatterns("/**");
}
}
其他解决方案
如果不想移动配置类，还可以通过以下方法显式指定扫描路径：
1. 使用 @ComponentScan 注解指定扫描包：
package com.itheima;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.ComponentScan;
@SpringBootApplication
@ComponentScan(basePackages = {"com.itheima", "com.config"})
public class MyApplication {
public static void main(String[] args) {
SpringApplication.run(MyApplication.class, args);
}
}
2. 使用 @Import 注解导入配置类：
package com.itheima;
import com.itheima.config.WebConfig;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Import;
@SpringBootApplication
@Import(WebConfig.class)
public class MyApplication {
public static void main(String[] args) {
SpringApplication.run(MyApplication.class, args);
}
}
通过这些方式，可以确保 Spring Boot 正确扫描和加载拦截器配置类，使拦截器生效。
结论
在使用 Spring Boot 开发 Web 应用时，正确配置包扫描路径非常重要。确保配置类在主应用类的扫描路径内，可以有效解决拦截器不生效的问题。希望这篇文章能够帮助大家更好地理解 Spring Boot 的包扫描机制，并顺利解决开发中遇到的问题。
到此这篇关于SpringBoot拦截器不生效的问题解决的文章就介绍到这了,更多相关SpringBoot拦截器不生效内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！
相关文章
这篇文章主要介绍了Java ConcurrentHashMap用法案例详解,本篇文章通过简要的案例,讲解了该项技术的了解与使用,以下就是详细内容,需要的朋友可以参考下2021-08-08
这篇文章主要给大家介绍了关于Java中一个BigDecimal问题的相关资料,通过文中介绍的方法可以很方便的解决BigDecimal进行计算的时候不管怎么计算,最后得到的值都没有变化的问题,需要的朋友可以参考下2021-11-11
目录穿越漏洞,也叫做目录遍历/路径遍历漏洞,本文主要介绍了java代码审计之目录遍历的解决,文中通过案例介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧2024-06-06
Java中EasyExcel使用自定义Converter处理方法详解
EasyExcel自定义Converter是指在使用EasyExcel进行Excel读写操作时,可以自定义转换器来处理一些不支持的数据类型,这篇文章主要给大家介绍了关于Java中EasyExcel使用自定义Converter处理的相关资料,需要的朋友可以参考下2024-08-08
这篇文章主要介绍了mybatis的使用-Mapper文件各种语法介绍，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧2020-11-11
日志是程序的重要组成部分,主要可以用来定位和排查问题,在程序中进行自定义日志输出的时候,也通常是借助于SLF4J框架来输出日志,本文给大家分享springBoot的日志文件相关知识,感兴趣的朋友一起看看吧2024-06-06
Vue的通过数据劫持的方式实现数据的双向绑定，即使用Object.defineProperty()来实现对属性的劫持，但是Object.defineProperty()中的setter是无法直接实现数组中值的改变的劫持行为的,需要的朋友可以参考下2023-05-05
本篇文章主要介绍了详解SSM框架下结合log4j、slf4j打印日志，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧2017-11-11
以下小编就为大家介绍一下，怎么运行用记事本写的java程序。需要的朋友可以过来参考下2013-08-08
本篇文章，小编将为大家介绍关于Struts2文件上传与自定义拦截器，有需要的朋友可以参考一下2013-04-04
最新评论