1. 程式人生 > 實用技巧 >SpringBoot之spring.factories

SpringBoot之spring.factories

首先丟擲一個問題:如果想要被Spring容器管理的Bean的路徑不再Spring Boot 的包掃描路徑下,怎麼辦呢?也就是如何去載入第三方的Bean 呢?

有兩種方式可以解決:
這裡我們使用Swagger的配置來做實驗。
1:首先一個Swagger的配置類:SwaggerConfig
SwaggerConfig 程式碼:

@Configuration
@EnableSwagger2
public class SwaggerConfig implements EnvironmentAware {
    private static final Logger log = LoggerFactory.getLogger(SwaggerConfig.class);
    @Autowired
    private Environment env;
    @Value("${swagger.scan.package}")
    private String swaggerScanPackage;

    public SwaggerConfig() {
    }

    @Bean
    public Docket createRestApi() {
        Predicate<String> path = PathSelectors.any();
        if (Arrays.asList(this.env.getActiveProfiles()).contains("prod")) {
            path = PathSelectors.none();
        }

        log.info("####初始化createRestApi####swaggerScanPackage:" + this.swaggerScanPackage);
        log.info(path.toString());
        return (new Docket(DocumentationType.SWAGGER_2)).apiInfo(this.apiInfo()).select().apis(RequestHandlerSelectors.basePackage(this.swaggerScanPackage)).paths(PathSelectors.any()).build();
    }

    private ApiInfo apiInfo() {
        log.info("##################################初始化API資訊################################################");
        return (new ApiInfoBuilder()).title("APIs").description("…………").termsOfServiceUrl("https://js.dazhi.loan.com").version("1.0").build();
    }

    @Override
    public void setEnvironment(Environment environment) {

    }
}

2:再看我的工程結構吧:

發現我的SwaggerConfig 類和 SpringBoot 的啟動類ConfigApplication.java 不在同一級目錄下,所以當Spring Boot 自動掃描包的時候,是掃描不到我的SwaggerConfig 的配置的,也就在控制檯沒有Swagger的列印的資訊:

所以這時候我如果想要把SwaggerConfig 載入到Spring容器中的話 要怎麼辦呢?下面介紹兩種方式
①:在Spring Boot Application 主類上 使用@Import 註解

啟動就可以看到Swagger的基礎資訊:

②:現在我們將其改造一下,採用spring.factories 的方式去載入SwaggerConfig類,在resources目錄下新建一個META-INF 的目錄,然後在

新建一個spring.factories 的檔案,裡面的內容為:

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\com.sg.config.SwaggerConfig

然後在把Spring Boot 啟動類上的@Import註釋掉,啟動發現也可以把SwaggerConfig載入到Spring 容器中

到這就完成了載入一個Spring 不能掃描到的一個類,他可以是第三方的,也可以是自己寫的,只要是Spring Boot 預設掃描路徑不能夠掃描到,都可以使用這種方式去載入!!!