SpringBoot配置文件

主要包括YAML語法；文件值注入；佔位符；profile；加載位置；加載順序；自動配置原理

1、配置文件

Spring Boot使用一個全局的配置文件，其配置文件名是固定的
- application.properties
- application.yml
配置文件的作用：修改Spring Boot自動配置的默認值；SpringBoot在底層都給我們自動關機配置好了。
比如修改tomcat的默認端口號
```
server.port=8081 //改爲需要的端口號
```
YWAML標記語言：其以數據爲中心，比json，xml更適合做配置文件。
同樣的修改端口號：
```
server:
	port:8081
```
相比xml：
```
<server>
 <port>8081</port>
</server>
```
實際效果圖

[外鏈圖片轉存失敗(img-ipyYd6mn-1568107597783)(https://i.loli.net/2019/07/24/5d3832f2095d781475.png)]
一般來說.properties文件的優先級要比.yml要高。但是yml文件有着一些優勢，天然的樹狀結構，官方很多demo也是yml文件配置的。

2、YAML語法

1、基本語法

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

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

server:
    port: 8081
    path: /hello

屬性和值也是大小寫敏感；

2、值的寫法

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

k: v：字面直接來寫；

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

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

name: “sunmz \n lisi”：輸出；sunmz 換行 lisi

‘’：單引號；會轉義特殊字符，特殊字符最終只是一個普通的字符串數據

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

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

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

對象還是k: v的方式

friends:
		lastName: sunmz
		age: 22

行內寫法：

friends: {lastName: mzsun,age: 22}

數組（List、Set）：

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

pets:
 - cat
 - dog
 - pig

行內寫法

pets: [cat,dog,pig]

3、配置文件值注入

javaBean：

/**
 *將配置文件中配置的每一個屬性的值，映射到這個組件中
 *@ConfigurationProperties:告訴SpringBoot將本類中的所有屬性和配置文件中相關的配置進行綁定
 *prefix = "person":配置文件中那個下面的所有屬性進行一一映射
 *
 * 只有這個組件是容器中的組件，才能使用容器提供的@ConfigurationProperties功能
 *其默認從全局配置文件中獲取值（容易造成冗雜無序）與之區別的就是@PropertySource加載指定的配置文件
 */
@Component
@ConfigurationProperties(prefix = "person")


public class Person {
    private String lastName;
    private Integer age;
    private Boolean boss;
    private Date birth;

    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;

配置文件

person:
    lastName: sunmz
    age: 22
    boss: false
    birth: 1997/03/17
    maps: {k1: v1,k2: v2,k3: v3}
    lists:
      - lisi
      - zhaoliu
    dog:
      name: 小狗
      age: 2

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

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

然後我們對其進行單元測試

/**
 * SpringBoot單元測試
 * 可以在測試期間很方便的類似編碼一起進行自動注入等容器的功能
 */
@RunWith(SpringRunner.class)
@SpringBootTest
public class SpringBoot002ConfigApplicationTests {
    @Autowired
    Person person;
    @Test
    public void contextLoads() {
        System.out.println(person);
    }
}

可以看到單元測試的結果 [外鏈圖片轉存失敗(img-e1TS35YU-1568107597785)(https://i.loli.net/2019/07/24/5d3832b14acb451806.png)]

以上的.yml中配置的在.properties中也是一樣的，但是需要注意的是idea使用的是utf-8編碼的。而在.properties用的是ASCII所以要進行設置。

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

	@ConfigurationProperties	@Value
功能	批量注入配置文件中的屬性	一個個指定
鬆散綁定（鬆散語法）	支持	不支持
SpEL	不支持	支持
JSR303數據校驗	支持	不支持
複雜類型封裝	支持	不支持

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

如果說，我們只是在某個業務邏輯中需要獲取一下配置文件中的某項值，使用@Value；

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

2、配置文件注入值數據校驗

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

    private Date birth;
    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;

3、@PropertySource&@ImportResource&@Bean

@PropertySource：加載指定的配置文件；

/**
 * 將配置文件中配置的每一個屬性的值，映射到這個組件中
 * @ConfigurationProperties：告訴SpringBoot將本類中的所有屬性和配置文件中相關的配置進行綁定；
 *      prefix = "person"：配置文件中哪個下面的所有屬性進行一一映射
 *
 * 只有這個組件是容器中的組件，才能容器提供的@ConfigurationProperties功能；
 *  @ConfigurationProperties(prefix = "person")默認從全局配置文件中獲取值；
 *
 */
@PropertySource(value = {"classpath:person.properties"})
@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;

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

Spring Boot裏面沒有Spring的配置文件，我們自己編寫的配置文件，也不能自動識別；

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

@ImportResource(locations = {"classpath:beans.xml"})
導入Spring的配置文件讓其生效

不來編寫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 id="helloService" class="com.atguigu.springboot.service.HelloService"></bean>
</beans>

SpringBoot推薦給容器中添加組件的方式；推薦使用全註解的方式

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

2、使用**@Bean**給容器中添加組件

/**
 * @Configuration：指明當前類是一個配置類；就是來替代之前的Spring配置文件
 *
 * 在配置文件中用<bean><bean/>標籤添加組件
 *
 */
@Configuration
public class MyAppConfig {

    //將方法的返回值添加到容器中；容器中這個組件默認的id就是方法名
    @Bean
    public HelloService helloService02(){
        System.out.println("配置類@Bean給容器中添加組件了...");
        return new HelloService();
    }
}

4、配置文件佔位符

1、隨機數

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

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

person.last-name=張三${random.uuid}
person.age=${random.int}
person.birth=2017/12/15
person.boss=false
person.maps.k1=v1
person.maps.k2=14
person.lists=a,b,c
person.dog.name=${person.hello:hello}_dog
person.dog.age=15

5、Profile

Profile是Spring對不同環境提供不同配置功能的支持，可以通過激活、指定參數等方式快速切換環境

1、多Profile文件

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

默認使用application.properties的配置；

2、yml支持多文檔塊方式

server:
  port: 8081
spring:
  profiles:
    active: prod  #激活那個環境

---
server:
  port: 8083
spring:
  profiles: dev


---
 
server:
  port: 8084
spring:
  profiles: prod  #指定屬於哪個環境

3、激活指定profile

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

2、命令行：

java -jar spring-boot-02-config-0.0.1-SNAPSHOT.jar --spring.profiles.active=dev；

可以直接在測試的時候，配置傳入命令行參數在Program arguments裏面-- spring.profiles.active=dev

3、虛擬機參數；在VM options中

-Dspring.profiles.active=dev

6、配置文件加載位置

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

–file:./config/

–file:./

–classpath:/config/

–classpath:/

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

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

所以我們就可以在低優先級裏面配置所有的信息，然後在高優先級裏面進行相應的更改

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

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

java -jar spring-boot-02-config-02-0.0.1-SNAPSHOT.jar --spring.config.location=G:/application.properties

7、外部配置加載順序

SpringBoot也可以從以下位置加載配置；優先級從高到低；高優先級的配置覆蓋低優先級的配置，所有的配置會形成互補配置

1.命令行參數

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

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

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

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

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

4.操作系統環境變量

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

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

優先加載帶profile

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

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

再來加載不帶profile

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

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

10.@Configuration註解類上的@PropertySource

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

所有支持的配置加載來源；

參考官方文檔

8、自動配置原理

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

配置文件能配置的屬性參照

1、自動配置原理：

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

2）、@EnableAutoConfiguration 作用：

利用EnableAutoConfigurationImportSelector給容器中導入一些組件？
可以查看selectImports()方法的內容；

List configurations = getCandidateConfigurations(annotationMetadata, attributes);獲取候選的配置

SpringFactoriesLoader.loadFactoryNames()
掃描所有jar包類路徑下  META-INF/spring.factories
把掃描到的這些文件的內容包裝成properties對象
從properties中獲取到EnableAutoConfiguration.class類（類名）對應的值，然後把他們添加在容器中

將類路徑下 META-INF/spring.factories 裏面配置的所有EnableAutoConfiguration的值加入到了容器中；

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

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

4）、**HttpEncodingAutoConfiguration（Http編碼自動配置）**自動配置原理；

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

@ConditionalOnWebApplication //Spring底層@Conditional註解，根據不同的條件，如果滿足指定的條件，整個配置類裏面的配置就會生效；    判斷當前應用是否是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類中獲取的，這些類裏面的每一個屬性又是和配置文件綁定的；

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

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

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

精髓：

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

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

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

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

xxxxAutoConfigurartion：自動配置類；

給容器中添加組件

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

2、細節

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

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

@Conditional擴展註解	作用（判斷是否滿足當前指定條件）
@ConditionalOnJava	系統的java版本是否符合要求
@ConditionalOnBean	容器中存在指定Bean；
@ConditionalOnMissingBean	容器中不存在指定Bean；
@ConditionalOnExpression	滿足SpEL表達式指定
@ConditionalOnClass	系統中有指定的類
@ConditionalOnMissingClass	系統中沒有指定的類
@ConditionalOnSingleCandidate	容器中只有一個指定的Bean，或者這個Bean是首選Bean
@ConditionalOnProperty	系統中指定的屬性是否有指定的值
@ConditionalOnResource	類路徑下是否存在指定資源文件
@ConditionalOnWebApplication	當前是web環境
@ConditionalOnNotWebApplication	當前不是web環境
@ConditionalOnJndi	JNDI存在指定項

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

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

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

SpringBoot配置文件

1、配置文件

2、YAML語法

1、基本語法

2、值的寫法

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

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

數組（List、Set）：

3、配置文件值注入

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

2、配置文件注入值數據校驗

3、@PropertySource&@ImportResource&@Bean

4、配置文件佔位符

1、隨機數

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

5、Profile

1、多Profile文件

2、yml支持多文檔塊方式

3、激活指定profile

6、配置文件加載位置

7、外部配置加載順序

8、自動配置原理

1、自動配置原理：

2、細節

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

開源高性能結構化日誌模塊NanoLog

【簡寫Mybatis-02】註冊機的實現以及SqlSession處理

手繪二維碼

.NET藉助虛擬網卡實現一個簡單異地組網工具

Servlet入門到入土——生命週期

spring boot入門到入土——錯誤處理機制

Java8 中的Stream API詳解

Spring Boot從入門到入土——快速開始

LeetCode146.LRU緩存機制

Mac下配置sublime實現LaTeX

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結