由浅入深SpringBoot自动配置原理

由浅入深SpringBoot自动配置原理

Spring的xml配置方式和注解配置方式对比

• 在Spring3.0之前，都是使用的xml与注解结合使用的方式来配置Bean，但在Spring3.0之后官方推荐使用的是使用注解配置
• 环境搭建，创建一个springboot工程，在pom.xml中加入druid的启动器

<dependency>
    <groupId>com.github.drtrang</groupId>
    <artifactId>druid-spring-boot2-starter</artifactId>
    <version>1.1.10</version>
</dependency>

• 在resources中新建jdbc.properties,用于存放数据库配置

jdbc.driverClassName=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql:///test
jdbc.username=root
jdbc.password=123456

• 过去xml的配置方式

<!--使用xml配置druid-->
<bean id="druid" class="com.alibaba.druid.pool.DruidDataSource">
	<property name="driverClassName" value="${jdbc.driverClassName}"/>
	<property name="url" value="${jdbc.url}}"/>
	<property name="username" value="${jdbc.username}"/>
	<property name="password" value="${jdbc.password}"/>
</bean>

• 使用注解的配置方式

import com.alibaba.druid.pool.DruidDataSource;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;
import javax.sql.DataSource;

@Configuration
@PropertySource("classpath:jdbc.properties") //读取资源文件
public class JdbcConfiguration {
    @Value("${jdbc.driverClassName}")
    private String driverClassName;
    @Value("{jdbc.url}")
    private String url;
    @Value("${jdbc.username}")
    private String username;
    @Value("${jdbc.password}")
    private String password;

    @Bean //将返回的dataSource注册到Spring容器中
    public DataSource dataSource(){
        DruidDataSource dataSource = new DruidDataSource();
        dataSource.setDriverClassName(this.driverClassName);
        dataSource.setUrl(this.url);
        dataSource.setUsername(this.username);
        dataSource.setPassword(this.password);
        return dataSource;
    }
}

• 在SpringBoot中自动配置就是基于注解配置这样的配置方式完成的

配置类的优化

• 在该配置类中定义的属性只能在该类使用，如果有别的配置类也需要这几个配置，又只能在类中重新定义这几个私有属性，所以将属性抽取出来，单独创建一个属性读取类来存放
• 创建一个属性读取类JdbcProperties

@ConfigurationProperties(prefix = "jdbc")
public class JdbcProperties {
    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;
    }
}

• 修改之前的配置类

@Configuration
@EnableConfigurationProperties(JdbcProperties.class)
public class JdbcConfiguration {
    @Autowired
    private JdbcProperties jdbcProperties;
    @Bean //将返回的dataSource注册到Spring容器中
    public DataSource dataSource(){
        DruidDataSource dataSource = new DruidDataSource();
        dataSource.setDriverClassName(jdbcProperties.getDriverClassName());
        dataSource.setUrl(jdbcProperties.getUrl());
        dataSource.setUsername(jdbcProperties.getUsername());
        dataSource.setPassword(jdbcProperties.getPassword());
        return dataSource;
    }
}

• @ConfigurationProperties(prefix=“jdbc”)注解
  • 该注解无法读取jdbc.properties配置文件，在springboot应用程序启动时，会自动读取resources下的application.properties或者application.yaml配置文件，并在该注解中指定一个前缀以区分同名的属性，通过前缀来读取属性
  • 所以，在resources下新建一个application.properties配置文件，并将之前jdbc.properties的内容复制过来
• @EnableConfigurationProperties(JdbcProperties.class)注解
  • 使用该注解来启用属性读取类，然后通过@Autowired将属性读取类注入进来，通过getter方法获取属性值

不使用@AutoWired注入，使用构造方法的注入

public JdbcConfiguration(JdbcProperties jdbcProperties){
        this.jdbcProperties = jdbcProperties;
    }

通过方法的形参注入

public DataSource dataSource(JdbcProperties jdbcProperties){
        DruidDataSource dataSource = new DruidDataSource();
        dataSource.setDriverClassName(jdbcProperties.getDriverClassName());
        dataSource.setUrl(jdbcProperties.getUrl());
        dataSource.setUsername(jdbcProperties.getUsername());
        dataSource.setPassword(jdbcProperties.getPassword());
        return dataSource;
    }

最简单优雅的配置方式

@Configuration
public class JdbcConfiguration {
    @Bean
    @ConfigurationProperties("jdbc")
    public DataSource dataSource(){
        DruidDataSource dataSource = new DruidDataSource();
        return dataSource;
    }
}

• 使用该方法注入，不再需要属性读取类，会自动的读取配置文件中的属性注入到被注入的对象的同名setter方法中

SpringBoot自动配置原理

• 之前我们在pom文件中引入了两个启动器，通过查看项目依赖jar包发现，依赖中有这两个jar包
  
• 查看spring-boot-autoconfigure发现包中定义了非常多常用主流框架的自动配置类

• 查看一下WebMvcAutoConfiguration自动配置类的源码
  
• 通过查看源码发现
  • @Configuration注解声明这是一个配置类
  • @ConditionalOnWebApplication(type = Type.SERVLET)，这是一个条件注解，表明如果这是一个servlet工程才生效
  • @ConditionalOnClass({ Servlet.class, DispatcherServlet.class, WebMvcConfigurer.class })注解，申明必须在有Servlet，DispatcherServlet，WebMvcConfigurer这三个类同时存在时才生效
  • @ConditionalOnMissingBean(WebMvcConfigurationSupport.class)，表明不能有WebMvcConfigurationSupport这个类才生效
  • @AutoConfigureOrder(Ordered.HIGHEST_PRECEDENCE + 10)
    @AutoConfigureAfter({ DispatcherServletAutoConfiguration.class, TaskExecutionAutoConfiguration.class,
    ValidationAutoConfiguration.class })，这两个类申明配置启动的时机和顺序

从这几个注解中不难看出，能够使springboot自动配置的核心在三个条件注解中

• 查看视图解析器的配置方法看到通过mvcProperties属性读取类注入了前缀和后缀
  
• 查看mvcProperties声明的位置可以看出WebMvcProperties类就是属性读取类，并且通过@EnableConfigurationProperties注解启用了该属性读取类，
• 通过源码发现WebMvcProperties是通过构造方法注入
  
• 查看WebMvcProperties的源码可以发现使用了@ConfigurationProperties(prefix = “spring.mvc”)注解该类，通过这个注解指定的前缀我们可以知道该类中读取的是application.properties中带有spring.mvc前缀的属性，所以可以通过在配置文件中使用带有spring.mvc的前缀+该类setter方法名覆盖默认配置

• 需要注意的是在setter方法名称中，单词之间使用驼峰的命名规则时，在属性文件中用-号隔开