Table of Contents

二：配置文件

1：application配置文件

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

•application.properties

•application.yml

1.2：配置文件的作用：修改SpringBoot自動配置的默認值(SpringBoot在底層都給我們自動配置好的默認值)；

YAML（YAML Ain't Markup Language） yaml是一個標記語言

1.3：標記語言比較 YMAL和XML：

以前的配置文件；大多都使用的是 xxxx.xml文件；

YAML：以數據爲中心，比json、xml等更適合做配置文件

yml配置例子：

server:
  port: 8091

properties配置例子：

server.port=8090

xml配置例子：

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

1.4：同級別配置項，properties配置級別高

2：YMAL語法

2.1：基本語法：

k:(空格)v ---- 表示一對鍵值對（空格必須有）；

以空格的縮進來控制層級關係；只要是左對齊的一列數據，都是同一個層級的

server:
    port: 8081
    path: /hello

屬性和值的大小寫都很敏感；

2.2：字面量：普通的值（數字，字符串，布爾）

k: v ----字面直接來寫；

注：冒號後有空格

字符串默認不用加上單引號或者雙引號；

""：雙引號；不會轉義（改變）字符串裏面的特殊字符含義；特殊字符會作爲本身想表示的意思

name: "zhangsan \n lisi"：輸出；zhangsan 換行 lisi

''：單引號；會轉義（改變）特殊字符含義，特殊字符最終只是一個普通的字符串數據

name: ‘zhangsan \n lisi’：輸出；zhangsan \n lisi

2.3：對象、Map（屬性和值）（鍵值對）：

k: v：在下一行來寫對象的屬性和值的關係；注意縮進

對象還是k: v的方式

friends:
	lastName: zhangsan
	age: 20

行內寫法：

friends: {lastName: zhangsan,age: 18}

2.4：數組（List、Set）：

用- 值表示數組中的一個元素

pets:
 - cat
 - dog
 - pig

行內寫法：

pets: [cat,dog,pig]

3：配置文件注入程序內；程序使用配置文件內容

3.1:YMAL配置文件：

person:
  lastName: zhansan
  age: 22
  map: {k1: v1,k2: v2}
  list:
    - wangwu
    - zhaoliu

  dog:
    name: 饅頭
    age: 2

javaBean：

/**
 * 將配置文件中的值映射到這個組件上
 * @ConfigurationProperties：告訴SpringBoot將本類中的所有屬性和配置文件中相關的配置進行綁定；
 * prefix = "person"：配置文件中哪個下面的所有屬性進行一一映射
 *
 * 只有這個組件是容器中的組件，才能容器提供的@ConfigurationProperties功能；
 *
 */
@Component
@ConfigurationProperties(prefix = "person")
public class Person {
    private String lastName;
    private Integer age;
    private Map<String,Object> map;
    private List<String> list;

    private Dog dog;

我們可以導入配置文件處理器，以後編寫配置就有提示了

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

3.2：properties配置文件；

#perperties配置person
person.last-name=李四
person.age=33
person.map.k1=v2
person.map.k2=v1
person.list=1,2,3
person.dog.name=土豆
person.dog.age=3

如果出現亂碼就是idea默認*.properties的編碼格式爲gbk，在設置中改成utf-8即可

3.3：@Value獲取值和@ConfigurationProperties獲取值比較

@value（）

區別：

	@ConfigurationProperties	@Value
功能	批量注入配置文件中的屬性	一個個指定屬性
鬆散綁定	支持	不支持
SPEL(計算式)	不支持	支持
JSR303數據校驗	支持	不支持
複雜類型	支持	不支持

配置文件yml還是properties他們都能獲取到值；

如果說，我們只是在某個業務邏輯中需要獲取一下配置文件中的某項值，使用@Value；可以在任何類變量上取到；

如果說，我們專門編寫了一個javaBean來和配置文件進行映射，我們就直接使用@ConfigurationProperties；

注：

1：鬆散綁定

2：SPEL(計算式)

可以支持這樣的：@Value("#{2*11}")

3：JSR303校驗：

@Component
@ConfigurationProperties(prefix = "person")
@Validated
public class Person {

    /**
     * <bean class="Person">
     *      <property name="lastName" value="字面量/${key}從環境變量、配置文件中獲取值/#{SpEL}"></property>
     * <bean/>
     */

