5、SpringBoot：配置文件及自動配置原理

 

引用文章：微信公眾號狂神說

配置文件

SpringBoot使用一個全局的配置文件 ， 配置文件名稱是固定的

• application.properties

  • 語法結構 ： key=value

• application.yml

  • 語法結構 ：key：空格 value

配置文件的作用 ：修改SpringBoot自動配置的默認值，因為SpringBoot在底層都給我們自動配置好了；** **

YAML

YAML是 "YAML Ain't a Markup Language" （YAML不是一種置標語言）的遞歸縮寫。

在開發的這種語言時，YAML 的意思其實是："Yet Another Markup Language"（仍是一種置標語言）

YAML A Markup Language ：是一個標記語言

YAML isnot Markup Language ：不是一個標記語言

標記語言

以前的配置文件，大多數都是使用xml來配置；比如一個簡單的端口配置，我們來對比下yaml和xml

yaml配置：

server：
    prot: 8080

 

xml配置：

<server>
    <port>8081<port>
</server>

 

YAML語法

基礎語法：

k:(空格) v   

以此來表示一對鍵值對（空格不能省略）；以空格的縮進來控制層級關系，只要是左邊對齊的一列數據都是同一個層級的。

注意 ：屬性和值的大小寫都是十分敏感的。例子：

server:
    port: 8081
    path: /hello

 

值的寫法

字面量：普通的值 [ 數字，布爾值，字符串 ]

k: v

字面量直接寫在后面就可以 ， 字符串默認不用加上雙引號或者單引號；

“” 雙引號，不會轉義字符串里面的特殊字符 ， 特殊字符會作為本身想表示的意思；

比如 ： name: "kuang \n shen" 輸出 ： kuang 換行 shen

'' 單引號，會轉義特殊字符 ， 特殊字符最終會變成和普通字符一樣輸出

比如 ： name: ‘kuang \n shen’ 輸出 ： kuang \n shen

 

對象、Map（鍵值對）

k: 
    v1:
    v2:

 

在下一行來寫對象的屬性和值得關系，注意縮進；比如：

student:
    name: qinjiang
    age: 3

 

行內寫法

student: {name: qinjiang,age: 3}

 

數組（ List、set ）

用 - 值表示數組中的一個元素,比如：

pets:
 - cat
 - dog
 - pig

 

行內寫法

pets: [cat,dog,pig]

 

yaml基本類型舉例

# k: v
# 對空格的要求十分高！
​
# 普通key-value
name: zxh
​
# 對象
student:
  name: zxh
  age: 20
​
# 數組
pets:
  - cat
  - dog
  - pig
​
# 行內寫法
# 對象
student: {name: zxh, age: 20}
# 數組
pets: [cat, dog, pig]

 

修改SpringBoot的默認端口號

配置文件中添加，端口號的參數，就可以切換端口；

server.port=8081

 

注入配置文件

程序實現

1. 如果要使用properties配置文件可能導入時存在亂碼現象 ， 需要在IDEA中進行調整 ， 我們這里直接使用yml文件 ， 將默認的 application.properties后綴修改為yml

  

2. 導入配置文件處理器

<!--導入配置文件處理器，配置文件進行綁定就會有提示-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-configuration-processor</artifactId>
    <optional>true</optional>
</dependency>

 

3.編寫yml 配置文件

person:
  name: 張迅豪${random.uuid} # spring的SpEL表達式，調用方法生成uuid
  age: 20
  birth: 2020/03/03
  happy: false
  maps: {k1: v1, K2: v2}
  lists:
    - apple
    - banana
    - orange
  temp: 小 # 可以定義類中沒有的屬性
  dog:
    name: ${person.temp:temp}旺財 # 表示占位符，表示如果temp為空就不顯示，不為空就輸出小旺財
    age: 3

 

4.在SpringBoot的主程序的同級目錄下建包，只有這樣，主程序才會對這些類生效 ； 我們建一個pojo的包放入我們的Person類和Dog類；

package com.kuang.springbootdemo03.pojo;
​
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
​
import java.util.Date;
import java.util.List;
import java.util.Map;
​
​
/*
@ConfigurationProperties作用：
將配置文件中配置的每一個屬性的值，映射到這個組件中；
告訴SpringBoot將本類中的所有屬性和配置文件中相關的配置進行綁定
參數 prefix = “person” : 將配置文件中的person下面的所有屬性一一對應
​
只有這個組件是容器中的組件，才能使用容器提供的@ConfigurationProperties功能
*/
@Component //注冊bean
@ConfigurationProperties(prefix = "person")
public class Person {
​
    private String name;
    private Integer age;
    private Boolean happy;
    private Date birth;
    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;
​
    //get,set方法
    //toString方法
    
}

 

