配置文件

SpringBoot使用一個全局的配置文件 ， 配置文件名稱是固定的
application.properties
語法結(jié)構(gòu) ：key=value
application.yml
語法結(jié)構(gòu) ：key：空格 value

配置文件的作用 ：修改SpringBoot自動配置的默認值，因為SpringBoot在底層都給我們自動配置好了；
比如我們可以在配置文件中修改Tomcat 默認啟動的端口號！測試一下！

server.port=8081

yml

YAML是 "YAML Ain't a Markup Language" （YAML不是一種標記語言）的遞歸縮寫。在開發(fā)的這種語言時，YAML 的意思其實是："Yet Another Markup Language"（仍是一種標記語言）
這種語言以數(shù)據(jù)作為中心，而不是以標記語言為重點！

以前的配置文件，大多數(shù)都是使用xml來配置；比如一個簡單的端口配置，我們來對比下yaml和xml
傳統(tǒng)xml配置：

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

yaml配置：

server：
  prot: 8080

Yaml語法基礎

說明：語法要求嚴格！

• 空格不能省略
• 以縮進來控制層級關(guān)系，只要是左邊對齊的一列數(shù)據(jù)都是同一個層級的。
• 屬性和值的大小寫都是十分敏感的。
  字面量：普通的值 [ 數(shù)字，布爾值，字符串 ]
  字面量直接寫在后面就可以 ， 字符串默認不用加上雙引號或者單引號;

k: v

注意：
“ ” 雙引號，不會轉(zhuǎn)義字符串里面的特殊字符 ， 特殊字符會作為本身想表示的意思；
比如 ：name: "kuang \n shen" 輸出 ：kuang 換行 shen
'' 單引號，會轉(zhuǎn)義特殊字符 ， 特殊字符最終會變成和普通字符一樣輸出
比如 ：name: ‘kuang \n shen’ 輸出 ：kuang \n shen

對象、Map（鍵值對）

#對象、Map格式
student:
    name: zhangsan
    age: 3

行內(nèi)寫法

student: {name: zhangsan,age: 3}

數(shù)組（ List、set ）

student:
 - zhangsan
 - lisi
 - wangwu

行內(nèi)寫法

student: [zhangsan,lisi,wangwu]

給實體類注入值

yaml文件的一個強大的地方在于可以直接給實體類注入匹配值！

#yaml注入配置文件

1、在springboot項目中的resources目錄下新建一個文件 application.yml
2、編寫一個實體類 Dog；

@Component  //注冊bean到容器中
public class Dog {
    private String name;
    private Integer age;
    
    //有參無參構(gòu)造、get、set方法、toString()方法  
}

3、思考，我們原來是如何給bean注入屬性值的！@Value，給狗狗類測試一下：

@Component //注冊bean
public class Dog {
    @Value("阿黃")
    private String name;
    @Value("18")
    private Integer age;
}

4、在SpringBoot的測試類下注入狗狗輸出一下；

@SpringBootTest
class DemoApplicationTests {

    @Autowired //將狗狗自動注入進來
    Dog dog;

    @Test
    public void contextLoads() {
        System.out.println(dog); //打印看下狗狗對象
    }

}

結(jié)果成功輸出，@Value注入成功，這是我們原來的辦法對吧。

image

5、我們在編寫一個復雜一點的實體類：Person 類

@Component //注冊bean到容器中
public class Person {
    private String name;
    private Integer age;
    private Boolean happy;
    private Date birth;
    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;
    
    //有參無參構(gòu)造、get、set方法、toString()方法  
}

6、我們來使用yaml配置的方式進行注入，大家寫的時候注意區(qū)別和優(yōu)勢，我們編寫一個yaml配置！

person:
  name: qinjiang
  age: 3
  happy: false
  birth: 2000/01/01
  maps: {k1: v1,k2: v2}
  lists:
   - code
   - girl
   - music
  dog:
    name: 旺財
    age: 1

7、我們剛才已經(jīng)把person這個對象的所有值都寫好了，我們現(xiàn)在來注入到我們的類中！

