一肺蔚、配置文件

springboot使用一個全局的配置文件加矛，配置文件名是固定的履婉，一般有兩種寫法：

• application.properties
• application.yml

配置文件的作用：SpringBoot在底層都給我們自動配置了，而配置文件的作用就是修改SpringBoot自動配置的默認(rèn)值斟览。

之前的配置文件毁腿，都是使用的xml文件格式，但是YAML也可以做配置文件苛茂，YAML是以數(shù)據(jù)為中心已烤，比JSON、XML等等更適合做配置文件妓羊。
配置示例（將端口號設(shè)置為8081）

server:
  port: 8081

二胯究、YAML語法

1、基本語法

k: v:表示一對鍵值對（空格必須有）躁绸。以空格的縮進(jìn)來控制層級關(guān)系裕循，只要是左對齊的一列數(shù)據(jù)，都是同一個層級的净刮。并且其屬性和值都是大小寫敏感的剥哑。

示例：

server:
  port: 8081
  path: /hello

2、值的寫法

(1)庭瑰、字面量：普通的值（數(shù)字星持，字符串，布爾）

使用k: v:
對于字符串弹灭，默認(rèn)不用加上單引號或者雙引號督暂，""雙引號不會轉(zhuǎn)義字符串里面的特殊字符，特殊字符會作為本身想表示的意思穷吮；''單引號就會轉(zhuǎn)義字符逻翁，特殊字符最終只是一個普通的字符串?dāng)?shù)據(jù)。

(2)捡鱼、對象八回、Map（屬性和值）

還是使用k:v:方式，在下一行來寫對象的屬性和值的關(guān)系，注意縮進(jìn)缠诅，例如：

friend:
  lastName: zhangsan
  age: 20

這樣表示lastName和age是friend對象的屬性溶浴。
也可以寫成行內(nèi)寫法：friend: {lastName: zhangsan,age: 18}

(3)、數(shù)組（List管引、Set）

用-表示數(shù)組中的一個元素

pets:
  - cat,
  - dog,
  - pig

也可以寫成：pets: [cat,dog,pig]

三士败、配置文件值注入

在JavaBean類中加入@ConfigurationProperties注解將配置文件中配置的每一個屬性的值映射到這個組件中，并且要將這個類加入到IOC容器中褥伴。要注意的是@ConfigurationProperties默認(rèn)是從全局配置文件中獲取值的谅将。

1、一個簡單的示例

yml文件：

person:
  lastName: zhangsan
  age: 18
  boss: false
  birth: 2019/12/12
  map: {k1: 1,k2: 2}
  list:
    - lisi
    - zhaoliu
  dog:
     name: 小狗
     age: 2

JavaBean（省略getter重慢、setter饥臂、toString方法）：

package com.cerr.springboot.bean;
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將本類中的所有屬性和配置文件中相關(guān)的配置進(jìn)行綁定
 *      prefix：配置文件中哪個下面的所有屬性進(jìn)行配置
 *
 *  只有這個組件是容器中的組件，才能使用容器提供的ConfigurationProperties功能
 */
@Component
@ConfigurationProperties(prefix = "person")
public class Person {
    private String lastName;
    private Integer age;
    private Boolean boss;
    private Date birth;

    private Map<String,Object> map;
    private List<Object> list;
    private Dog dog;
}

我們可以導(dǎo)入配置文件處理器似踱，以后編寫配置就有提示：

        <!-- 導(dǎo)入配置文件處理器隅熙，配置文件進(jìn)行綁定就會有提示 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
        </dependency>

剛剛在yml中的配置也可以在properties中配置：

person.last-name=張三
person.age=14
person.birth=2019/12/2
person.boss=false
person.map.k1=11
person.map.k2=22
person.list=a,b,c
person.dog.name=dog
person.dog.age=15

2、@Value獲取值和@ConfigurationProperties獲取值比較

對于yml或者properties配置文件屯援，這兩個注解都可以獲取到配置文件的值猛们，但是它們有以下的區(qū)別：

如果我們只是在某個業(yè)務(wù)邏輯中需要獲取一下配置文件的某個值時念脯，我們使用@Value比較方便狞洋；如果我們專門編寫了一個JavaBean來和配置文件進(jìn)行映射，我們就直接使用@ConfigurationProperties绿店。