記得寫上 toString（）方法，方便調試輸出結果

package com.kuang.springbootdemo03.pojo;
​
public class Dog {
    private String name;
    private Integer age;
    
    //get、set方法
    //toString()方法  
}

 

5.確認無誤后，到測試單元中進行測試，看是否注入成功！

@RunWith(SpringRunner.class)
@SpringBootTest
public class SpringbootDemo03ApplicationTests {
​
    @Autowired
    Person person = new Person();
​
    @Test
    public void contextLoads() {
        System.out.println(person);
    }
​
}

 

運行結果

 

  

擴展知識，不使用注解

我們上面采用的方法都是最簡單的方式，開發中最常用的；

那我們來嘮嘮其他的實現方式，道理都是相同得；寫還是那樣寫；

配置文件除了yml還有我們之前常用的properties ， 我們沒有講 ， properties配置文件在寫中文的時候，會有亂碼 ， 我們需要去IDEA中設置編碼格式為UTF-8；

settings-->FileEncodings 中配置；

  

還有，我們的類和配置文件直接關聯着 ， 我們使用的是@configurationProperties的方式，還有一種方式是使用@value

測試

@Component //注冊bean
public class Person {
    //直接使用@value
    @Value("${person.name}") //從配置文件中取值
    private String name;
    @Value("#{11*2}")  //#{SPEL} Spring表達式
    private Integer age;
    @Value("true")  // 字面量
    private Boolean happy;
    
    。。。。。。  
}

 

結果

 

兩種方式比較解析

這個使用起來並不友好！我們需要為每個屬性單獨注解賦值，比較麻煩；我們來看個功能對比圖

• ConfigurationProperties只需要寫一次即可 ， value則需要每個字段都添加

• 松散綁定：這個什么意思呢? 比如我的yml中寫的last-name，在java類的屬性中用駝峰命名lastName是一樣的， - 后面跟着的字母默認是大寫的。這就是松散綁定，可以注入值

• JSR303數據校驗 ， 這個就是我們可以在字段是增加一層過濾器驗證 ， 可以保證數據的合法性

• 復雜類型封裝，yml中可以封裝對象 ， 使用@value就不支持

結論：

• 配置yml和配置properties都可以獲取到值 ， 強烈推薦 yml

• 如果我們在某個業務中，只需要獲取配置文件中的某個值，可以使用一下 @value

• 如果說，我們專門編寫了一個JavaBean來和配置文件進行映射，就直接使用@configurationProperties，不要猶豫！

JSR303數據校驗

解釋

spring-boot中可以用@validated來校驗數據，如果數據異常則會統一拋出異常，方便異常中心統一處理。我們這里來寫個注解讓我們的name只能支持Email格式

就好像是前端的<input type="email">標簽里只能填入郵箱格式的字符串；

使用方法

比如：@Email在jakarta.validation-api-2.0.2.jar包下，@Validated在spring-context-5.2.4.RELEASE.jar包下，所以要去看源碼；下面有常用的注解；

@Component //注冊bean
@ConfigurationProperties(prefix = "person")
@Validated  //數據校驗
public class Person {
    //@Value("${person.name}")
    @Email //name必須是郵箱格式
    // @Email(message = "郵箱格式不正確")
    private Stringname;
}

 

運行結果

  

使用數據校驗，可以保證數據的正確性；

擴展

JSR-303 是JAVA EE 6 中的一項子規范，叫做Bean Validation，Hibernate Validator 是 Bean Validation 的參考實現 . Hibernate Validator 提供了 JSR 303 規范中所有內置 constraint 的實現，除此之外還有一些附加的 constraint。

Bean Validation 中內置的 constraint

Hibernate Validator 附加的 constraint

  

加載指定配置文件注入值

1. @PropertySource ：加載指定的配置文件；使用@configurationProperties默認從全局配置文件中獲取值；

我們去在resources目錄下新建一個person.properties文件

name=kuangshen

 

然后在我們的代碼中指定加載person.properties文件 　　