/*
@ConfigurationProperties作用：
將配置文件中配置的每一個屬性的值，映射到這個組件中；
告訴SpringBoot將本類中的所有屬性和配置文件中相關(guān)的配置進行綁定
參數(shù) prefix = “person” : 將配置文件中的person下面的所有屬性一一對應
*/
@Component //注冊bean
@ConfigurationProperties(prefix = "person")
public class Person {
    private String name;
    private Integer age;
    private Boolean happy;
    private Date birth;
    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;
}

8、IDEA 提示，springboot配置注解處理器沒有找到，讓我們看文檔，我們可以查看文檔，找到一個依賴！

image.png

image.png

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

9、確認以上配置都OK之后，我們?nèi)y試類中測試一下：

@SpringBootTest
class DemoApplicationTests {

   @Autowired
   Person person; //將person自動注入進來

   @Test
   public void contextLoads() {
       System.out.println(person); //打印person信息
   }

}

結(jié)果：所有值全部注入成功

image.png

加載指定的配置文件

@PropertySource ：加載指定的配置文件；
@configurationProperties：默認從全局配置文件中獲取值；

1、我們?nèi)ピ趓esources目錄下新建一個person.properties文件

name=kuangshen

2、然后在我們的代碼中指定加載person.properties文件

@PropertySource(value = "classpath:person.properties")
@Component //注冊bean
public class Person {

    @Value("${name}")
    private String name;

    ......  
}

3、再次輸出測試一下：指定配置文件綁定成功！

image

配置文件占位符

配置文件還可以編寫占位符生成隨機數(shù)

person:
    name: qinjiang${random.uuid} # 隨機uuid
    age: ${random.int}  # 隨機int
    happy: false
    birth: 2000/01/01
    maps: {k1: v1,k2: v2}
    lists:
      - code
      - girl
      - music
    dog:
      name: ${person.hello:other}_旺財
      age: 1

回顧properties配置

我們上面采用的yaml方法都是最簡單的方式，開發(fā)中最常用的；也是springboot所推薦的！那我們來嘮嘮其他的實現(xiàn)方式，道理都是相同的；寫還是那樣寫；配置文件除了yml還有我們之前常用的properties ， 我們沒有講，我們來嘮嘮！

【注意】properties配置文件在寫中文的時候，會有亂碼 ， 我們需要去IDEA中設置編碼格式為UTF-8；
settings-->FileEncodings 中配置；

image.png

1、新建一個實體類User

@Component //注冊bean
public class User {
    private String name;
    private int age;
    private String sex;
}

2、編輯配置文件 user.properties

user1.name=kuangshen
user1.age=18
user1.sex=男

3、我們在User類上使用@Value來進行注入！

@Component //注冊bean
@PropertySource(value = "classpath:user.properties")
public class User {
    //直接使用@value
    @Value("${user.name}") //從配置文件中取值
    private String name;
    @Value("#{9*2}")  // #{SPEL} Spring表達式
    private int age;
    @Value("男")  // 字面量
    private String sex;
}

4、Springboot測試

@SpringBootTest
class DemoApplicationTests {

    @Autowired
    User user;

    @Test
    public void contextLoads() {
        System.out.println(user);
    }

}

結(jié)果正常輸出：

image

對比小結(jié)

@Value這個使用起來并不友好！我們需要為每個屬性單獨注解賦值，比較麻煩；我們來看個功能對比圖

image

1、@ConfigurationProperties只需要寫一次即可 ， @Value則需要每個字段都添加

2、松散綁定：這個什么意思呢? 比如我的yml中寫的last-name，這個和lastName是一樣的， - 后面跟著的字母默認是大寫的。這就是松散綁定。可以測試一下

3、JSR303數(shù)據(jù)校驗 ， 這個就是我們可以在字段是增加一層過濾器驗證 ， 可以保證數(shù)據(jù)的合法性

4、復雜類型封裝，yml中可以封裝對象 ， 使用value就不支持

結(jié)論：

配置yml和配置properties都可以獲取到值 ， 強烈推薦 yml；

如果我們在某個業(yè)務中，只需要獲取配置文件中的某個值，可以使用一下 @value；

如果說，我們專門編寫了一個JavaBean來和配置文件進行一一映射，就直接@configurationProperties，不要猶豫！