3吉懊、數(shù)據(jù)校驗(yàn)

在類上標(biāo)注@Validated注解，并在你需要校驗(yàn)的字段標(biāo)注上對應(yīng)的注解即可假勿，假設(shè)我們在lastName字段要使用@Eamil校驗(yàn)借嗽，則代碼如下：

@Component
@ConfigurationProperties(prefix = "person")
@Validated
public class Person {
    @Email
    private String lastName;
    private Integer age;
    private Boolean boss;
    private Date birth;
    private Map<String,Object> map;
    private List<Object> list;
    private Dog dog;
}

4、使用@PropertySource加載指定的配置文件

@PropertySource這個注解可以加載指定的配置文件转培。
我們定義一個局部的配置文件恶导，文件的位置位于類路徑下，如圖所示：

@PropertySource(value = {"classpath:person.properties"})
@Component
@ConfigurationProperties(prefix = "person")
@Validated
public class Person {

    private String lastName;
    private Integer age;
    private Boolean boss;
    private Date birth;

    private Map<String,Object> map;
    private List<Object> list;
    private Dog dog;
}

5浸须、使用@ImportResource導(dǎo)入Spring的配置文件

@ImportResource的作用是導(dǎo)入Spring的配置文件惨寿，讓配置文件里面的內(nèi)容生效。

我們編寫了一個spring的配置文件删窒，位于類路徑下：

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">

    <bean class="com.cerr.springboot.service.HelloService" id="helloService"></bean>
</beans>

然后我們在Spring的單元測試中測試ioc容器中是否有helloService這個bean：

@SpringBootTest
class Springboot01DemoApplicationTests {
    @Autowired
    ApplicationContext ioc;
    @Test
    public void testHelloService(){
        boolean b = ioc.containsBean("helloService");
        System.out.println(b);
    }
}

結(jié)果卻是沒有這個bean裂垦，因?yàn)榇藭r這個配置文件并沒有被加載，因此我們需要使用@ImportResource注解讓該文件加載進(jìn)來肌索，在主配置類中我們使用該注解：

//導(dǎo)入Spring的配置文件并讓其生效
@ImportResource(locations = {"classpath:bean.xml"})
@SpringBootApplication
public class Springboot01DemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(Springboot01DemoApplication.class, args);
    }
}

然后我們再一次在Spring的單元測試中測試蕉拢，現(xiàn)在結(jié)果是有包含這個bean。

但是我們不推薦這種形式來給容器添加組件，Spring比較推薦使用以下這種方式：

6晕换、使用配置類及@Bean注解來給容器添加組件

Spring比較推薦使用配置類來給容器添加組件午乓，首先我們先定義一個配置類：

package com.cerr.springboot.config;
import com.cerr.springboot.service.HelloService;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
/**
 * 指明當(dāng)前類是一個配置類，用來替代之前的Spring配置文件
 */
@Configuration
public class AppConfig {
    //將方法的返回值添加到容器中闸准，容器中這個組件默認(rèn)的id就是方法名
    @Bean
    public HelloService helloService(){
        System.out.println("給容器中添加組件了");
        return new HelloService();
    }
}

該配置類使用了@Configuration注解硅瞧，表示其是一個配置類，然后在方法中使用了@Bean注解恕汇，該注解的作用是將方法的返回值添加到ioc容器中腕唧，并且這個組件的id就是方法名。
我們還是使用剛剛的那個測試類來測試ioc容器中是否包含了這個bean：

四瘾英、配置文件占位符

1枣接、隨機(jī)數(shù)

例如在配置文件中給lastName和age字段加上隨機(jī)數(shù)：

person.last-name=張三${random.uuid}
person.age=${random.int}

2、占位符獲取之前配置的值

person.last-name=張三${random.uuid}
person.dog.name=${person.last-name:hello}_dog

person.dog.name的值就是person.last-name的值拼上_dog缺谴，然后后面的:hello的意思是但惶，如果我們沒有在配置文件中指定person.last-name的值，那么那個占位符的默認(rèn)值就是hello湿蛔。

五膀曾、Profile

1、多Profile文件

我們在編寫主配置文件的時候阳啥，文件名可以是application-{profile}.properties/yml添谊，默認(rèn)使用application.properties文件的配置搬泥。

