All Downloads are FREE. Search and download functionalities are using the official Maven repository.
Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
com.battcn.boot.swagger.autoconfigure.SwaggerAutoConfiguration Maven / Gradle / Ivy
package com.battcn.boot.swagger.autoconfigure;
import com.battcn.boot.swagger.configuration.SwaggerBeanValidatorPluginsConfiguration;
import com.battcn.boot.swagger.configuration.SwaggerSecurityFilterPluginsConfiguration;
import com.battcn.boot.swagger.properties.SwaggerProperties;
import com.battcn.boot.swagger.properties.SwaggerSecurityProperties;
import com.battcn.boot.swagger.security.GlobalAccess;
import com.google.common.base.Predicate;
import com.google.common.collect.Lists;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.BeanFactory;
import org.springframework.beans.factory.BeanFactoryAware;
import org.springframework.beans.factory.config.ConfigurableBeanFactory;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;
import org.springframework.util.CollectionUtils;
import org.springframework.util.StringUtils;
import org.springframework.web.bind.annotation.RequestMethod;
import springfox.documentation.builders.*;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.service.Parameter;
import springfox.documentation.service.ResponseMessage;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.configuration.Swagger2DocumentationConfiguration;
import java.util.*;
import java.util.stream.Collectors;
import static com.google.common.base.Predicates.*;
import static com.google.common.collect.Lists.newArrayList;
import static java.util.stream.Collectors.toList;
import static java.util.stream.Collectors.toSet;
/**
* @author Levin
* @since 2.0.2
*/
@Configuration
@ConditionalOnProperty(name = "spring.swagger.enabled", havingValue = "true", matchIfMissing = true)
@Import({Swagger2DocumentationConfiguration.class, SwaggerBeanValidatorPluginsConfiguration.class})
@EnableAutoConfiguration
@EnableConfigurationProperties({SwaggerProperties.class, SwaggerSecurityProperties.class})
public class SwaggerAutoConfiguration implements BeanFactoryAware {
private static final String DEFAULT_GROUP_NAME = "default";
private static final String BASE_PATH = "/**";
private BeanFactory beanFactory;
@Override
public void setBeanFactory(BeanFactory beanFactory) throws BeansException {
this.beanFactory = beanFactory;
}
@Bean
@ConditionalOnProperty(name = {"spring.swagger.enabled", "spring.swagger.security.filter-plugin"}, havingValue = "true")
public FilterRegistrationBean someFilterRegistration() {
FilterRegistrationBean registration = new FilterRegistrationBean<>();
registration.setFilter(new SwaggerSecurityFilterPluginsConfiguration());
registration.addUrlPatterns("/v2/api-docs", "/swagger-resources");
return registration;
}
@Bean
@ConditionalOnMissingBean
public GlobalAccess globalAccess(SwaggerProperties swaggerProperties) {
return new GlobalAccess(swaggerProperties);
}
@Bean
@ConditionalOnMissingBean
public List createRestApi(SwaggerProperties swaggerProperties, GlobalAccess globalAccess) {
ConfigurableBeanFactory configurableBeanFactory = (ConfigurableBeanFactory) beanFactory;
List docketList = new LinkedList<>();
// 没有分组
if (swaggerProperties.getGroups().size() == 0) {
ApiInfo apiInfo = new ApiInfoBuilder()
.title(swaggerProperties.getTitle())
.description(swaggerProperties.getDescription())
.version(swaggerProperties.getVersion())
.license(swaggerProperties.getLicense())
.licenseUrl(swaggerProperties.getLicenseUrl())
.contact(new Contact(swaggerProperties.getContact().getName(),
swaggerProperties.getContact().getUrl(),
swaggerProperties.getContact().getEmail()))
.termsOfServiceUrl(swaggerProperties.getTermsOfServiceUrl())
.build();
// base-path处理
// 当没有配置任何path的时候，解析/**
if (swaggerProperties.getBasePath().isEmpty()) {
swaggerProperties.getBasePath().add(BASE_PATH);
}
List> basePath = swaggerProperties.getBasePath().stream().map(PathSelectors::ant).collect(toList());
// exclude-path 处理
List> excludePath = Lists.newArrayList();
for (String path : swaggerProperties.getExcludePath()) {
excludePath.add(PathSelectors.ant(path));
}
Docket docket = new Docket(DocumentationType.SWAGGER_2)
.host(swaggerProperties.getHost())
.apiInfo(apiInfo)
.globalOperationParameters(buildGlobalOperationParameters(swaggerProperties.getGlobalOperationParameters()))
.select()
.apis(RequestHandlerSelectors.basePackage(swaggerProperties.getBasePackage()))
.paths(and(not(or(excludePath)), or(basePath)))
.build();
// 配置全局响应
if (!CollectionUtils.isEmpty(swaggerProperties.getGlobalResponseMessages())) {
buildGlobalResponseMessage(swaggerProperties, docket);
}
// 配置接口授权
if (Objects.nonNull(swaggerProperties.getApiKey())) {
docket.securitySchemes(newArrayList(globalAccess.apiKey())).securityContexts(newArrayList(globalAccess.securityContext()));
}
configurableBeanFactory.registerSingleton(DEFAULT_GROUP_NAME, docket);
docketList.add(docket);
return docketList;
}
// 分组创建
for (String groupName : swaggerProperties.getGroups().keySet()) {
SwaggerProperties.GroupInfo groupInfo = swaggerProperties.getGroups().get(groupName);
SwaggerProperties.Contact contact = groupInfo.getContact();
ApiInfo apiInfo = new ApiInfoBuilder()
.title(defaultString(groupInfo.getTitle(), swaggerProperties.getTitle()))
.description(defaultString(groupInfo.getDescription(), swaggerProperties.getDescription()))
.version(defaultString(groupInfo.getVersion(), swaggerProperties.getVersion()))
.license(defaultString(groupInfo.getLicense(), swaggerProperties.getLicense()))
.licenseUrl(defaultString(groupInfo.getLicenseUrl(), swaggerProperties.getLicenseUrl()))
.contact(new Contact(
defaultString(contact.getName(), swaggerProperties.getContact().getName()),
defaultString(contact.getUrl(), swaggerProperties.getContact().getUrl()),
defaultString(contact.getEmail(), swaggerProperties.getContact().getEmail())))
.termsOfServiceUrl(defaultString(groupInfo.getTermsOfServiceUrl(), swaggerProperties.getTermsOfServiceUrl()))
.build();
// base-path处理
// 当没有配置任何path的时候，解析/**
if (groupInfo.getBasePath().isEmpty()) {
groupInfo.getBasePath().add(BASE_PATH);
}
List> basePath = groupInfo.getBasePath().stream().map(PathSelectors::ant).collect(toList());
// exclude-path处理
List> excludePath = Lists.newArrayList();
for (String path : groupInfo.getExcludePath()) {
excludePath.add(PathSelectors.ant(path));
}
Docket docket = new Docket(DocumentationType.SWAGGER_2)
.host(swaggerProperties.getHost())
.apiInfo(apiInfo)
.globalOperationParameters(assemblyGlobalOperationParameters(swaggerProperties.getGlobalOperationParameters(), groupInfo.getGlobalOperationParameters()))
.groupName(groupName)
.select()
.apis(RequestHandlerSelectors.basePackage(groupInfo.getBasePackage()))
.paths(and(not(or(excludePath)), or(basePath)))
.build();
// 配置全局响应
if (!CollectionUtils.isEmpty(swaggerProperties.getGlobalResponseMessages())) {
buildGlobalResponseMessage(swaggerProperties, docket);
}
// 配置接口授权
if (Objects.nonNull(swaggerProperties.getApiKey())) {
docket.securitySchemes(newArrayList(globalAccess.apiKey())).securityContexts(newArrayList(globalAccess.securityContext()));
}
configurableBeanFactory.registerSingleton(groupName, docket);
docketList.add(docket);
}
return docketList;
}
/**
* 读取 SwaggerProperties 配置,构建全局响应结果
*
* @param swaggerProperties swaggerProperties
* @param docket docket 追加对象
*/
private void buildGlobalResponseMessage(SwaggerProperties swaggerProperties, Docket docket) {
final Map> responseMessages = swaggerProperties.getGlobalResponseMessages();
final Set methods = responseMessages.keySet();
for (RequestMethod method : methods) {
final List responseMessageBodies = responseMessages.get(method);
final List messages = responseMessageBodies.stream().map(my -> {
ResponseMessageBuilder builder = new ResponseMessageBuilder().code(my.getCode()).message(my.getMessage());
if (!StringUtils.isEmpty(my.getModelRef())) {
builder.responseModel(new ModelRef(my.getModelRef()));
}
return builder.build();
}).collect(toList());
docket.globalResponseMessage(method, messages);
}
}
/**
* 读取 SwaggerProperties 配置,构建全局操作参数
*
* @param globalOperationParameters 全局参数
* @return 参数集
*/
private List buildGlobalOperationParameters(List globalOperationParameters) {
if (Objects.isNull(globalOperationParameters)) {
return Lists.newArrayList();
}
return globalOperationParameters.stream().map(globalOperationParameter -> new ParameterBuilder()
.name(globalOperationParameter.getName())
.description(globalOperationParameter.getDescription())
.modelRef(new ModelRef(globalOperationParameter.getModelRef()))
.parameterType(globalOperationParameter.getParameterType())
.required(globalOperationParameter.getRequired())
.build()).collect(toList());
}
/**
* 局部参数按照name覆盖局部参数
*
* @param globalOperationParameters 全局参数
* @param groupOperationParameters 附加参数
* @return 参数集
*/
private List assemblyGlobalOperationParameters(
List globalOperationParameters,
List groupOperationParameters) {
if (CollectionUtils.isEmpty(groupOperationParameters)) {
return buildGlobalOperationParameters(globalOperationParameters);
}
if (CollectionUtils.isEmpty(globalOperationParameters)) {
return buildGlobalOperationParameters(groupOperationParameters);
}
Set groupNames = groupOperationParameters.stream().map(SwaggerProperties.GlobalOperationParameter::getName).collect(toSet());
List resultOperationParameters =
globalOperationParameters.stream().filter(parameter -> !groupNames.contains(parameter.getName())).collect(Collectors.toList());
resultOperationParameters.addAll(groupOperationParameters);
return buildGlobalOperationParameters(resultOperationParameters);
}
private static String defaultString(final String str, final String defaultStr) {
return str == null || Objects.equals(str.trim(), "") || str.length() == 0 ? defaultStr : str;
}
}
