使用 springfox 中的 RequestHandlerSelectors.basePackage(“com.xxx”) 只能支持单个包路径的扫描匹配,如果要想支持多个包路径的匹配我们需要修改 springfox 里面的代码来支持他,现做以下修改来支持多包路径匹配。
package com.xxx.xxx.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import com.google.common.base.Function;
import com.google.common.base.Optional;
import com.google.common.base.Predicate;
import springfox.documentation.RequestHandler;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
/**
* Swagger2配置 <br>
* 使用springfox中的 RequestHandlerSelectors.basePackage("com.xxx")
* 只能支持单个包路径的扫描匹配,以下修改支持多包路径匹配。
*
* @author zhangqin
*
*/
@Configuration
@EnableSwagger2
public class SwaggerConfig {
/**
* Swagger2创建Docket的Bean
*
* @return
*/
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2).host("127.0.0.1:8080").apiInfo(apiInfo()).select()
.apis(SwaggerConfig.basePackage("com.xxx.subpackage1,com.xxx.subpackage2")).paths(PathSelectors.any()).build();
}
/**
* Swagger2创建该Api的基本信息
*
* @return
*/
private ApiInfo apiInfo() {
return new ApiInfoBuilder().title("后台API接口文档").description("后台API接口文档").version("1.0.0").build();
}
/**
* Predicate that matches RequestHandler with given base package name for the
* class of the handler method. This predicate includes all request handlers
* matching the provided basePackage
*
* @param basePackage
* - base package of the classes
* @return this
*/
public static Predicate<RequestHandler> basePackage(final String basePackage) {
return new Predicate<RequestHandler>() {
@Override
public boolean apply(RequestHandler input) {
return declaringClass(input).transform(handlerPackage(basePackage)).or(true);
}
};
}
/**
* 处理包路径配置规则,支持多路径扫描匹配以逗号隔开
*
* @param basePackage
* @return Function
*/
private static Function<Class<?>, Boolean> handlerPackage(final String basePackage) {
return new Function<Class<?>, Boolean>() {
@Override
public Boolean apply(Class<?> input) {
for (String strPackage : basePackage.split(",")) {
boolean isMatch = input.getPackage().getName().startsWith(strPackage);
if (isMatch) {
return true;
}
}
return false;
}
};
}
/**
* @param input
* @return Optional
*/
@SuppressWarnings("deprecation")
private static Optional<? extends Class<?>> declaringClass(RequestHandler input) {
return Optional.fromNullable(input.declaringClass());
}
}