springboot学习(六十一) 解决springboot2.6和swagger冲突的问题

2022-07-25 12:47:15

文章目录

1、问题

springboot升级到2.6后发现无法启动，和swagger冲突，错误信息如下：

org.springframework.context.ApplicationContextException: Failed to start bean'documentationPluginsBootstrapper'; nested exception is java.lang.NullPointerException
	at org.springframework.context.support.DefaultLifecycleProcessor.doStart(DefaultLifecycleProcessor.java:181) ~[spring-context-5.3.13.jar:5.3.13]
	at org.springframework.context.support.DefaultLifecycleProcessor.access$200(DefaultLifecycleProcessor.java:54) ~[spring-context-5.3.13.jar:5.3.13]
	at org.springframework.context.support.DefaultLifecycleProcessor$LifecycleGroup.start(DefaultLifecycleProcessor.java:356) ~[spring-context-5.3.13.jar:5.3.13]
	at java.lang.Iterable.forEach(Iterable.java:75) ~[?:?]
	at org.springframework.context.support.DefaultLifecycleProcessor.startBeans(DefaultLifecycleProcessor.java:155) ~[spring-context-5.3.13.jar:5.3.13]
	at org.springframework.context.support.DefaultLifecycleProcessor.onRefresh(DefaultLifecycleProcessor.java:123) ~[spring-context-5.3.13.jar:5.3.13]
	at org.springframework.context.support.AbstractApplicationContext.finishRefresh(AbstractApplicationContext.java:935) ~[spring-context-5.3.13.jar:5.3.13]
	at org.springframework.context.support.AbstractApplicationContext.refresh(AbstractApplicationContext.java:586) ~[spring-context-5.3.13.jar:5.3.13]
	at org.springframework.boot.web.servlet.context.ServletWebServerApplicationContext.refresh(ServletWebServerApplicationContext.java:145) ~[spring-boot-2.6.1.jar:2.6.1]
	at org.springframework.boot.SpringApplication.refresh(SpringApplication.java:730) ~[spring-boot-2.6.1.jar:2.6.1]
	at org.springframework.boot.SpringApplication.refreshContext(SpringApplication.java:412) ~[spring-boot-2.6.1.jar:2.6.1]
	at org.springframework.boot.SpringApplication.run(SpringApplication.java:302) ~[spring-boot-2.6.1.jar:2.6.1]
	at com.iscas.biz.BizApp.main(BizApp.java:69) ~[classes/:?]
