springboot拦截器excludePathPatterns方法不生效的坑与解决方法

一、前言

最近在springboot项目里需要配置个拦截器白名单，用excludePathPatterns方法配置些url，让拦截器不拦截这些url；

本来这是个很简单的东西，但是配置完毕后就是没有生效；

在此记录下这个坑的解决方法。

二、问题

1.例如，想让以下url不被拦截器拦截：
http://localhost:8080/survey-project/download/special

2.拦截器配置代码如下：

//这是拦截器配置类
@Configuration
public class InterceptorConfig extends WebMvcConfigureAdapter {

//这是一个自己写的拦截器类
@Autowired
private MyInterceptor myInterceptor;

@Override
public void addInterceptors(InterceptorRegistry registry){
  registry.addInterceptor(myInterceptor)
  //这里配置要拦截的路径
  .addPathPatterns("/**")
  //这里配置不要拦截的路径
  .excludePathPatterns("/**/login","/**/register",
  //这里配置不拦截上方的url
  "/survey-project/download/**");
}

}

3.看起来没有问题，但是当访问上方url的时候，还是会被拦截器拦截，就很坑。

三、解决方法

1.通过排查发现，原来，在application.yml中，是这样配置的：

server:
  port: 8080
  context-path: /survey-project

2.所以，还是拦截器的url配置错了，想不拦截的话，需要这样配置：

registry.addInterceptor(myInterceptor)
  .addPathPatterns("/**")
  .excludePathPatterns("/**/login","/**/register",
  //这里配置不拦截上方的url
  "/download/**");

3.这样，访问这个url，才能不被拦截器拦截：
http://localhost:8080/survey-project/download/special

四、总结

1.配置拦截器时，如果excludePathPatterns没有生效，可能是url配置有问题。
2.可以检查下application.yml的context-path，或者其它类似的地方，配置拦截器的url不应该包含这些路径，只要从Controller的路径开始配置即可。