springboot接入springfox報錯documentationPluginsBootstrapper

一、前言

簡單理解:

swagger第一版:io.swagger
swagger第二版:io.swagger.core.v3
swagger第三版:open-api

二、正文

springboot2.7接入springfox-swagger2遇到的問題,以及解決方案_springboot 2.7 swagger-CSDN博客

documentationPluginsBootstrapper 錯誤 - 簡書 (jianshu.com)

import org.springframework.beans.BeansException;
import org.springframework.beans.factory.config.BeanPostProcessor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.lang.NonNull;
import org.springframework.util.ReflectionUtils;
import org.springframework.web.servlet.mvc.method.RequestMappingInfoHandlerMapping;
import springfox.documentation.spring.web.plugins.WebFluxRequestHandlerProvider;
import springfox.documentation.spring.web.plugins.WebMvcRequestHandlerProvider;

import java.lang.reflect.Field;
import java.util.List;
import java.util.stream.Collectors;


@Configuration
public class SwaggerConfig {

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

            @Override
            public Object postProcessAfterInitialization(@NonNull  Object bean, @NonNull 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");
                    assert field != null;
                    field.setAccessible(true);
                    return (List<RequestMappingInfoHandlerMapping>) field.get(bean);
                } catch (IllegalArgumentException | IllegalAccessException e) {
                    throw new IllegalStateException(e);
                }
            }
        };
    }
}

加入後啓動正常,但是訪問swagger的/v2/api-docs接口和/swagger-ui/index.html,發現沒有獲得數據,接口內容是空的。
這是通過搜索得到有幾種解決方案
1、ShortVideoSwagger2的配置類增加@EnableWebMvc註解
2、ShortVideoSwagger2的配置類需要集成WebMvcConfigurationSupport
3、springboot的配置增加增加一下配置:spring.mvc.pathmatch.matching-strategy=ANT_PATH_MATCHER

通過試驗得知,這三種方式都可以解決,但是前都有副作用的
1和2會破壞springboot對springwebmvc的自動裝配,導致自定義的一些convertor或者ObjectMapper失效(@EnableWebMvc建議慎用,最好在非springboot項目中使用)。
3是因爲springboot2.6以後版本的matching-strategy默認的改爲了PATH_PATTERN_PARSER,把它改爲ANT_PATH_MATCHER就可以了。注意:此方法在某些服務啓動時會失效!這個方法治標不治本,只有在不使用 SpringBoot的執行器時,此功能才起作用。無論配置的匹配策略如何,執行器將始終使用基於路徑模式的解析(也就是默認策略)。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章