Caused by: java.lang.NullPointerException
	at springfox.documentation.spring.web.WebMvcPatternsRequestConditionWrapper.getPatterns(WebMvcPatternsRequestConditionWrapper.java:56) ~[springfox-spring-webmvc-3.0.0.jar:3.0.0]
	at springfox.documentation.RequestHandler.sortedPaths(RequestHandler.java:113) ~[springfox-core-3.0.0.jar:3.0.0]
	at springfox.documentation.spi.service.contexts.Orderings.lambda$byPatternsCondition$3(Orderings.java:89) ~[springfox-spi-3.0.0.jar:3.0.0]
	at java.util.Comparator.lambda$comparing$77a9974f$1(Comparator.java:469) ~[?:?]
	at java.util.TimSort.countRunAndMakeAscending(TimSort.java:355) ~[?:?]
	at java.util.TimSort.sort(TimSort.java:234) ~[?:?]
	at java.util.Arrays.sort(Arrays.java:1515) ~[?:?]
	at java.util.ArrayList.sort(ArrayList.java:1750) ~[?:?]
	at java.util.stream.SortedOps$RefSortingSink.end(SortedOps.java:392) ~[?:?]
	at java.util.stream.Sink$ChainedReference.end(Sink.java:258) ~[?:?]
	at java.util.stream.Sink$ChainedReference.end(Sink.java:258) ~[?:?]
	at java.util.stream.Sink$ChainedReference.end(Sink.java:258) ~[?:?]
	at java.util.stream.Sink$ChainedReference.end(Sink.java:258) ~[?:?]
	at java.util.stream.AbstractPipeline.copyInto(AbstractPipeline.java:485) ~[?:?]
	at java.util.stream.AbstractPipeline.wrapAndCopyInto(AbstractPipeline.java:474) ~[?:?]
	at java.util.stream.ReduceOps$ReduceOp.evaluateSequential(ReduceOps.java:913) ~[?:?]
	at java.util.stream.AbstractPipeline.evaluate(AbstractPipeline.java:234) ~[?:?]
	at java.util.stream.ReferencePipeline.collect(ReferencePipeline.java:578) ~[?:?]
	at springfox.documentation.spring.web.plugins.WebMvcRequestHandlerProvider.requestHandlers(WebMvcRequestHandlerProvider.java:81) ~[springfox-spring-webmvc-3.0.0.jar:3.0.0]
	at java.util.stream.ReferencePipeline$3$1.accept(ReferencePipeline.java:195) ~[?:?]
	at java.util.ArrayList$ArrayListSpliterator.forEachRemaining(ArrayList.java:1655) ~[?:?]
	at java.util.stream.AbstractPipeline.copyInto(AbstractPipeline.java:484) ~[?:?]
	at java.util.stream.AbstractPipeline.wrapAndCopyInto(AbstractPipeline.java:474) ~[?:?]
	at java.util.stream.ReduceOps$ReduceOp.evaluateSequential(ReduceOps.java:913) ~[?:?]
	at java.util.stream.AbstractPipeline.evaluate(AbstractPipeline.java:234) ~[?:?]
	at java.util.stream.ReferencePipeline.collect(ReferencePipeline.java:578) ~[?:?]
	at springfox.documentation.spring.web.plugins.AbstractDocumentationPluginsBootstrapper.withDefaults(AbstractDocumentationPluginsBootstrapper.java:107) ~[springfox-spring-web-3.0.0.jar:3.0.0]
	at springfox.documentation.spring.web.plugins.AbstractDocumentationPluginsBootstrapper.buildContext(AbstractDocumentationPluginsBootstrapper.java:91) ~[springfox-spring-web-3.0.0.jar:3.0.0]
	at springfox.documentation.spring.web.plugins.AbstractDocumentationPluginsBootstrapper.bootstrapDocumentationPlugins(AbstractDocumentationPluginsBootstrapper.java:82) ~[springfox-spring-web-3.0.0.jar:3.0.0]
	at springfox.documentation.spring.web.plugins.DocumentationPluginsBootstrapper.start(DocumentationPluginsBootstrapper.java:100) ~[springfox-spring-web-3.0.0.jar:3.0.0]
	at org.springframework.context.support.DefaultLifecycleProcessor.doStart(DefaultLifecycleProcessor.java:178) ~[spring-context-5.3.13.jar:5.3.13]...12more

目测是因为springboot修改了请求路由匹配策略造成的

8. SpringMVC 默认路径匹配策略
Spring MVC 处理程序映射匹配请求路径的默认策略已从 AntPathMatcher 更改为PathPatternParser。

Actuator端点现在也使用基于 PathPattern 的 URL 匹配。需要注意的是，Actuator端点的路径匹配策略无法通过配置属性进行配置。

如果需要将默认切换回 AntPathMatcher，可以将 spring.mvc.pathmatch.matching-strategy 设置为 ant-path-matcher，比如下面这样：

spring.mvc.pathmatch.matching-strategy=ant-path-matcher

2、解决办法1

找到类：

