SpringBoot自动配置探究

SpringBoot之所以能大幅减少程序员的配置工作，主要是因为有自动配置的功能。这篇文章我们来自己实现一个简单的能自动配置的工程。

自定义自动配置

首先定义一个User类：

public class User {
    private String name;
    private Integer age;

    public User(String name, Integer age) {
        this.name = name;
        this.age = age;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    @Override
    public String toString() {
        return "{name:" + name + ", " + "age:" + age + "}";
    }
}

然后定义一个加载User属性的类UserProperties：

@ConfigurationProperties(prefix = "user")
public class UserProperties {
    private String name;
    private Integer age;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }
}

UserProperties能从application.yml文件中读取以user开头的配置，配置如下：

1
2
3

user:
  name: wangqi
  age: 21

要想达到自动配置的效果，需要定义一个配置类，然后在META-INF/spring.factories文件中加入自动配置的类。

配置类如下定义：

@Configuration
@EnableConfigurationProperties(UserProperties.class)
@ConditionalOnClass(UserProperties.class)
@ConditionalOnProperty(prefix = "user", name = "name")
public class UserAutoConfiguration {
    @Autowired
    private UserProperties userProperties;

    @Bean
    public User user() {
        return new User(userProperties.getName(), userProperties.getAge());
    }
}

在META-INF/spring.factories文件中加入自动配置的类：

1	org.springframework.boot.autoconfigure.EnableAutoConfiguration=love.wangqi.UserAutoConfiguration

最后我们新建一个类来测试一下自动配置的效果：

public class MainApplication {
    @Autowired
    UserProperties userProperties;

    @Bean
    User user() {
        return new User(userProperties.getName(), userProperties.getAge());
    }

    public static void main(String[] args) {
        ApplicationContext context = SpringApplication.run(MainApplication.class, args);
        User user = context.getBean(User.class);
        System.out.println(user);
    }

}

执行程序，输出{name:wangqi, age:21}。随着我们改变application.yml配置，会输出相应修改的结果。

自动配置代码探究

上面我们讨论了如何自定义自动配置的类，下面我们来探究一下这个自动配置是如何发生的。

我们直接看自动配置的发生点，调用流程如下：

SpringApplication.run
SpringApplication.refreshContext
AbstractApplicationContext.refresh
AbstractApplicationContext.invokeBeanFactoryPostProcessors
PostProcessorRegistrationDelegate.invokeBeanFactoryPostProcessors
PostProcessorRegistrationDelegate.invokeBeanDefinitionRegistryPostProcessors
ConfigurationClassPostProcessor.postProcessBeanDefinitionRegistry
ConfigurationClassPostProcessor.processConfigBeanDefinitions
ConfigurationClassParser.parse
ConfigurationClassParser.processDeferredImportSelectors

在ConfigurationClassParser.processDeferredImportSelectors有以下几个步骤：

调用AutoConfigurationImportSelector.selectImports获取所有META-INF/spring.factories文件中定义的EnableAutoConfiguration类。
然后调用ConfigurationClassParser.processImports处理前面获取的EnableAutoConfiguration类

调用ConfigurationClassParser.processConfigurationClass方法将UserAutoConfiguration当成Config类来解析。于是它注册User类的BeanDefinition，在随后的实例化过程实例化User。