springBoot自动配置原理

一、前言

springBoot是现在JAVA开发领域最优秀也是应用最广泛的框架之一，深受国内广大程序员喜爱，也是目前程序员的标配技术栈了，面试过程中经常会问道springBoot相关的技术问题，比如说我们今天探讨的自动配置原理，这是springBoot中一个很核心的技术，因为springBoot的理念是约定大于配置，在springBoot的整个框架中大量使用自动配置的原理，让我们来一块揭开神秘面纱。

二、什么是自动配置

各位在开发过程中一定使用过redisTemplate，使用redisTemplate的步骤很简单：

• 在pom文件中引入依赖spring-boot-starter-data-redis-xxx.jar
• 在配置文件中配置redis的相关信息

spring.redis.timeout=10000spring.redis.host=127.0.0.1spring.redis.port=6379

• 在service代码中注入redisTemplate对象，通过redisTemplate来操作redis

这个例子就是springBoot的自动配置起到作用，帮助开发人员方便的注入redisTemplate对象，无需关系底层的实现原理。

三、原理

（一）Bean的自动配置

SpringBoot的应用上都有一个注解@SpringBootApplication，这个注解是一个复合注解，其中@EnableAutoConfiguration是来开启springBoot的自动配置的。

在@EnableAutoConfiguration注解内使用到了@import注解来完成导入配置的功能，

而EnableAutoConfigurationImportSelector内部则是使用了SpringFactoriesLoader.loadFactoryNames方法进行扫描具有META-INF/spring.factories文件的jar包。

先来看下spring-boot-autoconfigure包内的spring.factories文件内容，如下所示：

springBoot就是通过扫描这个配置文件的配置信息，再加上一些javaConfig,比如我们在上面举得例子

RedisAutoConfiguration是一个javaConfig类，

可以看到，我们这里通过@Bean注解组装了一个RedisTempLate的Bean，外界只需要通过注入即可使用。

先解释下几个核心的注解：

1. @Configuration: 声明当前类为一个配置类
2. @ConditionalOnClass(RedisOperations.class)：当SpringIoc容器内存在Jedis这个Bean时才装配当前配置类
3. @EnableConfigurationProperties(RedisProperties.class)：这是一个开启使用配置参数的注解，value值就是我们配置实体参数映射的ClassType，将配置实体作为配置来源。
4. @ConditionalOnMissingBean：当SpringIoc容器内不存在RedisTempLate这个Bean的时候才进行装配，否则不装配。

这些注解是我们实现自动配置的关键，体现了spring的哲学: 约定优于配置

（二）属性的自动配置

属性的自动配置是通过ConfigurationPropertiesBindingPostProcessor类的postProcessBeforeInitialization方法完成，

publicObjectpostProcessBeforeInitialization(Objectbean, StringbeanName) throwsBeansException {
ConfigurationPropertiesannotation=getAnnotation(bean, beanName, ConfigurationProperties.class);
if (annotation!=null) {
bind(bean, beanName, annotation);
    }
returnbean;
 }

它会解析@ConfigurationProperties注解上的属性，将配置文件中对应key的值绑定到属性上。

（三）整体流程

四、实现自己的starter

所谓的 Starter ，其实就是一个普通的 Maven 项目，因此我们自定义 Starter ，需要首先创建一个普通的 Maven 项目，创建完成后，添加 Starter 的自动化配置类即可，如下：

<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-autoconfigure</artifactId><version>2.1.8.RELEASE</version></dependency>

我们首先创建一个 HelloProperties 类，用来接受 application.properties 中注入的值，如下：

@ConfigurationProperties(prefix = "custom")
@Data
public class HelloProperties {
    private String name = "";
    private String msg = "";
}

将 application.yml中配置的属性值直接注入到这个实例中， @ConfigurationProperties 类型安全的属性注入，即将 application.yml文件中前缀为 custom 的属性注入到这个类对应的属性上， 最后使用时候，application.yml 中的配置文件，大概如下：

custom:  name: apple
  msg: 您好

接下来就是自动配置类的定义，用了很多springBoot相关的自定义类之后，我们也来自己定义一个自定义类

• 首先 @Configuration 注解表明这是一个配置类。
• @EnableConfigurationProperties 注解是使我们之前配置的 @ConfigurationProperties 生效，让配置的属性成功的进入 Bean 中。
• @ConditionalOnClass 表示当项目当前 classpath 下存在 HelloService 时，后面的配置才生效。
• 自动配置类中首先注入 HelloProperties ，这个实例中含有我们在 application.properties 中配置的相关数据。
• 提供一个 HelloService 的实例，将 HelloProperties 中的值注入进去。

@Configuration@EnableConfigurationProperties(HelloProperties.class)
@ConditionalOnClass(HelloService.class)
publicclassHelloServiceAutoConfiguration {
@AutowiredHelloPropertieshelloProperties;
@BeanHelloServicehelloService() {
HelloServicehelloService=newHelloService();
helloService.setName(helloProperties.getName());
helloService.setMsg(helloProperties.getMsg());
returnhelloService;
    }
}

做完这一步之后，我们的自动化配置类就算是完成了，接下来还需要一个 spring.factories 文件,用来告诉springboot吴自动注入我们的starter。

我们首先在 Maven 项目的 resources 目录下创建一个名为 META-INF 的文件夹，然后在文件夹中创建一个名为 spring.factories 的文件，文件内容如下：

org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.tl.config.HelloServiceAutoConfiguration

在另一个项目中引用我们自定义的starter：

<dependency><groupId>com.tl</groupId><artifactId>helllo-spring-boot-starter</artifactId><version>1.0-SNAPSHOT</version></dependency>

配置完成后，方便起见，我这里直接在单元测试方法中注入 HelloSerivce 实例来使用，代码如下：

@RunWith(SpringRunner.class)
@SpringBootTest
public class AutoTestApplication {
    @Autowired
    HelloService helloService;
    @Test
    public void testHello() {
        System.out.println(helloService.sayHello());
    }
}