/*
 *
 *  Copyright 2015-2017 the original author or authors.
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *
 */packagespringfox.documentation.spring.web.plugins;importorg.springframework.beans.factory.annotation.Autowired;importorg.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;importorg.springframework.context.annotation.Conditional;importorg.springframework.core.Ordered;importorg.springframework.core.annotation.Order;importorg.springframework.stereotype.Component;importorg.springframework.web.method.HandlerMethod;importorg.springframework.web.servlet.mvc.method.RequestMappingInfo;importorg.springframework.web.servlet.mvc.method.RequestMappingInfoHandlerMapping;importspringfox.documentation.RequestHandler;importspringfox.documentation.spi.service.RequestHandlerProvider;importspringfox.documentation.spring.web.OnServletBasedWebApplication;importspringfox.documentation.spring.web.WebMvcRequestHandler;importspringfox.documentation.spring.web.readers.operation.HandlerMethodResolver;importjavax.servlet.ServletContext;importjava.util.List;importjava.util.Map;importjava.util.Optional;importjava.util.function.Function;importjava.util.stream.Collectors;importjava.util.stream.StreamSupport;importstaticjava.util.stream.Collectors.*;importstaticspringfox.documentation.builders.BuilderDefaults.*;importstaticspringfox.documentation.spi.service.contexts.Orderings.*;importstaticspringfox.documentation.spring.web.paths.Paths.*;@Component@Order(Ordered.HIGHEST_PRECEDENCE)@ConditionalOnWebApplication(type=ConditionalOnWebApplication.Type.SERVLET)@Conditional(OnServletBasedWebApplication.class)publicclassWebMvcRequestHandlerProviderimplementsRequestHandlerProvider{privatefinalList<RequestMappingInfoHandlerMapping> handlerMappings;privatefinalHandlerMethodResolver methodResolver;privatefinalString contextPath;//  @Autowired//  public WebMvcRequestHandlerProvider(//      Optional<ServletContext> servletContext,//      HandlerMethodResolver methodResolver,//      List<RequestMappingInfoHandlerMapping> handlerMappings) {//    this.handlerMappings = handlerMappings;//    this.methodResolver = methodResolver;//    this.contextPath = servletContext//        .map(ServletContext::getContextPath)//        .orElse(ROOT);//  }@AutowiredpublicWebMvcRequestHandlerProvider(Optional<ServletContext> servletContext,HandlerMethodResolver methodResolver,List<RequestMappingInfoHandlerMapping> handlerMappings){this.handlerMappings= handlerMappings.stream().filter(mapping-> mapping.getPatternParser()==null).collect(Collectors.toList());this.methodResolver= methodResolver;this.contextPath= servletContext.map(ServletContext::getContextPath).orElse(ROOT);}@OverridepublicList<RequestHandler>requestHandlers(){returnnullToEmptyList(handlerMappings).stream().filter(requestMappingInfoHandlerMapping->!("org.springframework.integration.http.inbound.IntegrationRequestMappingHandlerMapping".equals(requestMappingInfoHandlerMapping.getClass().getName()))).map(toMappingEntries()).flatMap((entries->StreamSupport.stream(entries.spliterator(),false))).map(toRequestHandler()).sorted(byPatternsCondition()).collect(toList());}privateFunction<RequestMappingInfoHandlerMapping,Iterable<Map.Entry<RequestMappingInfo,HandlerMethod>>>toMappingEntries(){return input-> input.getHandlerMethods().entrySet();}privateFunction<Map.Entry<RequestMappingInfo,HandlerMethod>,RequestHandler>toRequestHandler(){return input->newWebMvcRequestHandler(
                contextPath,
                methodResolver,
                input.getKey(),
                input.getValue());}}

在项目下建一个同名包springfox.documentation.spring.web.plugins
在这里插入图片描述

拷贝上面的类内容，修改其构造器为：

@AutowiredpublicWebMvcRequestHandlerProvider(Optional<ServletContext> servletContext,HandlerMethodResolver methodResolver,List<RequestMappingInfoHandlerMapping> handlerMappings){this.handlerMappings= handlerMappings.stream().filter(mapping->Objects.isNull(mapping.getPatternParser())).collect(Collectors.toList());this.methodResolver= methodResolver;this.contextPath= servletContext.map(ServletContext::getContextPath).orElse(ROOT);}

修改后完整的类

