记录 io.springfox 3.0.0 整合 spring boot 2.6.x 由于 springfox bug 引发问题

首先第一个问题就是不兼容:

解决方案:

java 复制代码
	@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);
	            }
	        }
	    };
	}

其二增加配置:

复制代码
spring:
  mvc:
    pathmatch:
      matching-strategy: ANT_PATH_MATCHER  

而其中 springfox 中的一个 bug 就是,你在使用注解:paramType 由于没有使用指定的类型:path、query、body、header和form 导致启动解析的时候 enum 直接异常,导致整个项目所有注解都没有加载到系统内。解决办法:

  1. 把不正确的地方修改。

2.修改源码

源码修改如下:

java 复制代码
@Component
@Order(SwaggerPluginSupport.SWAGGER_PLUGIN_ORDER)
@SuppressWarnings("deprecation")
public class OperationImplicitParametersReader implements OperationBuilderPlugin {
	private static final Logger LOGGER = LoggerFactory.getLogger(OperationImplicitParametersReader.class);
	
	private final DescriptionResolver descriptions;

	@Autowired
	public OperationImplicitParametersReader(DescriptionResolver descriptions) {
		this.descriptions = descriptions;
	}

	@Override
	public void apply(OperationContext context) {
		List<Compatibility<springfox.documentation.service.Parameter, RequestParameter>> parameters
		= readParameters(context);
		context.operationBuilder().parameters(parameters.stream()
				.map(Compatibility::getLegacy)
				.filter(Optional::isPresent)
				.map(Optional::get)
				.collect(Collectors.toList()));
		context.operationBuilder().requestParameters(parameters.stream()
				.map(Compatibility::getModern)
				.filter(Optional::isPresent)
				.map(Optional::get)
				.collect(Collectors.toList()));
	}

	@Override
	public boolean supports(DocumentationType delimiter) {
		return pluginDoesApply(delimiter);
	}

	private List<Compatibility<springfox.documentation.service.Parameter, RequestParameter>>
	readParameters(OperationContext context) {
		List<ApiImplicitParams> annotations = context.findAllAnnotations(ApiImplicitParams.class);

		List<Compatibility<springfox.documentation.service.Parameter, RequestParameter>> parameters = new ArrayList<>();
		if (!annotations.isEmpty()) {
			for (ApiImplicitParams annotation : annotations) {
				for (ApiImplicitParam param : annotation.value()) {
					Compatibility  compatibility = null;
					try {
						compatibility = OperationImplicitParameterReader.implicitParameter(descriptions, param);
					}catch(Exception e) {
						LOGGER.error(String.format("Unable to scan documentation Compatibility- ApiImplicitParam %s", param.value()), e);
						continue;
					}
					parameters.add(compatibility);
				}
			}
		}
		return parameters;
	}
}

关键修改:

Compatibility compatibility = null;

try {

compatibility = OperationImplicitParameterReader.implicitParameter(descriptions, param);

}catch(Exception e) {//在这个地方补货异常,并将异常处理,不往上抛

LOGGER.error(String.format("Unable to scan documentation Compatibility- ApiImplicitParam %s", param.value()), e);

continue;

}

parameters.add(compatibility);

相关推荐
全干engineer2 小时前
Spring Boot 实现主表+明细表 Excel 导出(EasyPOI 实战)
java·spring boot·后端·excel·easypoi·excel导出
Paper_Love2 小时前
x86-64_windows交叉编译arm_linux程序
arm开发·windows
a_Dragon12 小时前
Spring Boot多环境开发-Profiles
java·spring boot·后端·intellij-idea
ChinaRainbowSea2 小时前
补充:问题:CORS ,前后端访问跨域问题
java·spring boot·后端·spring
前端若水3 小时前
通过 Windows 共享文件夹 + 手机访问(SMB协议)如何实现
windows·智能手机
全栈凯哥6 小时前
02.SpringBoot常用Utils工具类详解
java·spring boot·后端
RainbowSea8 小时前
跨域问题(Allow CORS)解决(3 种方法)
java·spring boot·后端
RainbowSea8 小时前
问题 1:MyBatis-plus-3.5.9 的分页功能修复
java·spring boot·mybatis
sniper_fandc10 小时前
SpringBoot系列—入门
java·spring boot·后端
超龄超能程序猿13 小时前
dnSpy 使用教程
windows·microsoft