Spring Boot自動配置原理分析

時間 2019-11-08

標籤 spring boot 自動配置原理分析欄目 Spring 简体版

原文原文鏈接

　　咱們知道，spring boot自動配置功能能夠根據不一樣狀況來決定spring配置應該用哪一個，不該該用哪一個，舉個例子：html

　　Spring的JdbcTemplate是否是在Classpath裏面？若是是，而且DataSource也存在，就自動配置一個JdbcTemplate的Bean；java

　　Thymeleaf是否是在Classpath裏面？若是是，則自動配置Thymeleaf的模板解析器、視圖解析器、模板引擎。linux

　　那這個是怎麼實現的呢？緣由就在於它利用了Spring的條件化配置，條件化配置容許配置存在於應用中，可是在知足某些特定條件前會忽略這些配置。web

　　要實現條件化配置咱們要用到@Conditional條件化註解。spring

　　本篇將從以下三個方面進行展開：apache

@Conditional小例子，來講明條件化配置的實現方式
spring boot 的條件化配置詳解
spring boot 自動配置源碼分析
本身動手實現spring boot starter pom

1、@Conditional小例子

　　咱們知道在windows下顯示列表的命令是dir，而在linux系統下顯示列表的命令是ls，基於條件配置，咱們能夠實如今不一樣的操做系統下返回不一樣的值。windows

【判斷條件定義】app

windows下的斷定條件maven

