[Java知识库]Spring Boot 2.7.3整合Swagger启动失败Failed to start bean ‘documentationPluginsBootstrapper‘

问题

Spring Boot 2.7.3版本引入依赖 springfox-boot-starter (Swagger 3.0) 后，启动容器会报错：

org.springframework.context.ApplicationContextException: Failed to start bean 'documentationPluginsBootstrapper'; nested exception is java.lang.NullPointerException

原因

Springfox 假设 Spring MVC 的路径匹配策略是 ant-path-matcher，而 Spring Boot 2.6以上版本的默认匹配策略是 path-pattern-matcher，这就造成了上面的报错。

解决方案

方案一（治标）

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

spring :
  mvc:
    pathmatch:
      matching-strategy: ant-path-matcher

注意：开始的时候我用这个方法的确可以正常启动了，但后来我发现此方法在某些服务启动时会失效！我查了一下才发现这个方法治标不治本，具体如下：

只有在不使用 Spring Boot 的执行器时，此功能才起作用。
无论配置的匹配策略如何，执行器将始终使用基于路径模式的解析 ( 也就是默认策略 ) 。
如果您想在 Spring Boot 2.6及更高版本中将其与执行器一起使用，则需要对 Springfox 进行更改。所以解铃还须系铃人呐！要想彻底解决这个bug，需要修改的是 Springfox 。

方案二（治标）

重写一个 WebMvcConfigurer实现类，然后开启@EnableWebMvc注解：

@Configuration
@EnableWebMvc
public class WebMvcConfig implements WebMvcConfigurer {
     @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
		//兼容swagger老版本v1,v2
        registry.addResourceHandler("/statics/**").addResourceLocations("classpath:/statics/");
        registry.addResourceHandler("swagger-ui.html").addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
        registry.addResourceHandler("/swagger-ui/**").addResourceLocations("classpath:/META-INF/resources/webjars/springfox-swagger-ui/");
		registry.addResourceHandler("doc.html").addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/**").addResourceLocations("classpath:/META-INF/resources/").setCachePeriod(0);
    }
}

注意：这种方法会破坏sprijngboot自带的mvc自动装配配置项，导致默认的一些静态目录功能无法使用，只能重写addResourceHandlers方法，需要手动把静态目录指定一下

在Spring Boot 2.7.2版本中，查看默认静态资源路径，在WebProperties.class中如下

private static final String[] CLASSPATH_RESOURCE_LOCATIONS = new String[]{"classpath:/META-INF/resources/", "classpath:/resources/", "classpath:/static/", "classpath:/public/"};

可以看到默认资源路径有4个。
使用Spring Initializr新建Spring Boot项目，自带static目录，直接将前端资源文件放到该目录下，启动项目，访问http://localhost:端口号/资源目录/名称.html即可；
例如，有一个front目录，该目录下存在一个index.html文件，将此目录放于src/main/resources/static下，并且未修改端口号，访问http://localhost:8080/front/index.html即可看到访问成功。

方案三（治本）

这个办法是我在 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，启动成功！
————————————————
参考链接：https://blog.csdn.net/weixin_49523761/article/details/122305980