• 解决springboot2.6和swagger冲突的问题

    最近要将后台服务从SpringBoot1升级到2版本，主要目的是为了使用SpringBoot2的实时监控功能。集成的时候无法启动，根据日志判断与swagger有关。信息如下：

    1. org.springframework.context.ApplicationContextException: Failed to start bean 'documentationPluginsBootstrapper'; nested exception is java.lang.NullPointerException
    2. 	at org.springframework.context.support.DefaultLifecycleProcessor.doStart(DefaultLifecycleProcessor.java:181) ~[spring-context-5.3.13.jar:5.3.13]
    3. 	at org.springframework.context.support.DefaultLifecycleProcessor.access$200(DefaultLifecycleProcessor.java:54) ~[spring-context-5.3.13.jar:5.3.13]
    4. 	at org.springframework.context.support.DefaultLifecycleProcessor$LifecycleGroup.start(DefaultLifecycleProcessor.java:356) ~[spring-context-5.3.13.jar:5.3.13]
    5. 	at java.lang.Iterable.forEach(Iterable.java:75) ~[?:?]
    6. 	at org.springframework.context.support.DefaultLifecycleProcessor.startBeans(DefaultLifecycleProcessor.java:155) ~[spring-context-5.3.13.jar:5.3.13]
    7. 	at org.springframework.context.support.DefaultLifecycleProcessor.onRefresh(DefaultLifecycleProcessor.java:123) ~[spring-context-5.3.13.jar:5.3.13]
    8. 	at org.springframework.context.support.AbstractApplicationContext.finishRefresh(AbstractApplicationContext.java:935) ~[spring-context-5.3.13.jar:5.3.13]
    9. 	at org.springframework.context.support.AbstractApplicationContext.refresh(AbstractApplicationContext.java:586) ~[spring-context-5.3.13.jar:5.3.13]
    10. 	at org.springframework.boot.web.servlet.context.ServletWebServerApplicationContext.refresh(ServletWebServerApplicationContext.java:145) ~[spring-boot-2.6.1.jar:2.6.1]
    11. 	at org.springframework.boot.SpringApplication.refresh(SpringApplication.java:730) ~[spring-boot-2.6.1.jar:2.6.1]
    12. 	at org.springframework.boot.SpringApplication.refreshContext(SpringApplication.java:412) ~[spring-boot-2.6.1.jar:2.6.1]
    13. 	at org.springframework.boot.SpringApplication.run(SpringApplication.java:302) ~[spring-boot-2.6.1.jar:2.6.1]
    14. 	at com.iscas.biz.BizApp.main(BizApp.java:69) ~[classes/:?]
    15. Caused by: java.lang.NullPointerException
    16. 	at springfox.documentation.spring.web.WebMvcPatternsRequestConditionWrapper.getPatterns(WebMvcPatternsRequestConditionWrapper.java:56) ~[springfox-spring-webmvc-3.0.0.jar:3.0.0]
    17. 	at springfox.documentation.RequestHandler.sortedPaths(RequestHandler.java:113) ~[springfox-core-3.0.0.jar:3.0.0]
    18. 	at springfox.documentation.spi.service.contexts.Orderings.lambda$byPatternsCondition$3(Orderings.java:89) ~[springfox-spi-3.0.0.jar:3.0.0]
    19. 	at java.util.Comparator.lambda$comparing$77a9974f$1(Comparator.java:469) ~[?:?]
    20. 	at java.util.TimSort.countRunAndMakeAscending(TimSort.java:355) ~[?:?]
    21. 	at java.util.TimSort.sort(TimSort.java:234) ~[?:?]
    22. 	at java.util.Arrays.sort(Arrays.java:1515) ~[?:?]
    23. 	at java.util.ArrayList.sort(ArrayList.java:1750) ~[?:?]
    24. 	at java.util.stream.SortedOps$RefSortingSink.end(SortedOps.java:392) ~[?:?]
    25. 	at java.util.stream.Sink$ChainedReference.end(Sink.java:258) ~[?:?]
    26. 	at java.util.stream.Sink$ChainedReference.end(Sink.java:258) ~[?:?]
    27. 	at java.util.stream.Sink$ChainedReference.end(Sink.java:258) ~[?:?]
    28. 	at java.util.stream.Sink$ChainedReference.end(Sink.java:258) ~[?:?]
    29. 	at java.util.stream.AbstractPipeline.copyInto(AbstractPipeline.java:485) ~[?:?]
    30. 	at java.util.stream.AbstractPipeline.wrapAndCopyInto(AbstractPipeline.java:474) ~[?:?]
    31. 	at java.util.stream.ReduceOps$ReduceOp.evaluateSequential(ReduceOps.java:913) ~[?:?]
    32. 	at java.util.stream.AbstractPipeline.evaluate(AbstractPipeline.java:234) ~[?:?]
    33. 	at java.util.stream.ReferencePipeline.collect(ReferencePipeline.java:578) ~[?:?]
    34. 	at springfox.documentation.spring.web.plugins.WebMvcRequestHandlerProvider.requestHandlers(WebMvcRequestHandlerProvider.java:81) ~[springfox-spring-webmvc-3.0.0.jar:3.0.0]
    35. 	at java.util.stream.ReferencePipeline$3$1.accept(ReferencePipeline.java:195) ~[?:?]
    36. 	at java.util.ArrayList$ArrayListSpliterator.forEachRemaining(ArrayList.java:1655) ~[?:?]
    37. 	at java.util.stream.AbstractPipeline.copyInto(AbstractPipeline.java:484) ~[?:?]
    38. 	at java.util.stream.AbstractPipeline.wrapAndCopyInto(AbstractPipeline.java:474) ~[?:?]
    39. 	at java.util.stream.ReduceOps$ReduceOp.evaluateSequential(ReduceOps.java:913) ~[?:?]
    40. 	at java.util.stream.AbstractPipeline.evaluate(AbstractPipeline.java:234) ~[?:?]
    41. 	at java.util.stream.ReferencePipeline.collect(ReferencePipeline.java:578) ~[?:?]
    42. 	at springfox.documentation.spring.web.plugins.AbstractDocumentationPluginsBootstrapper.withDefaults(AbstractDocumentationPluginsBootstrapper.java:107) ~[springfox-spring-web-3.0.0.jar:3.0.0]
    43. 	at springfox.documentation.spring.web.plugins.AbstractDocumentationPluginsBootstrapper.buildContext(AbstractDocumentationPluginsBootstrapper.java:91) ~[springfox-spring-web-3.0.0.jar:3.0.0]
    44. 	at springfox.documentation.spring.web.plugins.AbstractDocumentationPluginsBootstrapper.bootstrapDocumentationPlugins(AbstractDocumentationPluginsBootstrapper.java:82) ~[springfox-spring-web-3.0.0.jar:3.0.0]
    45. 	at springfox.documentation.spring.web.plugins.DocumentationPluginsBootstrapper.start(DocumentationPluginsBootstrapper.java:100) ~[springfox-spring-web-3.0.0.jar:3.0.0]
    46. 	at org.springframework.context.support.DefaultLifecycleProcessor.doStart(DefaultLifecycleProcessor.java:178) ~[spring-context-5.3.13.jar:5.3.13]
    47. 	... 12 more

    查了半天，一个解释是springboot修改了请求路由匹配策略，

    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

    一种解决办法是手动创建一个配置类，来修改路由规则，在你工程创建一个包：

    springfox.documentation.spring.web.plugins

    注意这里必须使用上面的包名，这样才 能代替springfox自带的。

    然后创建一个类，完整代码如下：

    1. /**
    2.  * springboot升级到2.6后和swagger出现冲突，这是springboot修改了请求路由匹配策略造成的。
    3.  * Spring MVC 处理程序映射匹配请求路径的默认策略已从 AntPathMatcher 更改为PathPatternParser，导致swagger加载失败，
    4.  * 这里手动设置一下
    5.  */
    7. package springfox.documentation.spring.web.plugins;
    8.  
    9. import org.springframework.beans.factory.annotation.Autowired;
    10. import org.springframework.core.annotation.Order;
    11. import org.springframework.stereotype.Component;
    12. import org.springframework.web.method.HandlerMethod;
    13. import org.springframework.web.servlet.mvc.method.RequestMappingInfo;
    14. import org.springframework.web.servlet.mvc.method.RequestMappingInfoHandlerMapping;
    15. import springfox.documentation.RequestHandler;
    16. import springfox.documentation.builders.BuilderDefaults;
    17. import springfox.documentation.spi.service.RequestHandlerProvider;
    18. import springfox.documentation.spi.service.contexts.Orderings;
    19. import springfox.documentation.spring.web.WebMvcRequestHandler;
    20. import springfox.documentation.spring.web.readers.operation.HandlerMethodResolver;
    21.  
    22. import javax.servlet.ServletContext;
    23. import java.util.List;
    24. import java.util.Map.Entry;
    25. import java.util.Objects;
    26. import java.util.Optional;
    27. import java.util.function.Function;
    28. import java.util.stream.Collectors;
    29. import java.util.stream.StreamSupport;
    30.  
    31. import static springfox.documentation.spring.web.paths.Paths.ROOT;
    32.  
    33. @Component
    34. @Order(-2147483648)
    35. public class WebMvcRequestHandlerProvider implements RequestHandlerProvider {
    36.     private final List<RequestMappingInfoHandlerMapping> handlerMappings;
    37.     private final HandlerMethodResolver methodResolver;
    38.     private final String contextPath;
    39.  
    40.     @Autowired
    41.     public WebMvcRequestHandlerProvider(Optional<ServletContext> servletContext, HandlerMethodResolver methodResolver, List<RequestMappingInfoHandlerMapping> handlerMappings) {
    42.         this.handlerMappings = handlerMappings.stream().filter(mapping -> Objects.isNull(mapping.getPatternParser())).collect(Collectors.toList());
    43.         this.methodResolver = methodResolver;
    44.         this.contextPath = servletContext
    45.                 .map(ServletContext::getContextPath)
    46.                 .orElse(ROOT);
    47.     }
    48.  
    49.     public List<RequestHandler> requestHandlers() {
    50.         return (List)BuilderDefaults.nullToEmptyList(this.handlerMappings).stream().filter((requestMappingInfoHandlerMapping) -> {
    51.             return !"org.springframework.integration.http.inbound.IntegrationRequestMappingHandlerMapping".equals(requestMappingInfoHandlerMapping.getClass().getName());
    52.         }).map(this.toMappingEntries()).flatMap((entries) -> {
    53.             return StreamSupport.stream(entries.spliterator(), false);
    54.         }).map(this.toRequestHandler()).sorted(Orderings.byPatternsCondition()).collect(Collectors.toList());
    55.     }
    56.  
    57.     private Function<RequestMappingInfoHandlerMapping, Iterable<Entry<RequestMappingInfo, HandlerMethod>>> toMappingEntries() {
    58.         return (input) -> {
    59.             return input.getHandlerMethods().entrySet();
    60.         };
    61.     }
    62.  
    63.     private Function<Entry<RequestMappingInfo, HandlerMethod>, RequestHandler> toRequestHandler() {
    64.         return (input) -> {
    65.             return new WebMvcRequestHandler(this.contextPath, this.methodResolver, (RequestMappingInfo)input.getKey(), (HandlerMethod)input.getValue());
    66.         };
    67.     }
    68. }

    上面代码的核心是修改了构造器的实现代码，你可以与原始的对照一下，就是把不符合规则的控制器过滤器掉了。

    这样就能解决问题了。

    网上还有人说这样解决不优雅，其他的方式没有使用，这里一起附上，供你参考：

    第二种参考方法

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

    1. package com.iscas.biz.config;
    2.  
    3. /**
    4.  * 自定义BeanPostProcessor
    5.  *
    6.  * @author zhuquanwen
    7.  * @version 1.0
    8.  * @date 2021/12/29
    9.  * @since jdk11/
    10.  */
    11. @SuppressWarnings({"unused", "unchecked"})
    12. @Component
    13. @Slf4j
    14. public class MyBeanPostProcessor implements BeanPostProcessor {
    15.     @Autowired
    16.     private DefaultListableBeanFactory defaultListableBeanFactory;
    17.  
    18.     @Override
    19.     public Object postProcessBeforeInitialization(@NotNull Object bean, @NotNull String beanName) throws BeansException {
    20.         return bean;
    21.     }
    22.  
    23.     @Override
    24.     public Object postProcessAfterInitialization(@NotNull Object bean, @NotNull String beanName) throws BeansException {
    25.         handleWebMvcRequestHandlerProvider(beanName, bean);
    26.         return bean;
    27.     }
    28.  
    29.     private void handleWebMvcRequestHandlerProvider(String beanName, Object bean) {
    30.         // 处理swagger 在spring boot2.6以上不可用的问题
    31.         boolean modify = (bean instanceof WebMvcRequestHandlerProvider || bean instanceof WebFluxRequestHandlerProvider) &&
    32.                 defaultListableBeanFactory.containsBean(beanName);
    33.         if (modify) {
    34.             // 修改属性
    35.             try {
    36.                 Field handlerMappingsField = bean.getClass().getDeclaredField("handlerMappings");
    37.                 ReflectUtils.makeAccessible(handlerMappingsField);
    38.                 List<RequestMappingInfoHandlerMapping> handlerMappings = (List<RequestMappingInfoHandlerMapping>) handlerMappingsField.get(bean);
    39.                 List<RequestMappingInfoHandlerMapping> tmpHandlerMappings = handlerMappings.stream().filter(mapping -> Objects.isNull(mapping.getPatternParser())).collect(Collectors.toList());
    40.                 handlerMappings.clear();
    41.                 handlerMappings.addAll(tmpHandlerMappings);
    42.             } catch (Exception e) {
    43.                 log.warn("修改WebMvcRequestHandlerProvider的属性：handlerMappings出错，可能导致swagger不可用", e);
    44.             }
    45.         }
    46.     }
    47. }
    48.

    ReflectUtils.makeAccessible的方法：

    1.     public static void makeAccessible(Field field) {
    2.         if ((!Modifier.isPublic(field.getModifiers()) ||
    3.                 !Modifier.isPublic(field.getDeclaringClass().getModifiers()) ||
    4.                 Modifier.isFinal(field.getModifiers())) && !field.isAccessible()) {
    5.             field.setAccessible(true);
    6.         }
    7.     }

    第三种解决办法 

    这种是最优雅的方式，我测试时发现并没有生效，暂且一起附上吧，希望对你有用：

    注册一个WebMvcEndpointHandlerMapping类。

    1. @Bean
    2.     public WebMvcEndpointHandlerMapping webEndpointServletHandlerMapping(WebEndpointsSupplier webEndpointsSupplier,
    3.                                                                          ServletEndpointsSupplier servletEndpointsSupplier,
    4.                                                                          ControllerEndpointsSupplier controllerEndpointsSupplier,
    5.                                                                          EndpointMediaTypes endpointMediaTypes,
    6.                                                                          CorsEndpointProperties corsProperties,
    7.                                                                          WebEndpointProperties webEndpointProperties,
    8.                                                                          Environment environment) {
    9.         List<ExposableEndpoint<?>> allEndpoints = new ArrayList<>();
    10.         Collection<ExposableWebEndpoint> webEndpoints = webEndpointsSupplier.getEndpoints();
    11.         allEndpoints.addAll(webEndpoints);
    12.         allEndpoints.addAll(servletEndpointsSupplier.getEndpoints());
    13.         allEndpoints.addAll(controllerEndpointsSupplier.getEndpoints());
    14.         String basePath = webEndpointProperties.getBasePath();
    15.         EndpointMapping endpointMapping = new EndpointMapping(basePath);
    16.         boolean shouldRegisterLinksMapping = this.shouldRegisterLinksMapping(webEndpointProperties, environment, basePath);
    17.         return new WebMvcEndpointHandlerMapping(endpointMapping, webEndpoints, endpointMediaTypes, corsProperties.toCorsConfiguration(),
    18.                 new EndpointLinksResolver(allEndpoints, basePath), shouldRegisterLinksMapping, null);
    19.     }
    20.  
    21.     private boolean shouldRegisterLinksMapping(WebEndpointProperties webEndpointProperties, Environment environment, String basePath) {
    22.  
    23.         return webEndpointProperties.getDiscovery().isEnabled() && (StringUtils.hasText(basePath) ||
    24.                 ManagementPortType.get(environment).equals(ManagementPortType.DIFFERENT));
    25.  
    26.     }

    之后在另外一个工程又遇到了类似的情况，但是上面的三种都不好使，所以又找到了第四种解决方法：

    第四种方法 

    在你的工程里创建一个配置类，内容如下：

    1. package com.fenbi.im.service.config;
    2.  
    3. import org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties;
    4. import org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties;
    5. import org.springframework.boot.actuate.autoconfigure.web.server.ManagementPortType;
    6. import org.springframework.boot.actuate.endpoint.ExposableEndpoint;
    7. import org.springframework.boot.actuate.endpoint.web.*;
    8. import org.springframework.boot.actuate.endpoint.web.annotation.ControllerEndpointsSupplier;
    9. import org.springframework.boot.actuate.endpoint.web.annotation.ServletEndpointsSupplier;
    10. import org.springframework.boot.actuate.endpoint.web.servlet.WebMvcEndpointHandlerMapping;
    11. import org.springframework.context.annotation.Bean;
    12. import org.springframework.context.annotation.Configuration;
    13. import org.springframework.core.env.Environment;
    14. import org.springframework.util.StringUtils;
    15. import org.springframework.web.bind.annotation.RestController;
    16. import springfox.documentation.builders.ApiInfoBuilder;
    17. import springfox.documentation.builders.PathSelectors;
    18. import springfox.documentation.builders.RequestHandlerSelectors;
    19. import springfox.documentation.service.ApiInfo;
    20. import springfox.documentation.service.Contact;
    21. import springfox.documentation.spi.DocumentationType;
    22. import springfox.documentation.spring.web.plugins.Docket;
    23.  
    24. import java.util.ArrayList;
    25. import java.util.Collection;
    26. import java.util.List;
    27.  
    28. /***
    29.  * @date 2022/10/26
    30.  * author https://blog.csdn.net/xueyushenzhou?type=blog
    31.  */
    32. @Configuration
    33. public class SpringFoxSwaggerConfig {
    34.     /**
    35.      * 配置基本信息
    36.      *
    37.      * @return
    38.      */
    39.     @Bean
    40.     public ApiInfo apiInfo() {
    41.         return new ApiInfoBuilder()
    42.                 .title("Swagger Test App Restful API")
    43.                 .description("swagger test app restful api")
    44.                 .termsOfServiceUrl("test")
    45.                 .contact(new Contact("haha", "https://blog.csdn.net/xueyushenzhou?type=blog", "abc@hotmail.com"))
    46.                 .version("1.0")
    47.                 .build();
    48.     }
    49.  
    50.     /**
    51.      * 配置文档生成最佳实践
    52.      *
    53.      * @param apiInfo
    54.      * @return
    55.      */
    56.     @Bean
    57.     public Docket createRestApi(ApiInfo apiInfo) {
    58.         return new Docket(DocumentationType.SWAGGER_2)
    59.                 .apiInfo(apiInfo)
    60.                 .groupName("SwaggerGroupOneAPI")
    61.                 .select()
    62.                 .apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
    63.                 .paths(PathSelectors.any())
    64.                 .build();
    65.     }
    66.  
    67.     /**
    68.      * 增加如下配置可解决Spring Boot 6.x 与Swagger 3.0.0 不兼容问题
    69.      **/
    70.     @Bean
    71.     public WebMvcEndpointHandlerMapping webEndpointServletHandlerMapping(WebEndpointsSupplier webEndpointsSupplier, ServletEndpointsSupplier servletEndpointsSupplier, ControllerEndpointsSupplier controllerEndpointsSupplier, EndpointMediaTypes endpointMediaTypes, CorsEndpointProperties corsProperties, WebEndpointProperties webEndpointProperties, Environment environment) {
    72.         List<ExposableEndpoint<?>> allEndpoints = new ArrayList();
    73.         Collection<ExposableWebEndpoint> webEndpoints = webEndpointsSupplier.getEndpoints();
    74.         allEndpoints.addAll(webEndpoints);
    75.         allEndpoints.addAll(servletEndpointsSupplier.getEndpoints());
    76.         allEndpoints.addAll(controllerEndpointsSupplier.getEndpoints());
    77.         String basePath = webEndpointProperties.getBasePath();
    78.         EndpointMapping endpointMapping = new EndpointMapping(basePath);
    79.         boolean shouldRegisterLinksMapping = this.shouldRegisterLinksMapping(webEndpointProperties, environment, basePath);
    80.         return new WebMvcEndpointHandlerMapping(endpointMapping, webEndpoints, endpointMediaTypes, corsProperties.toCorsConfiguration(), new EndpointLinksResolver(allEndpoints, basePath), shouldRegisterLinksMapping, null);
    81.     }
    82.  
    83.     private boolean shouldRegisterLinksMapping(WebEndpointProperties webEndpointProperties, Environment environment, String basePath) {
    84.         return webEndpointProperties.getDiscovery().isEnabled() && (StringUtils.hasText(basePath) || ManagementPortType.get(environment).equals(ManagementPortType.DIFFERENT));
    85.     }
    86. }

    这样也能解决，懒得研究原理，干脆都记下吧

    祝你顺利！

  • 相关阅读:
    面试题：Java序列化与反序列化
    防火墙原理讲解——练习实验
    高性能MySQL(第4版) 第一章 MySQL架构 读书笔记
    GRU-深度学习循环神经网络情感分类模型搭建
    【网络安全培训】无线局域网的安全威胁都有哪些?
    如何让 Docker Compose 等待依赖容器
    JVM区域划分
    阿里巴巴开源组件Easy Excel的Excel导入导出
    Mybatis速成（二）
    第2-3-3章 文件处理策略-文件存储服务系统-nginx/fastDFS/minio/阿里云oss/七牛云oss
  • 原文地址：https://blog.csdn.net/xueyushenzhou/article/details/127091559