首页 > 软件编程 > java > SpringBoot拦截器excludePathPatterns方法不生效

SpringBoot拦截器excludePathPatterns方法不生效的解决方案

2023-07-11 10:24:26 作者：程序员大佬超

这篇文章主要介绍了SpringBoot拦截器excludePathPatterns方法不生效的解决方案，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教

SpringBoot拦截器excludePathPatterns方法不生效

在拦截器用 excludePathPatterns() 方法排除访问路径时，发现不生效，配置代码如下

/**
 * @author 程序员大佬超
 * @date 2023-03-01 15:33.
 */
@Configuration
public class WebMvcConfig implements WebMvcConfigurer {
    @Autowired
    AuthTokenInterceptor authTokenInterceptor;
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        List<String> patterns = new ArrayList<>();
        patterns.add("/**/login/login");
        registry.addInterceptor(authTokenInterceptor)
                .addPathPatterns("/**")
                .excludePathPatterns(patterns);
    }
}

接口访问地址：http://127.0.0.1:8088/api-im/login/login

其实这个问题大部分情况下无非两个原因：

1、要排除的这个访问路径配置马虎写错了。

2、要排除的这个访问路径就不存在，或者请求参数不对解析出错，这时SpringBoot会将路径自动变成/error，具体可以在自定义拦截器里打断点验证一下。

我这里就是第二个原因，可以看到自定义的拦截器里 requestURI 变成了 /error。

在这里插入图片描述

解决方法

保证接口正确或者检查请求参数，反正要保证能正常进入，我这就是请求头里少了一个参数，然后解析的时候日志里其实已经提示缺失请求头了。

WARN 15628 --- [nio-8088-exec-1] .w.s.m.s.DefaultHandlerExceptionResolver :
Resolved [org.springframework.web.bind.MissingRequestHeaderException: Required request header 'test' for method parameter type String is not present]

然后，加上即可

在这里插入图片描述

springboot拦截器实现

1.创建一个类，实现WebMvxConfigurer，重写addInterceptors，添加需要拦截的路径，以及放行的路径

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 MyWebMvcConfig implements WebMvcConfigurer {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        try {
//MyLoginInterception这个类是拦截的条件（如是否需要登录，需要单独来写，请看下面）
//excludePathPatterns这个是不需要进行拦截的操作路径。
registry.addInterceptor(MyLoginInterception.class.newInstance()).addPathPatterns("/**")
                    .excludePathPatterns("/login", "/register", "/**/*.js", "/**/*.css", "/**/*.html");
        } catch (InstantiationException e) {
            throw new RuntimeException(e);
        } catch (IllegalAccessException e) {
            throw new RuntimeException(e);
        }
    }
}

2.创建类，对拦截路径的请求做条件判断

import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
@Configuration
public class MyLoginInterception implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("------------start------------");
//这里方便测试，对请求头带有”source“：”back“ 进行放行
        if (null == request.getHeader("source") || !request.getHeader("source").equals("back")) {
            return false;
        }
        return true;
    }
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("拦截器执行结束");
        HandlerInterceptor.super.postHandle(request, response, handler, modelAndView);
    }
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("数据返回，执行结束");
        HandlerInterceptor.super.afterCompletion(request, response, handler, ex);
    }
}

拦截器的实现比较简单，比较难的是根据业务，做相关处理，如对cook，session的处理，以及各种条件的处理

总结

以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。

SpringBoot拦截器excludePathPatterns方法不生效的解决方案