快捷導(dǎo)航

SpringBoot攔截器不生效的問題解決

更新時間：2024年09月05日 08:52:44 作者：True_aFalse

很多開發(fā)者會遇到一個常見的問題,攔截器配置了卻不生效,本文主要介紹了SpringBoot攔截器不生效的問題解決,具有一定的參考價值,感興趣的可以了解一下

在使用 Spring Boot 開發(fā) Web 應(yīng)用時，我們常常需要使用攔截器（Interceptor）來對請求進行預(yù)處理。例如，驗證用戶是否登錄。然而，很多開發(fā)者會遇到一個常見的問題：攔截器配置了卻不生效。本文將討論一種常見的原因及其解決方案——將配置類移入正確的包下。

問題描述

我們創(chuàng)建了一個 LoginCheckInterceptor 類，并在 WebConfig 類中進行注冊。但是，啟動應(yīng)用后發(fā)現(xiàn)攔截器并沒有生效。

示例代碼：

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 的默認(rèn)包掃描機制。

原因分析

Spring Boot 使用 @SpringBootApplication 注解的主應(yīng)用類啟動應(yīng)用。該注解包含了 @ComponentScan，默認(rèn)掃描主應(yīng)用類所在包及其子包中的所有組件。如果 WebConfig 類不在主應(yīng)用類所在包或其子包下，Spring Boot 將無法自動掃描到它，從而導(dǎo)致攔截器不生效。

解決方法

將 WebConfig 類移到 com.itheima 包下，確保其在主應(yīng)用類的掃描路徑內(nèi)。

調(diào)整后的目錄結(jié)構(gòu)：

src/main/java
 └── com
     └── itheima
         ├── MyApplication.java
         ├── interceptor
         │   └── LoginCheckInterceptor.java
         └── config
             └── WebConfig.java

代碼調(diào)整

將 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 注解導(dǎo)入配置類：

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 正確掃描和加載攔截器配置類，使攔截器生效。

結(jié)論

在使用 Spring Boot 開發(fā) Web 應(yīng)用時，正確配置包掃描路徑非常重要。確保配置類在主應(yīng)用類的掃描路徑內(nèi)，可以有效解決攔截器不生效的問題。希望這篇文章能夠幫助大家更好地理解 Spring Boot 的包掃描機制，并順利解決開發(fā)中遇到的問題。

到此這篇關(guān)于SpringBoot攔截器不生效的問題解決的文章就介紹到這了,更多相關(guān)SpringBoot攔截器不生效內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: