问题

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，启动成功！

PS:经过实践，这个还是不行会导致访问不到接口文档，如果有成功的，可以留言学习下
————————————————
参考链接：https://blog.csdn.net/weixin_49523761/article/details/122305980

在 Spring Boot 3.0 中使用Swagger

在 Spring Boot 3.0 中使用 Swagger 所需要的依赖和 2.7 有所不同。

原因很简单，Spring Boot 3.0 是一次大版本升级，故造成了很多不兼容更新。

例如最低兼容的 Java 版本为 17，底层也切换到了 Spring 6。

所以自 2020 年以来没有更新过的 springfox-swagger2 和 springfox-swagger-ui 自然不会兼容 2022 年发布的 Spring Boot 3.0。

1.环境要求

请注意，运行 Spring Boot 3.0 必须要 Java 17 及以上，所以请升级你的 Java 版本！

• Java >= 17
• Maven >= 3.6

2.安装依赖

在 pox.xml 中添加如下依赖

<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
    <version>2.2.0</version>
</dependency>

3.添加配置

springdoc-openapi-starter-webmvc-ui默认情况下即可直接运行，无需其他配置。

你可以在 application.yml 中添加如下配置来设置 swagger-ui 的路径。

更多配置请参考官网：使用 Spring Doc 为 Spring REST API 生成 OpenAPI 3.0 文档 - spring 中文网

springdoc:
  swagger-ui:
    path: "/swagger-ui.html"

4.添加 Swagger 注解

由于更换了依赖，因此原先的注解自然也是不能用的，但实际上大同小异，写起来还是类似的。

参考代码如下：

package com.demo.controller;


import io.swagger.v3.oas.annotations.Operation;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

import java.util.Date;

@RestController
@RequestMapping("/demo")
public class DemoController {

    @Operation(summary = "测试实例", method = "GET") // 注解由原来的 ApiOperation 更改为 Operation ，但效果是一样的
    @RequestMapping(value = "/", method = RequestMethod.GET)
    public String test() {
        return "test";
    }
}

5.访问 Swagger 页面

默认情况下，访问http://127.0.0.1:8080/swagger-ui.html 即可看见 Swagger 页面。

------------------------------------------------------------分割线-------------------------------------------------

建议：

如果使用springboot2.6以上或者springboot3建议弃用springfox3，因为Springfox官方已经在2020就不维护了，且它也是一个过度版本，或者退回到2.9的版本，建议使用springdoc,可以通过Knife4j的增强功能，可以参考Knife4j版本参考 | Knife4j (xiaominfo.com)