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线程变量ThreadLocal详细解读
这篇文章主要介绍了Java线程变量ThreadLocal详细解读,多线程访问同一个变量的时候,很容易出现问题,特别是多线程对一个共享变量进行写入的时候,为了线程的安全在进行数据写入时候会进行数据的同步,需要的朋友可以参考下
2024-01-01
Java1.7全网最深入HashMap源码解析
HashMap 是一个散列表，它存储的内容是键值对(key-value)映射。HashMap 实现了 Map 接口，根据键的 HashCode 值存储数据，具有很快的访问速度，最多允许一条记录的键为 nul
2021-11-11
使用Spring Cache时设置缓存键的注意事项详解
在现代的Web应用中,缓存是提高系统性能和响应速度的重要手段之一,Spring框架提供了强大的缓存支持,通过@Cacheable、@CachePut、@CacheEvict等注解可以方便地实现缓存功能,本文给大家介绍了使用Spring Cache时设置缓存键的注意事项
2025-01-01
java中使用interrupt通知线程停止详析
这篇文章主要介绍了java中使用interrupt通知线程停止详析，文章介绍的是使用interrupt来通知线程停止运行，而不是强制停止，详细内容需要的小伙伴可以参考一下
2022-09-09
SpringBoot静态资源CSS等修改后再运行无效的解决
这篇文章主要介绍了SpringBoot静态资源CSS等修改后再运行无效的解决方案，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-12-12
浅析Java getResource详细介绍
这篇文章主要介绍了Java getResource 讲解,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2021-09-09
Required request body is missing的问题及解决
这篇文章主要介绍了Required request body is missing的问题及解决方案,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
2023-12-12
Java的四种引用方式
这篇文章主要介绍了Java的四种引用方式，Java的引用方式主要包括强引用、软引用、弱引用、虚引用;下面文章便来详细介绍这四种引用方式,需要的朋友可以参考一下
2021-10-10
SpringBoot@Profile注解和Spring EL(多环境注入)
为了方便， Spring还提供了 Profile机制，使我们可以很方便地实现各个环境之间的切换，在使用DI来依赖注入的时候,能够根据@profile标明的环境,将注入符合当前运行环境的相应的bean,本文通过示例代码介绍SpringBoot@Profile注解和Spring EL,需要的朋友可以参考下
2024-02-02
JAVA项目常用异常处理汇总
这篇文章主要介绍了JAVA项目常用异常处理汇总,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2019-11-11