Spring Boot 2.6.x整合Swagger啟動失敗報錯問題的完美解決辦法

Posted on by

問題

Spring Boot 2.6.x版本引入依賴 springfox-boot-starter (Swagger 3.0) 後，啟動容器會報錯：

Failed to start bean ‘ documentationPluginsBootstrapper ‘ ; nested exception…

原因

Springfox 假設 Spring MVC 的路徑匹配策略是 ant-path-matcher，而 Spring Boot 2.6.x版本的默認匹配策略是 path-pattern-matcher，這就造成瞭上面的報錯。

解決方案

方案一（治標）

在 application.properties 配置文件中修改mvc的匹配策略：

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

註意：開始的時候我用這個方法的確可以正常啟動瞭，但後來我發現此方法在某些服務啟動時會失效！我查瞭一下才發現這個方法治標不治本，具體如下：

隻有在不使用 Spring Boot 的執行器時，此功能才起作用。

無論配置的匹配策略如何，執行器將始終使用基於路徑模式的解析 ( 也就是默認策略 ) 。

如果您想在 Spring Boot 2.6及更高版本中將其與執行器一起使用，則需要對 Springfox 進行更改。

所以解鈴還須系鈴人吶！要想徹底解決這個bug，需要修改的是 Springfox 。

方案二（治本）

這個辦法是我在 github 上找到的，一個大佬提瞭一個解決方案是將 Springfox 的某 .java 文件復制到自己項目裡進行修改，另一個大佬提瞭一個更好的解決方案，我覺得針不戳，在這裡分享一下：

在你的項目裡添加這個 bean ：（加在配置類裡就可）

@Bean
public static BeanPostProcessor springfoxHandlerProviderBeanPostProcessor() {
    return new BeanPostProcessor() {

        @Override
        public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
            if (bean instanceof WebMvcRequestHandlerProvider || bean instanceof WebFluxRequestHandlerProvider) {
                customizeSpringfoxHandlerMappings(getHandlerMappings(bean));
            }
            return bean;
        }

        private <T extends RequestMappingInfoHandlerMapping> void customizeSpringfoxHandlerMappings(List<T> mappings) {
            List<T> copy = mappings.stream()
                    .filter(mapping -> mapping.getPatternParser() == null)
                    .collect(Collectors.toList());
            mappings.clear();
            mappings.addAll(copy);
        }

        @SuppressWarnings("unchecked")
        private List<RequestMappingInfoHandlerMapping> getHandlerMappings(Object bean) {
            try {
                Field field = ReflectionUtils.findField(bean.getClass(), "handlerMappings");
                field.setAccessible(true);
                return (List<RequestMappingInfoHandlerMapping>) field.get(bean);
            } catch (IllegalArgumentException | IllegalAccessException e) {
                throw new IllegalStateException(e);
            }
        }
    };
}

OK，啟動成功！

補充：springboot集成swagger，啟動時拋出如下錯誤：

18:03:03.586 [main] INFO  o.s.b.a.l.ConditionEvaluationReportLoggingListener –
Error starting ApplicationContext. To display the conditions report re-run your application with 'debug' enabled.
18:03:03.601 [main] ERROR o.s.b.d.LoggingFailureAnalysisReporter –

***************************
APPLICATION FAILED TO START
***************************
Description:
Parameter 0 of method linkDiscoverers in org.springframework.hateoas.config.HateoasConfiguration required a single bean, but 15 were found:
    – modelBuilderPluginRegistry: defined in null
    – modelPropertyBuilderPluginRegistry: defined in null
    – typeNameProviderPluginRegistry: defined in null
    – documentationPluginRegistry: defined in null
    – apiListingBuilderPluginRegistry: defined in null
    – operationBuilderPluginRegistry: defined in null
    – parameterBuilderPluginRegistry: defined in null
    – expandedParameterBuilderPluginRegistry: defined in null
    – resourceGroupingStrategyRegistry: defined in null
    – operationModelsProviderPluginRegistry: defined in null
    – defaultsProviderPluginRegistry: defined in null
    – pathDecoratorRegistry: defined in null
    – relProviderPluginRegistry: defined by method 'relProviderPluginRegistry' in class path resource [org/springframework/hateoas/config/HateoasConfiguration.class]
    – linkDiscovererRegistry: defined in null
    – entityLinksPluginRegistry: defined by method 'entityLinksPluginRegistry' in class path resource [org/springframework/hateoas/config/WebMvcEntityLinksConfiguration.class]

原因：

swagger版本問題，我本地springboot版本是2.3.1，引用swaggerb版本為2.2.2，導致項目啟動失敗

解決方案：

更換swagger版本，我這裡換成瞭2.9.2版本，項目啟動成功

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>

總結

到此這篇關於Spring Boot 2.6.x整合Swagger啟動失敗報錯問題的完美解決辦法的文章就介紹到這瞭,更多相關Spring Boot 2.6.x整合Swagger啟動失敗內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：