@PropertySource(value = "classpath:person.properties")
@Component //注冊bean
public class Person {
​
    @Value("${name}")
    private String name;
​
    ......  
}

 

測試結果：

    

配置文件占位符

隨機數

${random.value}、${random.int}、${random.long}、${random.int(10)}等等

 

占位符引用其他屬性的值，如果不存在可以設置默認值

person:
  name: 張迅豪${random.uuid} # spring的SpEL表達式，調用方法生成uuid
  age: 20
  birth: 2020/03/03
  happy: false
  maps: {k1: v1, K2: v2}
  lists:
    - apple
    - banana
    - orange
  temp: 小 # 可以定義類中沒有的屬性
  dog:
    name: ${person.temp:temp}旺財 # 表示占位符，表示如果temp為空就不顯示，不為空就輸出小旺財
    age: 3

  

多環境切換

profile是Spring對不同環境提供不同配置功能的支持，可以通過激活不同的環境版本，實現快速切換環境；

方式一：多配置文件

我們在主配置文件編寫的時候，文件名可以是 application-{profile}.properties/yml ， 用來指定多個環境版本；

例如：application-test.properties 代表測試環境配置 application-dev.properties 代表開發環境配置

但是Springboot並不會直接啟動這些配置文件，它默認使用application.properties主配置文件；

1. 比如：在resources文件夾下有多個環境配置

 　　

2. 默認會運行application.properties文件

3. 我們需要通過一個配置來選擇需要激活的環境；

#比如在配置文件中指定使用application-dev.properties環境，那么需要profiles指定到-后面的單詞就可以了
#我們可以通過設置不同的端口號進行測試；
#我們啟動SpringBoot，就可以看到已經切換到dev下的配置了；
spring.profiles.active=dev

 

方式二：yml的多文檔塊

和properties配置文件中一樣，但是使用yml去實現不需要創建多個配置文件，更加方便了

server:
  port: 8081
#選擇要激活那個環境塊
spring:
  profiles:
    active: prod
​
---
server:
  port: 8083
#配置環境的名稱
spring:
  profiles: dev
​
​
---
​
server:
  port: 8084
spring:
  profiles: prod  #配置環境的名稱

 

注意：如果yml和properties同時都配置了端口，並且沒有激活其他環境 ， 默認會使用properties配置文件的！

配置文件加載位置

springboot 啟動會掃描以下位置的application.properties或者application.yml文件作為Spring boot的默認配置文件

文件在項目中的哪個位置SpringBoot優先掃描哪個文件？

優先級1：項目路徑下的config文件夾配置文件
優先級2：項目路徑下配置文件
優先級3：資源路徑下的config文件夾配置文件
優先級4：資源路徑下配置文件

 

優先級由高到底，高優先級的配置會覆蓋低優先級的配置；

SpringBoot會從這四個位置全部加載主配置文件；*互補配置*；

我們在最低級的配置文件中設置一個項目訪問路徑的配置來測試互補問題；

#配置項目的訪問路徑
server.servlet.context-path=/kuang

 

【擴展】指定位置加載配置文件

我們還可以通過spring.config.location來改變默認的配置文件位置

項目打包好以后，我們可以使用命令行參數的形式，啟動項目的時候來指定配置文件的新位置；

這種情況，一般是后期運維做的多，相同配置，外部指定的配置文件優先級最高

java -jar spring-boot-config.jar --spring.config.location=F:/application.properties

 

外部加載配置文件的方式十分多，我們選擇最常用的即可，在開發的資源文件中進行配置！

官方外部配置文件說明參考文檔

自動配置原理

配置文件到底能寫什么？怎么寫？

SpringBoot官方文檔

分析自動配置原理

1、SpringBoot啟動的時候加載主配置類，開啟了自動配置功能 @EnableAutoConfiguration

2、@EnableAutoConfiguration 作用 ：

• 利用EnableAutoConfigurationImportSelector給容器中導入一些組件，導入了哪些組件呢？

• 可以查看這個類selectImports()方法的內容，他返回了一個 autoConfigurationEntry , 來自 this.getAutoConfigurationEntry(autoConfigurationMetadata, annotationMetadata); 這個方法。我們繼續跟蹤；

• 這個方法中有一個值 ：List<String> configurations = this.getCandidateConfigurations(annotationMetadata, attributes); 叫做獲取候選的配置 ， 我們點擊去繼續跟蹤；

