spring boot 系列之六：深刻理解spring boot的自动配置

时间 2019-11-08

标签 spring boot 系列之六深刻理解自动配置栏目 Spring 繁體版

原文原文链接

咱们知道，spring boot自动配置功能能够根据不一样状况来决定spring配置应该用哪一个，不该该用哪一个，举个例子：linux

Spring的JdbcTemplate是否是在Classpath里面？若是是，而且DataSource也存在，就自动配置一个JdbcTemplate的Bean
Thymeleaf是否是在Classpath里面？若是是，则自动配置Thymeleaf的模板解析器、视图解析器、模板引擎

那个这个是怎么实现的呢？缘由就在于它利用了Spring的条件化配置，条件化配置容许配置存在于应用中，可是在知足某些特定条件前会忽略这些配置。spring

要实现条件化配置咱们要用到@Conditional条件化注解。apache

本篇随便讲从以下三个方面进行展开：windows

@Conditional小例子，来讲明条件化配置的实现方式
spring boot 的条件化配置详解
spring boot 自动配置源码分析
本身动手实现spring boot starter pom

1、@Conditional小例子app

咱们知道在windows下显示列表的命令是dir，而在linux系统下显示列表的命令是ls，基于条件配置，咱们能够实如今不一样的操做系统下返回不一样的值。maven

判断条件定义

)windows下的断定条件

/**
 * 实现spring 的Condition接口，而且重写matches()方法，若是操做系统是windows就返回true
 *
 */
public class WindowsCondition implements Condition{

    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        
        return context.getEnvironment().getProperty("os.name").contains("Windows");
    }

    
}

)linux下的断定条件

/**
 * 实现spring 的Condition接口，而且重写matches()方法，若是操做系统是linux就返回true
 *
 */
public class LinuxCondition implements Condition{

    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        
        return context.getEnvironment().getProperty("os.name").contains("Linux");
    }

    
}

不一样系统下的Bean的类

）接口

public interface ListService {

    public String showListLine();
}

）windows下的Bean类

public class WindowsListService implements ListService{

    @Override
    public String showListLine() {
        return "dir";
    }

}

）linux下的Bean的类

public class LinuxListService implements ListService{

    @Override
    public String showListLine() {
        return "ls";
    }

}

配置类

@Configuration
public class ConditionConfig {

    /**
     * 经过@Conditional 注解，符合windows条件就返回WindowsListService实例
     * 
     */
    @Bean
    @Conditional(WindowsCondition.class)
    public ListService windonwsListService() {
        return new WindowsListService();
    }

    /**
     * 经过@Conditional 注解，符合linux条件就返回LinuxListService实例
     * 
     */
    @Bean
    @Conditional(LinuxCondition.class)
    public ListService linuxListService() {
        return new LinuxListService();
    }
}

测试类

public class ConditionTest {

    public static void main(String[] args) {

        AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(ConditionConfig.class);
        ListService listService = context.getBean(ListService.class);
        System.out
                .println(context.getEnvironment().getProperty("os.name") + " 系统下的列表命令为： " + listService.showListLine());
    }
}

运行测试类，因为个人是windows7 系统，所以结果是
```
Windows 7 系统下的列表命令为： dir
```
若是你的是linux系统，则结果就会是ide
```
Linux 系统下的列表命令为： ls
```

2、spring boot 的条件化配置spring-boot

在spring boot项目中会存在一个名为spring-boot-autoconfigure的jar包源码分析

条件化配置就是在这个jar里面实现的，它用到了以下的条件化注解，这些注解都是以@ConditionalOn开头的，他们都是应用了@Conditional的组合注解：测试

接下来咱们看个源码的列子：

以JdbcTemplateAutoConfiguration为例，它里面有这段代码：

@Bean
    @Primary
    @ConditionalOnMissingBean(JdbcOperations.class)
    public JdbcTemplate jdbcTemplate() {
        return new JdbcTemplate(this.dataSource);
    }

只有在不存在JdbcOperations（若是查看JdbcTemplate的源码，你会发现JdbcTemplate类实现了JdbcOperations接口）实例的时候，才会初始化一个JdbcTemplate 的Bean。

基于以上内容，咱们就能够阅读自动配置相关的源码了。

