SpringBoot配置文件詳解

1、配置文件

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

•application.properties

•application.yml

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

YAML（YAML Ain't Markup Language）

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

​ YAML isn't Markup Language：不是一個標記語言；

標記語言：

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

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

​ YAML：配置例子

server:
  port: 8081

​ XML：

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

2、YAML語法：

1、基本語法

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

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

server:
    port: 8081
    path: /hello

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

2、值的寫法

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

​ k: v：字面直接來寫；

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

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

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

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

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

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

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

​ 對象還是k: v的方式

friends:
		lastName: zhangsan
		age: 20

行內寫法：

friends: {lastName: zhangsan,age: 18}

數組（List、Set）：

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

pets:
 - cat
 - dog
 - pig

行內寫法

pets: [cat,dog,pig]

3、配置文件值注入

配置文件

person:
    lastName: hello
    age: 18
    boss: false
    birth: 2017/12/12
    maps: {k1: v1,k2: 12}
    lists:
      - lisi
      - zhaoliu
    dog:
      name: 小狗
      age: 12

javaBean：

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

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

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

1、properties配置文件在idea中默認utf-8可能會亂碼

調整

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

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

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

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

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

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

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

4、@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

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；

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

​ 3、虛擬機參數；

​ -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指定的默認屬性

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

參考官方文檔