SpringBoot多模块开发中swagger识别不同模块中的controller包

1. 本文仅解决了在 Spring Boot 多模块中引入配置在common模块中的 controller 及在启动类管理下的 controller ，且未进行自动配置
2. 本类是抽象类，需要在启动类下再写一个SwaggerConfig
3. 注意修改 package

BaseSwaggerConfig

package ycl.springframework.boot.commons.config;

import cn.hutool.core.lang.Assert;
import com.google.common.base.Function;
import com.google.common.base.Optional;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.RequestHandler;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.service.*;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spi.service.contexts.SecurityContext;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
import ycl.springframework.boot.commons.constants.GlobalConstant;

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

/**
 * swagger配置
 *
 * @author YCL
 * @date 2021-06-06 15:00:00
 */
@Configuration
@EnableSwagger2
public abstract class BaseSwaggerConfig {

	private final String packageImport;//这是由继承的 SwaggerConfig 传进来的 controller 包
	private final String[] commonControllerPackages = {
			"ycl.springframework.boot.commons.base.controller",
	};//这是我的 common 下的 controller 包
	private final String title;
	private final String description = "swagger";
	private final String serviceUrl = "none";
	private final String version = "1.0";


	public BaseSwaggerConfig(String packageImport, String title) {
		Assert.notBlank(packageImport,
				"you will write your controller package to application.yml, key: project.controllerPackage");
		this.packageImport = packageImport;
		this.title = title;
	}

	@Bean
	public Docket createSwaggerApi() {
		return new Docket(DocumentationType.SWAGGER_2)
				.useDefaultResponseMessages(false)
				.apiInfo(apiInfo())
				.select()
				.apis(getPackages())
				.paths(PathSelectors.any())
				.build()
				.securitySchemes(securitySchemes())
				.securityContexts(securityContexts());
	}

	private Predicate<RequestHandler> getPackages() {
		int length = commonControllerPackages.length;
		String[] pkg = new String[commonControllerPackages.length + 1];
		System.arraycopy(commonControllerPackages, 0, pkg, 0, length);
		pkg[length] = packageImport;
		return v -> declaring(v).transform(handlerPackage(pkg)).or(true);
	}

	@SuppressWarnings("all")
	private Optional<? extends Class<?>> declaring(RequestHandler handler) {
		return Optional.fromNullable(handler.declaringClass());
	}

	@SuppressWarnings("all")
	private Function<Class<?>, Boolean> handlerPackage(String[] packages) {
		return v -> {
			for (String p : packages) {
				if (v.getPackage().getName().startsWith(p))
					return true;
			}
			return false;
		};
	}


	private List<SecurityContext> securityContexts() {
		ArrayList<SecurityContext> list = new ArrayList<>();
		SecurityContext build = SecurityContext.builder()
				.securityReferences(securityReferences())
				.build();
		list.add(build);
		return list;
	}


	private List<SecurityReference> securityReferences() {
		AuthorizationScope scope = new AuthorizationScope("global", "accessEverything");
		AuthorizationScope[] scopes = new AuthorizationScope[1];
		scopes[0] = scope;
		ArrayList<SecurityReference> list = new ArrayList<>();
		list.add(new SecurityReference(GlobalConstant.TOKEN, scopes));
		return list;
	}


	private List<SecurityScheme> securitySchemes() {
		ArrayList<SecurityScheme> list = new ArrayList<>();
		list.add(new ApiKey(GlobalConstant.TOKEN, GlobalConstant.TOKEN, "header"));
		return list;
	}

	private ApiInfo apiInfo() {
		return new ApiInfoBuilder()
				.title(title)
				.description(description)
				.termsOfServiceUrl(serviceUrl)
				.version(version)
				.build();
	}
}

SwaggerConfig写法

package ycl.springframework.test.config;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
import ycl.springframework.boot.commons.config.BaseSwaggerConfig;

/**
 * swagger配置
 *
 * @author: YCL
 * @date: 2021-06-06 15:00:00
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig extends BaseSwaggerConfig {

	public SwaggerConfig(
			@Value("${project.controllerPackage}") String packageImport) {
		super(packageImport, "swagger-test");//这里从配置文件中注入
	}

}

application.properties

project.controllerPackage=ycl.springframework.test.controller

后言

不忘初心，牢记使命。
让我们携手，互帮互助，取长补短，一起朝各自的目标奋力迈进！！！

由衷感谢您的观看，您的收获和支持就是我的最大动力！！再次感谢！！

End