3、spring boot 自动配置源码分析

spring boot项目的启动类用的注解--@SpringBootApplication是一个组合注解，其中@EnableAutoConfiguration是自动配置相关的。

而这个@EnableAutoConfiguration注解里面有个@Import注解导入了EnableAutoConfigurationImportSelector用来实现具体的功能

（注：因为我本地的spring boot版本不是最新的，这里的EnableAutoConfigurationImportSelector已经不建议使用了，新版本可能已经换成了其余类，可是不影响咱们看代码）

这个类继承了AutoConfigurationImportSelector

进入父类，里面有个方法selectImports（）调用了方法getCandidateConfigurations（），进而调用了SpringFactoriesLoader.loadFactoryNames（）方法

在SpringFactoriesLoader.loadFactoryNames（）方法里面，咱们看到会查询META-INF/spring.factories这个配置文件

SpringFactoriesLoader.loadFactoryNames方法会扫描具备META-INF/spring.factories文件的jar包，而咱们的spring-boot-autoconfigure.jar里面就有一个这样的文件，此文件中声明了具体有哪些自动配置：

咱们上面提到的JdbcTemplateAutoConfiguration自动配置类就在里面。

4、编写本身的spring boot starter pom

接下来，咱们就来写一个简单的spring boot starter pom。

步骤以下：

新建starter maven项目spring-boot-starter-hello

修改pom文件

<project xmlns="http://maven.apache.org/POM/4.0.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.sam</groupId>
    <artifactId>spring-boot-starter-hello</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>

    <dependencies>
        <!-- 这里须要引入spring boot的自动配置做为依赖 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-autoconfigure</artifactId>
            <version>1.5.1.RELEASE</version>
        </dependency>


    </dependencies>
</project>

属性配置

/**
 * @ConfigurationProperties
 * 自动匹配application.properties文件中hello.msg的值，而后赋值给类属性msg，这里的msg默认值为“spring boot”
 *
 */
@ConfigurationProperties(prefix="hello")
public class HelloServiceProperties {

    private static final String MSG = "spring boot";
    
    private String msg = MSG;

    public String getMsg() {
        return msg;
    }

    public void setMsg(String msg) {
        this.msg = msg;
    }
    
    
}

断定依据类

/**
 * 后面的代码会依据此类是否存在，来决定是否生产对应的Bean
 *
 */
public class HelloService {

    private String msg;

    public String getMsg() {
        return msg;
    }

    public void setMsg(String msg) {
        this.msg = msg;
    }

    public String sayHello() {
        return "hello " + msg;
    }
}

自动配置类

@Configuration
@EnableConfigurationProperties(HelloServiceProperties.class)
@ConditionalOnClass(HelloService.class)
@ConditionalOnProperty(prefix = "hello", matchIfMissing = true, value = "enabled")
public class HelloServiceAutoConfiguration {

    @Autowired
    HelloServiceProperties helloServiceProperties;

    @Bean
    @ConditionalOnMissingBean(HelloService.class)
    public HelloService helloService() {
        HelloService service = new HelloService();
        service.setMsg(helloServiceProperties.getMsg());
        return service;
    }
}

根据HelloServiceProperties提供的参数，并经过@ConditionalOnClass(HelloService.class)断定HelloService这个类在Classpath中是否存在，存在而且尚未对应的Bean，就生成对应的helloService Bean

注册配置，须要到META-INF/spring.factories文件中注册改自动配置类：在src/main/source目录下新建改文件，而后进行配置。
```
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.sam.spring_boot_starter_hello.HelloServiceAutoConfiguration
```
对该工程进行mvn clean install，将jar推送到本地maven仓库，供后续使用。

）修改pom，引入上述的依赖

<dependency>
            <groupId>com.sam</groupId>
            <artifactId>spring-boot-starter-hello</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>

）实现controller

@RestController
public class HelloController {
　　//代码中没有配置这个helloService Bean，可是自动配置可以帮忙实例化，所以能够直接注入
    @Autowired
    HelloService helloService;
    
    @RequestMapping(value="/helloService")
    public String sayHello() {
        return helloService.sayHello();
    }
}

）页面访问/helloService接口
）在application.properties里面配置hello.msg=sam，而后再次访问/helloService接口