• protected List<String> getCandidateConfigurations(AnnotationMetadata metadata, AnnotationAttributes attributes) {
      List<String> configurations = SpringFactoriesLoader.loadFactoryNames(this.getSpringFactoriesLoaderFactoryClass(), this.getBeanClassLoader());
      Assert.notEmpty(configurations, "No auto configuration classes found in META-INF/spring.factories. If you are using a custom packaging, make sure that file is correct.");
      return configurations;
  }

    

  這里里面有一個 SpringFactoriesLoader.loadFactoryNames() ，我們繼續進去看 , 它又調用了loadSpringFactories方法；繼續跟蹤。發現它去獲得了一個資源文件："META-INF/spring.factories"

• Enumeration<URL> urls = classLoader != null ? classLoader.getResources("META-INF/spring.factories") : ClassLoader.getSystemResources("META-INF/spring.factories");

   

  繼續閱讀源碼 ， 它將讀取到的資源封裝在url中，然后遍歷url ， 將這些url文件封裝在Properties文件中；最后返回封裝好的結果；他的那個ClassLoader參數，我們追蹤回去，看到他就是 EnableAutoConfiguration ；

• 說明了這個邏輯就是 從properties中獲取到EnableAutoConfiguration.class類（類名）對應的值，然后把他們添加在容器中

• 總結一句話就是：將類路徑下 META-INF/spring.factories 里面配置的所有EnableAutoConfiguration的值加入到了容器中；我們從源碼中拿過來

# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
org.springframework.boot.autoconfigure.admin.SpringApplicationAdminJmxAutoConfiguration,\
org.springframework.boot.autoconfigure.aop.AopAutoConfiguration,\
org.springframework.boot.autoconfigure.amqp.RabbitAutoConfiguration,\
org.springframework.boot.autoconfigure.batch.BatchAutoConfiguration,\
org.springframework.boot.autoconfigure.cache.CacheAutoConfiguration,\
org.springframework.boot.autoconfigure.cassandra.CassandraAutoConfiguration,\
org.springframework.boot.autoconfigure.cloud.CloudServiceConnectorsAutoConfiguration,\
org.springframework.boot.autoconfigure.context.ConfigurationPropertiesAutoConfiguration,\
org.springframework.boot.autoconfigure.context.MessageSourceAutoConfiguration,\
org.springframework.boot.autoconfigure.context.PropertyPlaceholderAutoConfiguration,\
org.springframework.boot.autoconfigure.couchbase.CouchbaseAutoConfiguration,\
org.springframework.boot.autoconfigure.dao.PersistenceExceptionTranslationAutoConfiguration,\
org.springframework.boot.autoconfigure.data.cassandra.CassandraDataAutoConfiguration,\
org.springframework.boot.autoconfigure.data.cassandra.CassandraReactiveDataAutoConfiguration,\
org.springframework.boot.autoconfigure.data.cassandra.CassandraReactiveRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.cassandra.CassandraRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.couchbase.CouchbaseDataAutoConfiguration,\
org.springframework.boot.autoconfigure.data.couchbase.CouchbaseReactiveDataAutoConfiguration,\
org.springframework.boot.autoconfigure.data.couchbase.CouchbaseReactiveRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.couchbase.CouchbaseRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.elasticsearch.ElasticsearchAutoConfiguration,\
org.springframework.boot.autoconfigure.data.elasticsearch.ElasticsearchDataAutoConfiguration,\
org.springframework.boot.autoconfigure.data.elasticsearch.ElasticsearchRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.jdbc.JdbcRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.jpa.JpaRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.ldap.LdapRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.mongo.MongoDataAutoConfiguration,\
org.springframework.boot.autoconfigure.data.mongo.MongoReactiveDataAutoConfiguration,\
org.springframework.boot.autoconfigure.data.mongo.MongoReactiveRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.mongo.MongoRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.neo4j.Neo4jDataAutoConfiguration,\
org.springframework.boot.autoconfigure.data.neo4j.Neo4jRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.solr.SolrRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.redis.RedisAutoConfiguration,\
org.springframework.boot.autoconfigure.data.redis.RedisReactiveAutoConfiguration,\
org.springframework.boot.autoconfigure.data.redis.RedisRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.rest.RepositoryRestMvcAutoConfiguration,\
org.springframework.boot.autoconfigure.data.web.SpringDataWebAutoConfiguration,\
org.springframework.boot.autoconfigure.elasticsearch.jest.JestAutoConfiguration,\
org.springframework.boot.autoconfigure.elasticsearch.rest.RestClientAutoConfiguration,\
org.springframework.boot.autoconfigure.flyway.FlywayAutoConfiguration,\
org.springframework.boot.autoconfigure.freemarker.FreeMarkerAutoConfiguration,\
org.springframework.boot.autoconfigure.gson.GsonAutoConfiguration,\
org.springframework.boot.autoconfigure.h2.H2ConsoleAutoConfiguration,\
org.springframework.boot.autoconfigure.hateoas.HypermediaAutoConfiguration,\
org.springframework.boot.autoconfigure.hazelcast.HazelcastAutoConfiguration,\
org.springframework.boot.autoconfigure.hazelcast.HazelcastJpaDependencyAutoConfiguration,\
org.springframework.boot.autoconfigure.http.HttpMessageConvertersAutoConfiguration,\
org.springframework.boot.autoconfigure.http.codec.CodecsAutoConfiguration,\
org.springframework.boot.autoconfigure.influx.InfluxDbAutoConfiguration,\
org.springframework.boot.autoconfigure.info.ProjectInfoAutoConfiguration,\
org.springframework.boot.autoconfigure.integration.IntegrationAutoConfiguration,\
org.springframework.boot.autoconfigure.jackson.JacksonAutoConfiguration,\
org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration,\
org.springframework.boot.autoconfigure.jdbc.JdbcTemplateAutoConfiguration,\
org.springframework.boot.autoconfigure.jdbc.JndiDataSourceAutoConfiguration,\
org.springframework.boot.autoconfigure.jdbc.XADataSourceAutoConfiguration,\
org.springframework.boot.autoconfigure.jdbc.DataSourceTransactionManagerAutoConfiguration,\
org.springframework.boot.autoconfigure.jms.JmsAutoConfiguration,\
org.springframework.boot.autoconfigure.jmx.JmxAutoConfiguration,\
org.springframework.boot.autoconfigure.jms.JndiConnectionFactoryAutoConfiguration,\
org.springframework.boot.autoconfigure.jms.activemq.ActiveMQAutoConfiguration,\
org.springframework.boot.autoconfigure.jms.artemis.ArtemisAutoConfiguration,\
org.springframework.boot.autoconfigure.groovy.template.GroovyTemplateAutoConfiguration,\
org.springframework.boot.autoconfigure.jersey.JerseyAutoConfiguration,\
org.springframework.boot.autoconfigure.jooq.JooqAutoConfiguration,\
org.springframework.boot.autoconfigure.jsonb.JsonbAutoConfiguration,\
org.springframework.boot.autoconfigure.kafka.KafkaAutoConfiguration,\
org.springframework.boot.autoconfigure.ldap.embedded.EmbeddedLdapAutoConfiguration,\
org.springframework.boot.autoconfigure.ldap.LdapAutoConfiguration,\
org.springframework.boot.autoconfigure.liquibase.LiquibaseAutoConfiguration,\
org.springframework.boot.autoconfigure.mail.MailSenderAutoConfiguration,\
org.springframework.boot.autoconfigure.mail.MailSenderValidatorAutoConfiguration,\
org.springframework.boot.autoconfigure.mongo.embedded.EmbeddedMongoAutoConfiguration,\
org.springframework.boot.autoconfigure.mongo.MongoAutoConfiguration,\
org.springframework.boot.autoconfigure.mongo.MongoReactiveAutoConfiguration,\
org.springframework.boot.autoconfigure.mustache.MustacheAutoConfiguration,\
org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration,\
org.springframework.boot.autoconfigure.quartz.QuartzAutoConfiguration,\
org.springframework.boot.autoconfigure.reactor.core.ReactorCoreAutoConfiguration,\
org.springframework.boot.autoconfigure.security.servlet.SecurityAutoConfiguration,\
org.springframework.boot.autoconfigure.security.servlet.SecurityRequestMatcherProviderAutoConfiguration,\
org.springframework.boot.autoconfigure.security.servlet.UserDetailsServiceAutoConfiguration,\
org.springframework.boot.autoconfigure.security.servlet.SecurityFilterAutoConfiguration,\
org.springframework.boot.autoconfigure.security.reactive.ReactiveSecurityAutoConfiguration,\
org.springframework.boot.autoconfigure.security.reactive.ReactiveUserDetailsServiceAutoConfiguration,\
org.springframework.boot.autoconfigure.sendgrid.SendGridAutoConfiguration,\
org.springframework.boot.autoconfigure.session.SessionAutoConfiguration,\
org.springframework.boot.autoconfigure.security.oauth2.client.servlet.OAuth2ClientAutoConfiguration,\
org.springframework.boot.autoconfigure.security.oauth2.client.reactive.ReactiveOAuth2ClientAutoConfiguration,\
org.springframework.boot.autoconfigure.security.oauth2.resource.servlet.OAuth2ResourceServerAutoConfiguration,\
org.springframework.boot.autoconfigure.security.oauth2.resource.reactive.ReactiveOAuth2ResourceServerAutoConfiguration,\
org.springframework.boot.autoconfigure.solr.SolrAutoConfiguration,\
org.springframework.boot.autoconfigure.task.TaskExecutionAutoConfiguration,\
org.springframework.boot.autoconfigure.task.TaskSchedulingAutoConfiguration,\
org.springframework.boot.autoconfigure.thymeleaf.ThymeleafAutoConfiguration,\
org.springframework.boot.autoconfigure.transaction.TransactionAutoConfiguration,\
org.springframework.boot.autoconfigure.transaction.jta.JtaAutoConfiguration,\
org.springframework.boot.autoconfigure.validation.ValidationAutoConfiguration,\
org.springframework.boot.autoconfigure.web.client.RestTemplateAutoConfiguration,\
org.springframework.boot.autoconfigure.web.embedded.EmbeddedWebServerFactoryCustomizerAutoConfiguration,\
org.springframework.boot.autoconfigure.web.reactive.HttpHandlerAutoConfiguration,\
org.springframework.boot.autoconfigure.web.reactive.ReactiveWebServerFactoryAutoConfiguration,\
org.springframework.boot.autoconfigure.web.reactive.WebFluxAutoConfiguration,\
org.springframework.boot.autoconfigure.web.reactive.error.ErrorWebFluxAutoConfiguration,\
org.springframework.boot.autoconfigure.web.reactive.function.client.ClientHttpConnectorAutoConfiguration,\
org.springframework.boot.autoconfigure.web.reactive.function.client.WebClientAutoConfiguration,\
org.springframework.boot.autoconfigure.web.servlet.DispatcherServletAutoConfiguration,\
org.springframework.boot.autoconfigure.web.servlet.ServletWebServerFactoryAutoConfiguration,\
org.springframework.boot.autoconfigure.web.servlet.error.ErrorMvcAutoConfiguration,\
org.springframework.boot.autoconfigure.web.servlet.HttpEncodingAutoConfiguration,\
org.springframework.boot.autoconfigure.web.servlet.MultipartAutoConfiguration,\
org.springframework.boot.autoconfigure.web.servlet.WebMvcAutoConfiguration,\
org.springframework.boot.autoconfigure.websocket.reactive.WebSocketReactiveAutoConfiguration,\
org.springframework.boot.autoconfigure.websocket.servlet.WebSocketServletAutoConfiguration,\
org.springframework.boot.autoconfigure.websocket.servlet.WebSocketMessagingAutoConfiguration,\
org.springframework.boot.autoconfigure.webservices.WebServicesAutoConfiguration,\
org.springframework.boot.autoconfigure.webservices.client.WebServiceTemplateAutoConfiguration

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

