documentationPluginsBootstrapper 错误

1.我们查看springboot版本 是2.6.4 发现 spirngboot 版本太高 导致 swagger 集成报错了






问题

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);

            }

        }

    };

}

4.最终方案

public class Swagger2Configurationextends WebMvcConfigurationSupport {

@Override

    public void addResourceHandlers(ResourceHandlerRegistry registry) {

registry.addResourceHandler("/**").addResourceLocations(

"classpath:/static/");

        registry.addResourceHandler("swagger-ui.html", "doc.html").addResourceLocations(

"classpath:/META-INF/resources/");

        registry.addResourceHandler("/webjars/**").addResourceLocations(

"classpath:/META-INF/resources/webjars/");

        super.addResourceHandlers(registry);

    }

@Bean

    public static BeanPostProcessorspringfoxHandlerProviderBeanPostProcessor() {

return new BeanPostProcessor() {

@Override

            public ObjectpostProcessAfterInitialization(Object bean, String beanName)throws BeansException {

if (beaninstanceof WebMvcRequestHandlerProvider || beaninstanceof WebFluxAutoConfiguration) {

customizeSpringfoxHandlerMappings(getHandlerMappings(bean));

                }

return bean;

            }

private void customizeSpringfoxHandlerMappings(List mappings) {

List copy = mappings.stream()

.filter(mapping -> mapping.getPatternParser() ==null)

.collect(Collectors.toList());

                mappings.clear();

                mappings.addAll(copy);

            }

@SuppressWarnings("unchecked")

private ListgetHandlerMappings(Object bean) {

try {

Field field = ReflectionUtils.findField(bean.getClass(), "handlerMappings");

                    field.setAccessible(true);

                    return (List) field.get(bean);

                }catch (IllegalArgumentException | IllegalAccessException e) {

throw new IllegalStateException(e);

                }

}

};

    }


最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容