SpringBoot框架(5)-- @EableAutoConfiguration项目应用

场景：在项目中想在当前maven项目中自动装配其他自定义的Maven项目，例如，创建数据库配置中心，被多个maven引用，希望简单配置，就实现springboot自动装配数据库配置类。

由此我们联想到，我们新建项目是如何装配第三方jar的？跟踪springboot源码得知，方法其实非常简单。springboot通过@EableAutoConfiguration注解，来实现这个目的。

原理:注解@EnableAutoConfiguration引用了@Import({AutoConfigurationImportSelector.class})注解，在AutoConfigurationImportSelector类中定义了getCandidateConfigurations方法加载自定义配置类。

 protected List<String> getCandidateConfigurations(AnnotationMetadata metadata, AnnotationAttributes attributes) {
        List<String> configurations = SpringFactoriesLoader.loadFactoryNames(this.getSpringFactoriesLoaderFactoryClass(), this.getBeanClassLoader());
        Assert.notEmpty(configurations, "No auto configuration classes found in META-INF/spring.factories. If you are using a custom packaging, make sure that file is correct.");
        return configurations;
    }

由该方法提示的信息可以看到，如果自定义了需要装配的包，则需要在 META-INF/spring.factories文件中定义。如何定义呢？依葫芦画瓢，找到导入包中org/springframework/boot/spring-boot-autoconfigure/2.1.5.RELEASE/spring-boot-autoconfigure-2.1.5.RELEASE.jar!/META-INF/spring.factories文件(我当前使用的是2.1.5.版本，根据实际使用的版本不同，找到对应的方法即可)

# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
org.springframework.boot.autoconfigure.admin.SpringApplicationAdminJmxAutoConfiguration,\
org.springframework.boot.autoconfigure.aop.AopAutoConfiguration

看到了 Auto Configure，这就我们需要配置的内容，在我们需要的导入到当前maven项目的文件resources\META-INF\spring.factories中添加需要装配的配置类的全路径，如下

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
  com.boot.config.core.config.BeanConfiguration #需要装配的配置类的全路径

至此，在当前项目块的配置类实例。

原理至此，上代码

准备两个需要被引用的maven项目

第一个项目bean-core，代码结构

 （1）在domain中定义了2个bean类--Order和Product，没有属性和方法，也不用添加注解。再新建BeanConfiguration配置类如下

package com.boot.config.core.config;

import com.boot.config.core.domain.Order;
import com.boot.config.core.domain.Product;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class BeanConfiguration {

    @Bean
    public Order creatOrder() {
        return new Order();
    }

    @Bean
    public Product createProduct() {
        return new Product();
    }
}

（2）在spring.factories文件中添加以下内容

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
  com.boot.config.core.config.BeanConfiguration #BeanConfiguration类全路径

同理在confing-core项目中，做相同的处理。

第二个项目

（1）定义数据源bean类

package com.boot.config.core;

/**
 * 数据源属性类
 *
 */
public class DatasourceProperties
{
    private  String driverClassName;
    private String url;
    private String userName;
    private String password;

    public String getDriverClassName() {
        return driverClassName;
    }

    public void setDriverClassName(String driverClassName) {
        this.driverClassName = driverClassName;
    }

    public String getUrl() {
        return url;
    }

    public void setUrl(String url) {
        this.url = url;
    }

    public String getUserName() {
        return userName;
    }

    public void setUserName(String userName) {
        this.userName = userName;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }
}

（2）定义数据源配置类

package com.boot.config.core;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class DatasourceConfig {

    @Bean
    @ConfigurationProperties(prefix = "jdbc")
    public DatasourceProperties createDatasourceProperties() {
        return new DatasourceProperties();
    }
}

（3）配置资源文件spring.factories

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
  com.boot.config.core.DatasourceConfig

 第三个项目，引用了 第一、二项目

（1）pom.xml文件中引用第三方jar包依赖

        <dependency>
            <groupId>com.boot.config.core</groupId>
            <artifactId>bean-core</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
        <dependency>
            <groupId>com.boot.config.core</groupId>
            <artifactId>config-core</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>

（2）application.properties文件中设置数据源配置

jdbc.driverClassName=com.mySql.jdbc.mySqlDriver
jdbc.userName=root
jdbc.password=root.123
jdbc.className=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/bookstore

（3）main方法中打印第三方配置信息

package com.boot.auto.bootauto;

import com.boot.config.core.DatasourceProperties;
import com.boot.config.core.config.BeanConfiguration;
import com.boot.config.core.domain.Order;
import com.boot.config.core.domain.Product;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.context.annotation.ComponentScan;

//设置不装配的配置类
//@EnableAutoConfiguration(exclude= {BeanConfiguration.class})
@EnableAutoConfiguration
@ComponentScan
public class BootAutoApplication {

    public static void main(String[] args) {
        ConfigurableApplicationContext context = SpringApplication.run(BootAutoApplication.class, args);
        System.out.println(context.getBean(Order.class));
        System.out.println(context.getBean(Product.class));

        DatasourceProperties jdbcBean = context.getBean(DatasourceProperties.class);

        System.out.println(jdbcBean.getDriverClassName());
        System.out.println(jdbcBean.getUrl());
        System.out.println(jdbcBean.getUserName());
        System.out.println(jdbcBean.getPassword());

        context.close();
    }

}

（4)打印结果

com.boot.config.core.domain.Order@3a71c100
com.boot.config.core.domain.Product@5b69fd74
com.mySql.jdbc.mySqlDriver
jdbc:mysql://localhost:3306/bookstore
root
root.123

由此可以看到我们在其他（第三方）的配置类成功装配到我们当前项目中来。

总结

1、被引用的第三方maven项目（A）中定义了配置类

2、在A项目的META_INFO/spring.properties文件中添加需要装配的配置类的全路径

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
  com.boot.config.core.config.BeanConfiguration

3、引用项目(B)在pom.xml中添加对A的jar引用

4、使用@EnableAutoConfiguration，从而在ConfigurableApplicationContext的实例对A项目的配置进行访问操作。

github源码：https://github.com/LF20160912/boot-proj