   //lastName必須是郵箱格式
    @Email
    //@Value("${person.last-name}")
    private String lastName;
    //@Value("#{11*2}")
    private Integer age;
    //@Value("true")
    private Boolean boss;

4：複雜類型：

@value不支持map，對象等複雜類型；

3.4：@PropertySource&@ImportResource&@Bean

1：@PropertySource：加載指定的配置文件---分離properties；使默認的properties不再臃腫；

注：該方法只能用於properties配置文件，@Value和@ConfigurationProperties都適用；

2：@ImportResource：導入Spring的配置文件，讓配置文件裏面的內容生效；

以前我們想註冊一個service配置文件；

然後檢測容器中是否有改service

想讓Spring的配置文件生效，加載進來；@ImportResource標註在一個配置類上

這樣就注入了組件；

但是spring不推薦這樣配置組件；SpringBoot推薦給容器中添加組件的方式；推薦使用全註解的方式

1、配置類@Configuration------>Spring配置文件

2、使用@Bean給容器中添加組件，//將方法的返回值添加到容器中；容器中這個組件默認的id就是方法名

例：

4：配置文件佔位符

4.1：隨機數

${random.value}、${random.int}、${random.long}
${random.int(10)}、${random.int[1024,65536]}

4.2：佔位符獲取之前配置的值，如果沒有可以是用:指定默認值

5：Profile：多環境支持

5.1：properties文件：

我們在主配置文件編寫的時候，文件名可以是 application-{profile}.properties/yml

默認使用的配置；

5.2：yml支持多文檔塊方式

注意：需要在任何一個properties文件下沒有相同內容情況下指定，否則properties的優先級比較高

5.3：激活指定profile

1、在配置文件中指定 spring.profiles.active=dev

2、命令行：

或者打包後啓動：java -jar spring-boot-02-config-0.0.1-SNAPSHOT.jar --spring.profiles.active=dev；

可以直接在測試的時候，配置傳入命令行參數

3、虛擬機參數；

-Dspring.profiles.active=dev

6：配置文件的加載順序

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

–file:./config/（根目錄下的config文件夾）

–file:./（根目錄下）

–classpath:/config/（resources/config）

–classpath:/（resources）

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

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

指定根目錄用：

server.servlet.context-path=/boot

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

項目打包好以後，我們可以使用命令行參數的形式，啓動項目的時候來指定配置文件的新位置；指定配置文件和默認加載的這些配置文件共同起作用形成互補配置；

注：--spring.config.location=xxx 在新版本中是替換的意思；

--spring.config.additional.location 是追加的意思

7：外部配置文件加載順序（方便運維管理）

7.1.命令行參數

所有的配置都可以在命令行上進行指定

java -jar spring-boot-02-config-02-0.0.1-SNAPSHOT.jar --server.port=8087 --server.context-path=/abc

多個配置用空格分開； --配置項=值

7.2.來自java:comp/env的JNDI屬性

7.3.Java系統屬性（System.getProperties()）

7.4.操作系統環境變量

7.5.RandomValuePropertySource配置的random.*屬性值

==由jar包外向jar包內進行尋找；==

==優先加載帶profile==

7.6.jar包外部的application-{profile}.properties或application.yml(帶spring.profile)配置文件

7.7.jar包內部的application-{profile}.properties或application.yml(帶spring.profile)配置文件

==再來加載不帶profile==

7.8.jar包外部的application.properties或application.yml(不帶spring.profile)配置文件

7.9.jar包內部的application.properties或application.yml(不帶spring.profile)配置文件

如：將打好的包的根目錄下放置配置文件這就是外部配置文件，優先加載

7.10.@Configuration註解類上的@PropertySource

7.11.通過SpringApplication.setDefaultProperties指定的默認屬性

官方文檔： (https://docs.spring.io/spring-boot/docs/1.5.9.RELEASE/reference/htmlsingle/#boot-features-external-config)

8：自動配置原理

配置文件能寫什麼？怎麼寫？自動配置原理；

官方文檔（https://docs.spring.io/spring-boot/docs/2.2.6.RELEASE/reference/htmlsingle/#common-application-properties）

8.1：自動配置原理；

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

2）、@EnableAutoConfiguration 作用：

利用AutoConfigurationImportSelector給容器中導入一些組件？
可以查看selectImports()方法的內容；它表明哪些自動配置類是要加入到容器中
繼續追蹤源碼，可以看到getAutoConfigurationEntry（..)這個方法，其中configurations存放在數據就是加入容器的自動配置類的完整包路徑
Spring Boot在啓動的時候從類路徑下的META-INF/spring.factories中獲取EnableAutoConfiguration指定的值，將這些值作爲自動配置類導入到容器中，自動配置類就生效，幫我們進行自動配置工作

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

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

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

//表示這是一個配置類，以前編寫的配置文件一樣，也可以給容器中添加組件
@Configuration(
    proxyBeanMethods = false
)
/**啓動指定類的ConfigurationProperties功能；將配置文件中對應的值和HttpEncodingProperties
綁定起來；並把HttpEncodingProperties加入到ioc容器中*/
@EnableConfigurationProperties({HttpProperties.class})
//Spring底層@Conditional註解（Spring註解版），根據不同的條件，如果滿足指定的條件，
//整個配置類裏面的配置就會生效；    判斷當前應用是否是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();
    }

    @Bean  //給容器中添加一個組件，這個組件的某些值需要從properties中獲取
    @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類中獲取的，這些類裏面的每一個屬性又是和配置文件綁定的；同時也是我們可以在配置文件中更改的；

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

總結：

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

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

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

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

xxxxAutoConfigurartion：自動配置類；

給容器中添加組件

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

8.3：細節

1：@Conditional派生註解（Spring註解版原生的@Conditional作用）

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

自動配置類必須在一定的條件下才能生效；

我們怎麼知道哪些自動配置類生效；

2：查看系統啓動的時候那些自動配置類生效；

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

未啓動，未自動配置的自動配置類；

SpringBoot零基礎詳解二：配置文件application及自動配置原理