com.github.xiaoymin.knife4j.spring.common.bean.Knife4jDocketAutoRegistry Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of knife4j-openapi2-spring-boot-starter Show documentation
Spring Boot autoconfigure
The newest version!
/*
 * Copyright (C) 2018 Zhejiang xiaominfo Technology CO.,LTD.
 * All rights reserved.
 * Official Web Site: https://www.xiaominfo.com.
 * Developer Web Site: https://doc.xiaominfo.com.
 */
package com.github.xiaoymin.knife4j.spring.common.bean;

import com.github.xiaoymin.knife4j.core.enums.AnnotationClassEnums;
import com.github.xiaoymin.knife4j.core.enums.ApiRuleEnums;
import com.github.xiaoymin.knife4j.core.enums.PathRuleEnums;
import com.github.xiaoymin.knife4j.core.util.CollectionUtils;
import com.github.xiaoymin.knife4j.core.util.CommonUtils;
import com.github.xiaoymin.knife4j.core.util.StrUtil;
import com.github.xiaoymin.knife4j.spring.configuration.Knife4jInfoProperties;
import com.github.xiaoymin.knife4j.spring.configuration.Knife4jProperties;
import com.github.xiaoymin.knife4j.spring.extension.OpenApiExtensionResolver;
import com.github.xiaoymin.knife4j.spring.model.docket.Knife4jDocketInfo;
import com.github.xiaoymin.knife4j.spring.util.RequestHandlerSelectorUtils;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.BeanFactory;
import org.springframework.beans.factory.BeanFactoryAware;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.beans.factory.support.BeanDefinitionRegistry;
import org.springframework.beans.factory.support.GenericBeanDefinition;
import springfox.documentation.RequestHandler;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

import java.util.List;
import java.util.Map;
import java.util.function.Predicate;

/**
 * @since:knife4j 4.0.0
 * @auth [email protected]
 * 2022/8/17 21:56
 */
@Slf4j
public class Knife4jDocketAutoRegistry implements BeanFactoryAware, InitializingBean {

    public Knife4jDocketAutoRegistry(Knife4jProperties knife4jProperties, OpenApiExtensionResolver openApiExtensionResolver) {
        this.knife4jProperties = knife4jProperties;
        this.openApiExtensionResolver = openApiExtensionResolver;
    }

    private final Knife4jProperties knife4jProperties;
    private final OpenApiExtensionResolver openApiExtensionResolver;
    private BeanFactory beanFactory;

    @Override
    public void setBeanFactory(BeanFactory beanFactory) throws BeansException {
        this.beanFactory=beanFactory;
    }

    @Override
    public void afterPropertiesSet() throws Exception {
        Knife4jInfoProperties info= knife4jProperties.getOpenapi();
        if (info!=null&& CollectionUtils.isNotEmpty(info.getGroup())){
            log.debug("Initialize docket information.");
            BeanDefinitionRegistry beanRegistry = (BeanDefinitionRegistry)beanFactory;
            //构建基础信息
            ApiInfo apiInfo=new ApiInfoBuilder()
                    .title(info.getTitle())
                    .description(info.getDescription())
                    .version(info.getVersion())
                    .license(info.getLicense())
                    .licenseUrl(info.getLicenseUrl())
                    .termsOfServiceUrl(info.getTermsOfServiceUrl())
                    .contact(new Contact(info.getConcat(),info.getUrl(),info.getEmail()))
                    .build();
            for (Map.Entry map:info.getGroup().entrySet()){
                String beanName=CommonUtils.getRandomBeanName(map.getKey());
                Knife4jDocketInfo docketInfo=map.getValue();
                //分组名称给一个默认值，如果用户没有设置，则取key值
                String groupName= StrUtil.isNotBlank(docketInfo.getGroupName())?docketInfo.getGroupName():map.getKey();
                log.debug("Auto register Docket Bean,name:{}",beanName);
                BeanDefinition docketBeanDefinition = new GenericBeanDefinition();
                docketBeanDefinition.getConstructorArgumentValues().addIndexedArgumentValue(0, DocumentationType.SWAGGER_2);
                docketBeanDefinition.setBeanClassName(Docket.class.getName());
                docketBeanDefinition.setRole(BeanDefinition.ROLE_SUPPORT);
                //注入
                beanRegistry.registerBeanDefinition(beanName, docketBeanDefinition);
                //赋值
                Docket docketBean = (Docket)beanFactory.getBean(beanName);
                docketBean.groupName(groupName).apiInfo(apiInfo);
                //默认所有Api
                Predicate apiPredicate=RequestHandlerSelectors.any();
                Predicate pathPredicate=PathSelectors.any();
                //判断api资源策略
                if (CollectionUtils.isNotEmpty(docketInfo.getApiRuleResources())){
                    //判断当前Docket对象的apis策略
                    if (docketInfo.getApiRule()== ApiRuleEnums.PACKAGE){
                        //包路径
                        apiPredicate=RequestHandlerSelectorUtils.multiplePackage(docketInfo.getApiRuleResources().toArray(new String[]{}));
                    }else if (docketInfo.getApiRule()== ApiRuleEnums.ANNOTATION){
                        //替换shortName
                        List annotationClass= AnnotationClassEnums.resolveResources(docketInfo.getApiRuleResources());
                        apiPredicate=RequestHandlerSelectorUtils.multipleAnnotations(annotationClass);
                    }
                }
                if (CollectionUtils.isNotEmpty(docketInfo.getPathRuleResources())){
                    //paths策略
                    if(docketInfo.getPathRule()== PathRuleEnums.ANT){
                        //ant路径
                        pathPredicate=RequestHandlerSelectorUtils.multipleAntPath(docketInfo.getPathRuleResources());
                    }else if(docketInfo.getPathRule()== PathRuleEnums.REGEX){
                        pathPredicate=RequestHandlerSelectorUtils.multipleRegexPath(docketInfo.getPathRuleResources());
                    }
                }
                //build
                docketBean.select().apis(apiPredicate).paths(pathPredicate).build();
                //增加Knife4j的增强属性
                docketBean.extensions(openApiExtensionResolver.buildExtensions(groupName));
            }
        }
    }
}