Spring Boot的配置（配置文件，加載順序，配置原理）之配置文件

配置文件

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

• application.properties
• application.yml

配置文件的作用：修改Spring Boot自動配置的默認值，即修改Spring Boot在底層都給我們配置好的值

YAML(YAML Ain't Markup Language)

標記語言：

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

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

​ YAML配置例子（冒號后面一定要加空格）

server:
  port: 8081

​ XML：配置例子

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

1.YAML的語法

1.基本語法

屬性與值的關系： k:(空格)v : 表示一對鍵值對（空格不能省略）；

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

server:
   port: 8081
   path: /hello

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

2.值的寫法

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

k: v 字面直接來寫；

​ 一般字符串不用加上單引號或者雙引號；

​ “雙引號”：會轉義字符串里面的特殊字符，特殊字符會作為本身想標識的意思

name: "zhangsan /n list"
輸出：zhangsan 換行 list

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

name: 'zhangsan /n list'
輸出：zhangsan /n list

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

​ k: v 在下一行來寫對象的屬性和值的關系；注意使用空格縮進

friends:
  lastName: zhangsan
  age: 20

​ 行內寫法：

friends: {lastName: zhangsan,age: 18}

數組（List、Set）：

用 -(空格)值 表示數組中的一個元素

pets:
 - cat
 - dog
 - pig

行內寫法

pets: {cat,dog,pig}

3.配置文件值注入

1.@ConfigurationProperties（默認從全局配置文件中取值）

配置文件

server:
  port: 8081

person:
  lastName: zhangsan
  age: 19
  boss: false
  birth: 2020/5/20
  maps: {k1: v1,k2: 12}
  lists:
    - lisi
    - zhaoliu
  dog:
    name: 旺財
    age: 2

javaBean

/**
 * 將配置文件中配置的每一個屬性的值，映射到這個組件中
 *  @ConfigurationProperties:告訴springBoot將本類中的所有屬性和配置文件相關的配置進行綁定；
 *          prefix = "person":配置文件中哪個下面的所有屬性進行一一映射
 *          只有這個組件是容器中的組件，才能使用容器提供的功能；
 **/
@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;

導入配置文件處理器，配置文件進行綁定就會有提示(配置中的提示滿足駝峰命名法的切換lastName=last-name)

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-configuration-processor</artifactId>
    <optional>true</optional>
</dependency>

2.@Value

 /**
     *  Spring底層的Value，之前是在Spring配置文件中
     *  <bean>
     *      <property name="lastName" value="字面量 / ${key}-從環境變量、配置文件中獲取值 / #{spel}"><property/>
     *  </bean>
     *  以前支持的，在@Value中都支持
     **/

    @Value("${person.last-name}")
    private String lastName;
    @Value("#{11*2}")
    private Integer age;
    @Value("true")
    private Boolean boss;

3.@Value獲取值和@ConfigurationProperties獲取值比較

	@ConfigutationProperties	@Value
批量注入	支持	不支持
松散綁定（松散語法：lastName=last_name=last-name）	支持	不支持
SpEL	不支持	支持
JSR303數據校驗	支持	不支持
復雜類型封裝（對象、map）	支持	不支持

配置文件無論是ymal還是properties他們都能獲取到值

總結：

如果說只是在某個業務邏輯（Controller、Service）中獲取一下配置文件中的某項值，使用@Value

如果說我們專門編寫了一個javabean來和配置文件進行映射，則使用@ConfigurationProperties

4.配置文件注入值數據校驗

@Component
@ConfigurationProperties(prefix = "person")
@Validated
public class Person {
    
    @Email
    private String lastName;

5.@PropertySource&ImportResource

• @PropertySource：加載指定的配置文件（如果全局配置文件中有符合的前綴屬性會先加載全局文件，就不會再去尋找PropertySource標注的文件）

@PropertySource("classpath:person.properties")
@Component
@ConfigurationProperties(prefix = "person")

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

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

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

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

• Spring Boot中推薦的添加組件的方式

  1.不編寫xml文件，使用全注解的方式（配置類==》配置文件）

  2.使用@Bean注解來給容器中添加組件

  /**
   * 指明當前類為配置類
   * 在配置文件中用bean來添加組件
   * 配置類中用@Bean
   **/
  @Configuration
  public class MyAppConfig {
  
      //將方法的返回值添加到容器中：容器中這個組件默認的id就是方法名
      @Bean
      public HelloService helloService(){
          System.out.println("@Bean給容器添加組建了");
          return new HelloService();
      }
  }
  

4.配置文件占位符

1.隨機數

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

2.占位符獲取之前配置的值，如果沒有可以使用： 指定默認值

可以在配置文件中引用前面配置過的屬性（優先級前面配置過的這里都能用），找不到屬性時使用${key: value}來指定默認值

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

5.Profile

1.多Profile文件

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

默認使用application.properties;

2.yml支持多文檔塊方式

三個 - 可以分出分檔塊

profiles: 指定屬於哪個環境（自定義）,active:激活哪個環境

server:
  port: 8081
spring:
  profiles:
    active: prod

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

3.激活指定profile

1.在默認全局配置文件中 spring.profiles.active=dev 激活

2.命令行的方式激活：

• cmd在jar包目錄下 ： java -jar xxx.jar --spring.profies.active=dev

• IDEA運行配置的program arguments(程序參數輸入)： --spring.profies.active=dev

• IDEA運行配置的VM options(虛擬機選項)：-Dspring.profiles.active=dev