SpringBoot2.7.15集成Springfox3.0

jsniyazhou

已于 2023-09-23 21:08:58 修改

阅读量589

点赞数

文章标签： spring boot java

于 2023-09-23 21:07:26 首次发布

本文链接：https://blog.csdn.net/jsniyazhou/article/details/133217307

版权

环境信息

操作系统：Windows 11

IDE：Eclipse 4.29

Java：JDK 1.8

集成步骤

Maven依赖

<dependency>

<groupId>io.springfox</groupId>

<artifactId>springfox-boot-starter</artifactId>

<version>3.0.0</version>

</dependency>

Springfox配置

创建配置类SpringfoxConfiguration.java


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

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
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.util.ReflectionUtils;
import org.springframework.web.servlet.mvc.method.RequestMappingInfoHandlerMapping;

import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.spring.web.plugins.WebFluxRequestHandlerProvider;
import springfox.documentation.spring.web.plugins.WebMvcRequestHandlerProvider;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SpringfoxConfiguration {

	private final static Logger logger = LoggerFactory.getLogger(SpringfoxConfiguration.class);

	@Bean
	public Docket docketApi() {
		Docket docket = new Docket(DocumentationType.SWAGGER_2)//
		        .groupName("有关事项填报")//
		        .apiInfo(new ApiInfoBuilder()//
		                .title("有关事项填报平台API接口文档")//
		                .description("API接口文档")//
		                .version("0.0.1")//
		                .contact(new Contact("作者", null, "email@163.com"))//
		                .license("")//
		                .licenseUrl("")//
		                .termsOfServiceUrl("")//
//		                .extensions()
		                .build()//
				)//
		        .select() //
//		        .apis(RequestHandlerSelectors.any())//
		        .apis(RequestHandlerSelectors.basePackage("com"))//
		        .paths(PathSelectors.any()) //
		        .build() //
		;
		return docket;
	}

	/**
	 * 解决Springfox3.0启动报错问题
	 * 
	 * @return
	 */
	@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) {
					logger.warn("修改WebMvcRequestHandlerProvider的属性：handlerMappings出错，可能导致swagger不可用", e);
					throw new IllegalStateException(e);
				}
			}
		};
	}

}