我們新建了application-dev.properties,application-prod.properties文件吸奴，分別指定其port為8083和80，然后在application.properties文件中：

server.port=8080
spring.profiles.active=dev

第一句表示默認(rèn)的環(huán)境配置（沒指定是哪種環(huán)境時）為端口號是8080初茶，第二句表示指定dev環(huán)境扎瓶，即使用我們配置的application-dev.properties文件所踊。

2、yml支持多文檔塊形式

yml中使用---可以將文件分為多文檔概荷，在不同的文檔中定義即可：

server:
  port: 8081
  path: /hello
spring:
  profiles:
    active: dev
---
server:
  port: 8083
spring:
  profiles: dev

---
server:
  port: 80
spring:
  profiles: prod

上述代碼中秕岛，在文檔2中我們定義了dev環(huán)境下的配置，文檔3中定義了prod環(huán)境下的配置误证，然后在文檔1中我們先定義了默認(rèn)的配置继薛，并且使用了如下格式來配置環(huán)境：

spring:
  profiles:
    active: dev

因此當(dāng)前使用的環(huán)境是dev環(huán)境，所以此時的端口號應(yīng)該是8083雷厂，我們啟動主啟動類：

3惋增、激活指定Profile

(1)、在配置文件中指定spring.profiles.active屬性來激活

• 對于properties文件改鲫，我們可以這樣激活：

spring.profiles.active=dev

(2)诈皿、使用命令行來激活

在終端中使用--spring.profiles.active=xxx來激活林束，比如我們在配置yml配置文件中指定激活dev環(huán)境：

server:
  port: 8081
  path: /hello
spring:
  profiles:
    active: dev

但是我們在idea中加上命令行參數(shù)--spring.profiles.active=prod表示我們想激活prod環(huán)境：

或者是將項(xiàng)目打包為jar包后，在終端中運(yùn)行該jar包且指定命令行參數(shù)也行：

命令行輸入：
java -jar springboot-01-demo-0.0.1-SNAPSHOT.jar --spring.profiles.active=prod

3稽亏、虛擬機(jī)參數(shù)

在IDEA中設(shè)置虛擬機(jī)參數(shù)：-Dspring.profiles.active=prod

六壶冒、配置文件的加載位置

Springboot啟動會掃描以下位置的application.properties或者application.yml文件作為Springboot的默認(rèn)配置文件：

• file:../config/：根目錄下的config文件夾下
• file:../：根目錄下
• classpath:/config/：類路徑下的config文件夾下
• classpath:/：類路徑下

以上是按照優(yōu)先級從高到低的順序，所有位置的文件都會被加載截歉，高優(yōu)先級配置內(nèi)容會覆蓋低優(yōu)先級配置內(nèi)容胖腾，稱為互補(bǔ)配置。

例如我們在根目錄下新建一個config文件夾瘪松，并且新建一個application.properties文件咸作，配置port為8082：

server.port=8082

在類路徑下的application.properties文件中配置如下：

server.port=8081

#配置項(xiàng)目的訪問路徑
server.servlet.context-path=/boot1

因?yàn)榕渲梦募裱?strong>高優(yōu)先級配置內(nèi)容覆蓋低優(yōu)先級配置內(nèi)容，所以這類路徑下文件的port配置會被第一個文件覆蓋宵睦，而第一個文件都沒配置server.servlet.context-path记罚，所以這個屬性的值還是第二個配置文件的值，我們訪問后：

我們可以通過配置spring.config.location來改變默認(rèn)配置
在項(xiàng)目打包好后壳嚎，我們可以使用命令行參數(shù)的形式桐智，啟動項(xiàng)目的時候來指定配置文件得新位置。

我們在E盤中新建一個application.properties文件烟馅，然后設(shè)置port為80：

server.port=80

我們將項(xiàng)目打包后说庭，在IDEA的控制臺中運(yùn)行該jar包：

默認(rèn)端口為80，因此localhost會省略80：

七郑趁、外部配置加載順序

Springboot可以從以下位置加載配置刊驴，優(yōu)先級從高到低，高優(yōu)先級的配置覆蓋低優(yōu)先級的配置：

(1)穿撮、命令行參數(shù)

語法：--配置項(xiàng)=值缺脉，多個參數(shù)使用空格分隔