/**
 * 實現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下的斷定條件ide

/**
 * 實現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());
    }
}

2、Spring Boot的條件化配置

　　在spring boot項目中會存在一個名爲spring-boot-autoconfigure的jar包

　　條件化配置就是在這個jar裏面實現的，它用到了以下的條件化註解，這些註解都是以@ConditionalOn開頭的，他們都是應用了@Conditional的組合註解：

　　接下來咱們看個源碼的列子：

　　以JdbcTemplateAutoConfiguration爲例，它裏面有這段代碼：

　　只有在不存在JdbcOperations（若是查看JdbcTemplate的源碼，你會發現JdbcTemplate類實現了JdbcOperations接口）實例的時候，纔會初始化一個JdbcTemplate的Bean。

　　因此說，自動配置類必須在必定的條件下才能生效；

　　咱們怎麼知道哪些自動配置類生效？

　　咱們能夠在主配置文件中啓用debug=true屬性；來讓控制檯打印自動配置報告，這樣咱們就能夠很方便的知道哪些自動配置類生效；

3、Spring Boot自動配置源碼分析

　　spring boot項目的啓動類用的註解--@SpringBootApplication是一個組合註解，其中@EnableAutoConfiguration是自動配置相關的。　　

　　而這個@EnableAutoConfiguration註解裏面有個@Import註解導入了AutoConfigurationImportSelector用來實現具體的功能

　　AutoConfigurationImportSelector這個類裏面有個selectImports()方法，它調用了getCandidateConfigurations()方法，進而調用了SpringFactoriesLoader.loadFactoryNames()方法

　　在SpringFactoriesLoader.loadFactoryNames()方法裏面，咱們看到會查詢META-INF/spring.factories這個配置文件

　　SpringFactoriesLoader.loadFactoryNames方法會掃描具備META-INF/spring.factories文件的jar包，把掃描到的這些文件的內容包裝成properties對象，從properties中獲取到EnableAutoConfiguration.class類（類名）對應的值，而後把他們添加在容器中。

　　每個這樣的 xxxAutoConfiguration類都是容器中的一個組件，都加入到容器中，用他們來作自動配置。

　　咱們上面提到的JdbcTemplateAutoConfiguration自動配置類就在裏面。

　　以HttpEncodingAutoConfiguration（Http編碼自動配置）爲例解釋自動配置原理；

@Configuration   //表示這是一個配置類，之前編寫的配置文件同樣，也能夠給容器中添加組件
@EnableConfigurationProperties(HttpEncodingProperties.class)  //啓動指定類的ConfigurationProperties功能；將配置文件中對應的值和HttpEncodingProperties綁定起來；並把HttpEncodingProperties加入到ioc容器中

@ConditionalOnWebApplication //Spring底層@Conditional註解（Spring註解版），根據不一樣的條件，若是知足指定的條件，整個配置類裏面的配置就會生效；    判斷當前應用是不是web應用，若是是，當前配置類生效

@ConditionalOnClass(CharacterEncodingFilter.class)  //判斷當前項目有沒有這個類CharacterEncodingFilter；SpringMVC中進行亂碼解決的過濾器；

@ConditionalOnProperty(prefix = "spring.http.encoding", value = "enabled", matchIfMissing = true)  //判斷配置文件中是否存在某個配置  spring.http.encoding.enabled；若是不存在，判斷也是成立的
//即便咱們配置文件中不配置pring.http.encoding.enabled=true，也是默認生效的；
public class HttpEncodingAutoConfiguration {
  
      //他已經和SpringBoot的配置文件映射了
      private final HttpEncodingProperties properties;
  
   //只有一個有參構造器的狀況下，參數的值就會從容器中拿
      public HttpEncodingAutoConfiguration(HttpEncodingProperties properties) {
        this.properties = properties;
    }
  
    @Bean   //給容器中添加一個組件，這個組件的某些值須要從properties中獲取
    @ConditionalOnMissingBean(CharacterEncodingFilter.class) //判斷容器沒有這個組件？
    public CharacterEncodingFilter characterEncodingFilter() {
        CharacterEncodingFilter filter = new OrderedCharacterEncodingFilter();
        filter.setEncoding(this.properties.getCharset().name());
        filter.setForceRequestEncoding(this.properties.shouldForce(Type.REQUEST));
        filter.setForceResponseEncoding(this.properties.shouldForce(Type.RESPONSE));
        return filter;
    }

　　根據當前不一樣的條件判斷，決定這個配置類是否生效。一但這個配置類生效；這個配置類就會給容器中添加各類組件；這些組件的屬性是從對應的properties類中獲取的，這些類裏面的每個屬性又是和配置文件綁定的；

　　全部在配置文件中能配置的屬性都是在xxxxProperties類中封裝者；配置文件能配置什麼就能夠參照某個功能對應的這個屬性類

@ConfigurationProperties(prefix = "spring.http.encoding")  //從配置文件中獲取指定的值和bean的屬性進行綁定
public class HttpEncodingProperties {

   public static final Charset DEFAULT_CHARSET = Charset.forName("UTF-8");

【Spring Boot的精髓總結】

SpringBoot啓動會加載大量的自動配置類；
咱們看咱們須要的功能有沒有SpringBoot默認寫好的自動配置類；
咱們再來看這個自動配置類中到底配置了哪些組件；（只要咱們要用的組件有，咱們就不須要再來配置了）
給容器中自動配置類添加組件的時候，會從properties類中獲取某些屬性。咱們就能夠在配置文件中指定這些屬性的值；

4、自定義一個spring-boot-starter

　　接下來，咱們就來寫一個簡單的spring boot starter pom。

　　步驟以下：

【建立一個maven項目】

　　新建starter maven項目：spring-boot-starter-hello

【修改pom文件】

<?xml version="1.0" encoding="UTF-8"?>
<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>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.6.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.pinyougou</groupId>
    <artifactId>spring-boot-starter-hello</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>spring-boot-starter-hello</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>

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

    <build>
        <resources>
            <!--Maven打jar包把配置文件放在META-INF目錄下-->
            <resource>
                <directory>src/main/resources</directory>
                <targetPath>META-INF/</targetPath>
            </resource>
        </resources>
    </build>
</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/resources目錄下新建該文件，而後進行配置。

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.pinyougou.spring-boot-starter-hello.HelloServiceAutoConfiguration

【安裝到本地倉庫】

　　對該工程進行mvn clean install，將jar推送到本地maven倉庫，供後續使用。

【使用starter】

　　使用咱們這個starter 須要新建一個或使用既存的一個spring boot工程（這裏我用的是既存的），而後

修改pom，引入上述的依賴

<dependency>
    <groupId>com.pinyougou</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();
    }
}