关于swagger配置可能导致spring中拦截器失效的问题

失效导致的心路历程

根本原因:

swagger的内置接口被拦截器拦下来了

解决方案:

在自定义拦截器适配器中重写addResourceHandlers或者addInterceptors中excludePathPatterns。

解决经过

1.我们在接入原生的swagger的时候,刚刚接入的的时候项目启动很可能访问http://localhost:8081/swagger-ui.html# 时访问不到自己项目上的swagger,显示的是界面空白的坑,出现这个地方的原因是没有将Swagger2 的swagger-ui.html加入资源路径下,Swagger2静态页面不能访问。
想使资源能够访问,可以有两种方法:
一:需要配置类继承WebMvcConfigurationSupport 类,实现addResourceHandlers方法。
二:继承WebMvcConfigurer接口。(笔者没试过)。

2.好,接下来第二步配置重写addResourceHandlers方法
3.第三步启动,成功!访问页面有内容!但是!!但是,我在之后的调试发现我springboot中所有的拦截器都不起作用了,掉坑了,开始以为是sping版本升级的导致的,因为有博客说明在springboot 2.x中拦截器适配器如果再依然继承WebMvcConfigurerAdapter这个过时的类的话(springboot 2.x使用的是spring5),可能出现拦截器失效的问题,之后我花大力气去看spring原码中为何会出现失效的问题,在原码中看到:

  • An implementation of {@link WebMvcConfigurer} with empty methods allowing
  • subclasses to override only the methods they’re interested in.
  • @author Rossen Stoyanchev
  • @since 3.1
  • @deprecated as of 5.0 {@link WebMvcConfigurer} has default methods (made
  • possible by a Java 8 baseline) and can be implemented directly without the
  • need for this adapter

英文不好,差不多的意思是:Java8的原因,我们不再需要这个类了,因为WebMvcConfigurer有了defalut方法,他允许子类仅覆盖那些需要的方法。

4.既然可能会出现这个问题,为了排除是否是这个地方导致的拦截器失效我将spring版本会滚到之前的老版,测试,结果还是无效的,看来不是这个地方导致的呀。

5.这时我看到拦截器的一个自定义适配器实现的一个办法是继承WebMvcConfigurationSupport这个类,但这个类在Swagger的配置类也使用到了,会不会是Spring Boot的 WebMvc自动配置也使用到被我这个WebMvcConfigurationSupport影响到了呢,接下来去找WebMvc的自动配置类,终于到了问题了。
WebMvcAutoConfiguration
@ConditionalOnMissingBean这个注解,作用:在容器中一旦存在WebMvcConfigurationSupport这个类的时候,Spring Boot的 WebMvc自动配置就会失效,可能导致的问题,除了swagger那个实现WebMvcConfigurationSupport的那个类有效其他WebMvcAutoConfiguration类中的配置都不生效,如果有其他静态资源通过其他地方配置了同样会失效。

6.那么解决办法是:其实在开始我对于swagger访问404的问题没有太去看为什么,查到网上大多数博客教这么做我没有考虑到整体的spring配置环境我就直接吧代码复制过来了,看到有用也就没有深究,但这给之后出现拦截器无效埋下了坑,出现swagger访问404的原因很简单,就是添加了拦截器之后,将请求拦截下来了,发现问题的根节点了,解决问题就好办很多了。
在自定义webmvc适配器中重写addResourceHandlers这个方法
在这里插入图片描述
7.查看swagger能否访问,成功!拦截器能否拦截其他请求,成功!
8.复盘:出现问题的时候为了快速解决问题的时候,获得解决的解决方案需要自我论证,不能光看当前这个case有用就行,需要对整体有一个闭环的思维。

评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值