打包后并在命令行輸入：
java -jar springboot-01-demo-0.0.1-SNAPSHOT.jar --server.port=8087
運(yùn)行jar包并且修改server.port=8087

啟動后訪問8087端口能正常運(yùn)行，訪問原來的8082端口不能用：

(2)悦穿、關(guān)于jar包外、jar包內(nèi)的配置文件以及帶不帶profiles的順序區(qū)別

由jar包外向jar包內(nèi)進(jìn)行尋找业踢，優(yōu)先加載帶profiles栗柒，再來加載不帶profiles

此時我們項(xiàng)目內(nèi)配置文件最高優(yōu)先級的應(yīng)該是端口為8082，我們將項(xiàng)目打包知举，然后新建一個boot文件夾瞬沦，將打包好的jar包放入文件夾中：

server.port=8089

在命令行中輸入：
java -jar springboot-01-demo-0.0.1-SNAPSHOT.jar

(3)芳悲、@Configuration注解類上的@PropertySource

八、SpringBoot配置的原理

1边坤、Springboot啟動的時候加載主配置類時開啟自動配置功能

主配置類中有@EnableAutoConfiguration注解名扛，我們下面來研究其作用：

2、@EnableAutoConfiguration作用

利用AutoConfigurationImportSelector給容器中導(dǎo)入一些組件茧痒“谷停可以查看selectImports()的內(nèi)容：

    public String[] selectImports(AnnotationMetadata annotationMetadata) {
        if (!this.isEnabled(annotationMetadata)) {
            return NO_IMPORTS;
        } else {
            AutoConfigurationMetadata autoConfigurationMetadata = AutoConfigurationMetadataLoader.loadMetadata(this.beanClassLoader);
            AutoConfigurationImportSelector.AutoConfigurationEntry autoConfigurationEntry = this.getAutoConfigurationEntry(autoConfigurationMetadata, annotationMetadata);
            return StringUtils.toStringArray(autoConfigurationEntry.getConfigurations());
        }
    }

    protected AutoConfigurationImportSelector.AutoConfigurationEntry getAutoConfigurationEntry(AutoConfigurationMetadata autoConfigurationMetadata, AnnotationMetadata annotationMetadata) {
        if (!this.isEnabled(annotationMetadata)) {
            return EMPTY_ENTRY;
        } else {
            AnnotationAttributes attributes = this.getAttributes(annotationMetadata);
            List<String> configurations = this.getCandidateConfigurations(annotationMetadata, attributes);
            configurations = this.removeDuplicates(configurations);
            Set<String> exclusions = this.getExclusions(annotationMetadata, attributes);
            this.checkExcludedClasses(configurations, exclusions);
            configurations.removeAll(exclusions);
            configurations = this.filter(configurations, autoConfigurationMetadata);
            this.fireAutoConfigurationImportEvents(configurations, exclusions);
            return new AutoConfigurationImportSelector.AutoConfigurationEntry(configurations, exclusions);
        }
    }

在selectImports方法中調(diào)用了getAutoConfigurationEntry()，其方法中的一句代碼List<String> configurations = this.getCandidateConfigurations(annotationMetadata, attributes);是獲取候選的配置旺订，我們進(jìn)入該方法：

    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;
    }

該方法掃描所有jar包類路徑下META-INF/spring.factories文件弄企，并把掃描到的這些文件的內(nèi)容包裝成properties對象。從properties中獲取到EnableAutoConfiguration.class類名對應(yīng)的值区拳，然后把他們添加到容器中桩蓉。

總結(jié)來說其作用就是將類路徑下META-INF/spring.factories里面配置的所有EnableAutoConfiguration的值加入到容器中
每一個xxxAutoConfiguration類都是容器中的一個組件，都加入到容器中劳闹，用他們來做自動配置院究。

3、每一個自動配置類進(jìn)行自動配置

4本涕、我們以HttpEncodingAutoConfiguration為例來解釋自動配置原理：

首先這個類上有如下的注解：

@Configuration(
    proxyBeanMethods = false
)
@EnableConfigurationProperties({HttpProperties.class})
@ConditionalOnWebApplication(
    type = Type.SERVLET
)
@ConditionalOnClass({CharacterEncodingFilter.class})
@ConditionalOnProperty(
    prefix = "spring.http.encoding",
    value = {"enabled"},
    matchIfMissing = true
)