3、每一個自動配置類可以進行自動配置功能；

4、我們以HttpEncodingAutoConfiguration（Http編碼自動配置）為例解釋自動配置原理；

 

@Configuration //表示這是一個配置類，以前編寫的配置文件一樣，也可以給容器中添加組件
//啟動指定類的ConfigurationProperties功能；
//進入這個HttpProperties查看，將配置文件中對應的值和HttpProperties綁定起來；
//並把HttpProperties加入到ioc容器中
@EnableConfigurationProperties({HttpProperties.class}) 
​
//Spring底層@Conditional注解
//根據不同的條件判斷，如果滿足指定的條件，整個配置類里面的配置就會生效；
//這里的意思就是判斷當前應用是否是web應用，如果是，當前配置類生效
@ConditionalOnWebApplication(
    type = Type.SERVLET
)
​
//判斷當前項目有沒有這個類CharacterEncodingFilter；SpringMVC中進行亂碼解決的過濾器；
@ConditionalOnClass({CharacterEncodingFilter.class})
​
//判斷配置文件中是否存在某個配置：spring.http.encoding.enabled；
//如果不存在，判斷也是成立的
//即使我們配置文件中不配置pring.http.encoding.enabled=true，也是默認生效的；
@ConditionalOnProperty(
    prefix = "spring.http.encoding",
    value = {"enabled"},
    matchIfMissing = true
)
​
public class HttpEncodingAutoConfiguration {
​
    //他已經和SpringBoot的配置文件映射了
    private final Encoding properties;
​
    //只有一個有參構造器的情況下，參數的值就會從容器中拿
    public HttpEncodingAutoConfiguration(HttpProperties properties) {
        this.properties = properties.getEncoding();
    }
​
    //給容器中添加一個組件，這個組件的某些值需要從properties中獲取
    @Bean
    @ConditionalOnMissingBean //判斷容器沒有這個組件？
    public CharacterEncodingFilter characterEncodingFilter() {
        CharacterEncodingFilter filter = new OrderedCharacterEncodingFilter();
        filter.setEncoding(this.properties.getCharset().name());
        filter.setForceRequestEncoding(this.properties.shouldForce(org.springframework.boot.autoconfigure.http.HttpProperties.Encoding.Type.REQUEST));
        filter.setForceResponseEncoding(this.properties.shouldForce(org.springframework.boot.autoconfigure.http.HttpProperties.Encoding.Type.RESPONSE));
        return filter;
    }
    。。。。。。
}    