/*
 *
 *  Copyright 2015-2017 the original author or authors.
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *
 */packagespringfox.documentation.spring.web.plugins;importorg.springframework.beans.factory.annotation.Autowired;importorg.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;importorg.springframework.context.annotation.Conditional;importorg.springframework.core.Ordered;importorg.springframework.core.annotation.Order;importorg.springframework.stereotype.Component;importorg.springframework.web.method.HandlerMethod;importorg.springframework.web.servlet.mvc.method.RequestMappingInfo;importorg.springframework.web.servlet.mvc.method.RequestMappingInfoHandlerMapping;importspringfox.documentation.RequestHandler;importspringfox.documentation.spi.service.RequestHandlerProvider;importspringfox.documentation.spring.web.OnServletBasedWebApplication;importspringfox.documentation.spring.web.WebMvcRequestHandler;importspringfox.documentation.spring.web.readers.operation.HandlerMethodResolver;importjavax.servlet.ServletContext;importjava.util.List;importjava.util.Map;importjava.util.Optional;importjava.util.function.Function;importjava.util.stream.Collectors;importjava.util.stream.StreamSupport;importstaticjava.util.stream.Collectors.*;importstaticspringfox.documentation.builders.BuilderDefaults.*;importstaticspringfox.documentation.spi.service.contexts.Orderings.*;importstaticspringfox.documentation.spring.web.paths.Paths.*;@Component@Order(Ordered.HIGHEST_PRECEDENCE)@ConditionalOnWebApplication(type=ConditionalOnWebApplication.Type.SERVLET)@Conditional(OnServletBasedWebApplication.class)publicclassWebMvcRequestHandlerProviderimplementsRequestHandlerProvider{privatefinalList<RequestMappingInfoHandlerMapping> handlerMappings;privatefinalHandlerMethodResolver methodResolver;privatefinalString contextPath;//  @Autowired//  public WebMvcRequestHandlerProvider(//      Optional<ServletContext> servletContext,//      HandlerMethodResolver methodResolver,//      List<RequestMappingInfoHandlerMapping> handlerMappings) {//    this.handlerMappings = handlerMappings;//    this.methodResolver = methodResolver;//    this.contextPath = servletContext//        .map(ServletContext::getContextPath)//        .orElse(ROOT);//  }@AutowiredpublicWebMvcRequestHandlerProvider(Optional<ServletContext> servletContext,HandlerMethodResolver methodResolver,List<RequestMappingInfoHandlerMapping> handlerMappings){this.handlerMappings= handlerMappings.stream().filter(mapping->Objects.isNull(mapping.getPatternParser())).collect(Collectors.toList());this.methodResolver= methodResolver;this.contextPath= servletContext.map(ServletContext::getContextPath).orElse(ROOT);}@OverridepublicList<RequestHandler>requestHandlers(){returnnullToEmptyList(handlerMappings).stream().filter(requestMappingInfoHandlerMapping->!("org.springframework.integration.http.inbound.IntegrationRequestMappingHandlerMapping".equals(requestMappingInfoHandlerMapping.getClass().getName()))).map(toMappingEntries()).flatMap((entries->StreamSupport.stream(entries.spliterator(),false))).map(toRequestHandler()).sorted(byPatternsCondition()).collect(toList());}privateFunction<RequestMappingInfoHandlerMapping,Iterable<Map.Entry<RequestMappingInfo,HandlerMethod>>>toMappingEntries(){return input-> input.getHandlerMethods().entrySet();}privateFunction<Map.Entry<RequestMappingInfo,HandlerMethod>,RequestHandler>toRequestHandler(){return input->newWebMvcRequestHandler(
                contextPath,
                methodResolver,
                input.getKey(),
                input.getValue());}}

在配置文件内将匹配方式改为ant

spring.mvc.pathmatch.matching-strategy=ant-path-matcher

至此解决了问题，其实是把不符合规则的控制器过滤器掉了。
另外吐槽一下，swagger更新到3.0后一年不更新了，怎么个意思？
有人在评论区吐槽不够优雅，经过试验再更新两种方式

3、解决办法2

添加一个BeanPostProcessor，在postProcessAfterInitialization中修改WebMvcRequestHandlerProvider中的handlerMappings属性，这种方式其实更第一种是一样的，这样不用覆盖原有类，更优雅一些。

  • 作者：码农-文若书生
  • 原文链接：https://blog.csdn.net/u011943534/article/details/121656010
    更新时间：2022-07-25 12:47:15