我們來逐一分析這些注解：

(1)业汰、@Configuration

表示這是一個配置類。和以前編寫的配置文件一樣菩颖，也可以給容器添加組件

(2)样漆、@EnableConfigurationProperties

這個注解表示啟動指定類的ConfigurationProperties功能，我們點(diǎn)進(jìn)去HttpProperties類晦闰，有如下注解：

@ConfigurationProperties(
    prefix = "spring.http"
)
public class HttpProperties{
}

@ConfigurationProperties注解的作用是從配置文件中獲取指定的值和bean的屬性來進(jìn)行綁定放祟。

因此所有在配置文件中能配置的屬性都是在xxxProperties類中封裝著，如果我們想要知道該配置文件能夠配置什么功能呻右，我們就可以參考某個功能對應(yīng)的Properties類

對于這個例子跪妥，我們這個注解最后就是讓配置文件中對應(yīng)的值和HttpProperties綁定起來了，并加入到ioc容器中声滥，為后面我們要向容器中添加組件服務(wù)眉撵。

(3)、@ConditionalOnWebApplication

在Spring底層中有一個@Conditional注解落塑，判斷如果滿足指定的條件纽疟，整個配置類里面的配置會生效。
因此這個@ConditionalOnWebApplication就是判斷當(dāng)前應(yīng)用是否是web應(yīng)用憾赁，如果是污朽，則當(dāng)前配置類生效。

(4)龙考、@ConditionalOnClass

判斷當(dāng)前項(xiàng)目有沒有這個類蟆肆。
@ConditionalOnClass({CharacterEncodingFilter.class})表示判斷當(dāng)前項(xiàng)目中有沒有CharacterEncodingFilter這個類矾睦，這個類是SpringMVC中進(jìn)行亂碼解決的過濾器。

(5)颓芭、@ConditionalOnProperty

判斷配置文件中是否存在某個配置顷锰，在這個例子中：

@ConditionalOnProperty(
    prefix = "spring.http.encoding",
    value = {"enabled"},
    matchIfMissing = true
)

表示判斷配置文件夾是否有spring.http.encoding.enabled這個配置，而matchIfMissing = true表示如果不存在這個配置亡问，這個配置也是默認(rèn)生效的官紫。

(6)、總結(jié)

因此AutoConfiguration配置類的作用就是不斷的判斷州藕，最終決定這個配置類是否生效束世，如果生效的話，則給容器添加各種組件床玻，這些組件的屬性是從對應(yīng)的properties類中獲取的毁涉，這些類里面的每一個屬性又是和配置文件綁定的

HttpEncodingAutoConfiguration類中的一部分源碼如下：

public class HttpEncodingAutoConfiguration {
    //通過@EnableConfigurationProperties注解，和SpringBoot的配置文件進(jìn)行了映射
    private final Encoding properties;
    //只有一個有參構(gòu)造器的情況下锈死，參數(shù)的值就會從容器中拿
    public HttpEncodingAutoConfiguration(HttpProperties properties) {
        this.properties = properties.getEncoding();
    }
    
    @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;
    }
}

5贫堰、結(jié)論

• SpringBoot啟動會加載大量的自動配置類。
• 我們看我們需要的功能有沒有SpringBoot默認(rèn)寫好的自動配置類
• 我們再來看這個自動配置類中配置了哪些組件（如果我們要用的組件有待牵，那我們就不需要再來配置）
• 給容器中自動配置類添加屬性的時候其屏，會從properties類中獲取某些屬性，我們就可以在配置文件中指定這些屬性的值
• 本質(zhì)上SpringBoot的各種Properties類就封裝了配置文件中的相關(guān)屬性缨该，然后各種AutoConfiguration自動配置類就會給容器添加各種組件偎行。

九、@Conditional及其自動配置報(bào)告

@Conditional作用：必須是@Conditional指定的條件成立贰拿，才給容器中添加組件蛤袒，配置配里面的所有內(nèi)容才生效；

自動配置類必須在一定的條件下才能生效询一；
我們可以通過設(shè)置debug=true屬性隐孽，來讓控制臺打印自動配置報(bào)告，我們通過配置報(bào)告就知道哪些自動配置生效健蕊。