一句話總結 ： 根據當前不同的條件判斷，決定這個配置類是否生效！

一但這個配置類生效；這個配置類就會給容器中添加各種組件；這些組件的屬性是從對應的properties類中獲取的，這些類里面的每一個屬性又是和配置文件綁定的；

5、所有在配置文件中能配置的屬性都是在xxxxProperties類中封裝者‘；配置文件能配置什么就可以參照某個功能對應的這個屬性類

@ConfigurationProperties(
    prefix = "spring.http"
) //從配置文件中獲取指定的值和bean的屬性進行綁定
public class HttpProperties {
    private boolean logRequestDetails;
    private final HttpProperties.Encoding encoding = new HttpProperties.Encoding();
​
    public HttpProperties() {
    }
​
    public boolean isLogRequestDetails() {
        return this.logRequestDetails;
    }
​
    public void setLogRequestDetails(boolean logRequestDetails) {
        this.logRequestDetails = logRequestDetails;
    }
​
    public HttpProperties.Encoding getEncoding() {
        return this.encoding;
    }
​
    public static class Encoding {
        public static final Charset DEFAULT_CHARSET;
        private Charset charset;
        private Boolean force;
        private Boolean forceRequest;
        private Boolean forceResponse;
        private Map<Locale, Charset> mapping;
        
        、、、、、、
    }
}

 

我們去配置文件里面試試前綴，看提示！

  

這就是自動裝配的原理！

精髓：

1）、SpringBoot啟動會加載大量的自動配置類

2）、我們看我們需要的功能有沒有在SpringBoot默認寫好的自動配置類當中；

3）、再看這個自動配置類中到底配置了哪些組件；（只要我們要用的組件存在在其中，我們就不需要再手動配置了）

4）、給容器中自動配置類添加組件的時候，會從properties類中獲取某些屬性。我們只需要在配置文件中指定這些屬性的值即可；

xxxxAutoConfigurartion：自動配置類；給容器中添加組件

xxxxProperties:封裝配置文件中相關屬性；

 

@Conditional

了解完自動裝配的原理后，我們來關注一個細節問題 ，自動配置類必須在一定的條件下才能生效；

@Conditional派生注解（Spring注解版原生的@Conditional作用）

作用：必須是@Conditional指定的條件成立，才給容器中添加組件，配置配里面的所有內容才生效；

那么多的自動配置類，必須在一定的條件下才能生效；也就是說，我們加載了這么多的配置類，但不是所有的都生效了。

我們怎么知道哪些自動配置類生效；我們可以通過啟用 debug=true屬性；來讓控制台打印自動配置報告，這樣我們就可以很方便的知道哪些自動配置類生效；

#開啟springboot的調試類
debug=true

 

Positive matches:（自動配置類啟用的：正匹配）

Negative matches:（沒有啟動，沒有匹配成功的自動配置類：負匹配）

Unconditional classes: （沒有條件的類）

輸出的日志我們可以在這里看下：

 

  

就會在控制台打印日志