1 - SpringBoot 的配置文件
1、兩種配置文件
# SpringBoot使用一個全局的配置文件 ， 配置文件名稱是固定的 # 第一種 application.properties # 語法結構 ：key=value # 第二種 application.yml # 語法結構 ：key：空格 value
2、配置文件的作用
配置文件的作用 ：修改SpringBoot自動配置的默認值，因為SpringBoot在底層都給我們自動配置好了；比如我們可以在配置文件中修改Tomcat 默認啟動的端口號！測試一下！
# 修改 application.properties 文件 server.port=8081 # 修改 application.yml 文件 server: port: 8081
2 - yaml 文件
1、yaml概述
YAML是 "YAML Ain't a Markup Language" （YAML不是一種標記語言）的遞歸縮寫。在開發的這種語言時，YAML 的意思其實是："Yet Another Markup Language"（仍是一種標記語言）
這種語言以數據作為中心，而不是以標記語言為重點！
2、yaml與xml的對比
以前的配置文件，大多數都是使用xml來配置；比如一個簡單的端口配置，我們來對比下yaml和xml
①傳統xml配置
<server> <port>8081<port> </server>
②yaml配置
server:
port: 8080
3、yaml 基礎語法
說明：語法要求嚴格！
1、空格不能省略
2、以縮進來控制層級關系，只要是左邊對齊的一列數據都是同一個層級的。
3、屬性和值的大小寫都是十分敏感的。
字面量：普通的值 [ 數字，布爾值，字符串 ]
字面量直接寫在后面就可以 ， 字符串默認不用加上雙引號或者單引號；
k: v
注意：
-
“ ” 雙引號，不會轉義字符串里面的特殊字符 ， 特殊字符會作為本身想表示的意思；
比如 ：name: "kuang \n shen" 輸出 ：kuang 換行 shen
-
'' 單引號，會轉義特殊字符 ， 特殊字符最終會變成和普通字符一樣輸出
比如 ：name: ‘kuang \n shen’ 輸出 ：kuang \n shen
對象、Map（鍵值對）
# 對象、Map格式 k: v1: v2:
在下一行來寫對象的屬性和值得關系，注意縮進；比如：
student:
name: alex
age: 3
行內寫法
user: {name: alex,age: 21}
數組（ List、set ）
用 - 值表示數組中的一個元素,比如：
pets: - cat - dog - pig
行內寫法
list: [1,2,3]
4、修改SpringBoot的默認端口號
配置文件中添加，端口號的參數，就可以切換端口；
server:
port: 8081
3 - 注入配置文件
yaml文件更強大的地方在於，他可以給我們的實體類直接注入匹配值！
1、yaml注入配置文件
1、在springboot項目中的resources目錄下新建一個文件 application.yml
2、編寫一個實體類 student；
package com.howie.springboot.pojo; @Component //注冊bean到容器中 public class Student { private String name; private Integer age; //有參無參構造、get、set方法、toString()方法 }
3、思考，我們原來是如何給bean注入屬性值的！@Value，給學生類測試一下：
@Component //注冊bean public class Student { @Value("alex") private String name; @Value("18") private Integer age; }
4、在SpringBoot的測試類下注入學生類輸出一下
@SpringBootTest class DemoApplicationTests { @Autowired //將學生類自動注入進來 private Student alex; @Test public void contextLoads() { System.out.println(alex); //打印看下學生對象 } }
結果成功輸出，@Value注入成功，這是我們原來的辦法對吧。
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 Student alex; //有參無參構造、get、set方法、toString()方法 }
6、我們來使用yaml配置的方式進行注入，大家寫的時候注意區別和優勢，我們編寫一個yaml配置！
person: name: qinjiang age: 3 happy: false birth: 2000/01/01 maps: {k1: v1,k2: v2} lists: - code - girl - music student: name: alex age: 1
7、我們剛才已經把person這個對象的所有值都寫好了，我們現在來注入到我們的類中！
/* @ConfigurationProperties作用： 將配置文件中配置的每一個屬性的值，映射到這個組件中； 告訴SpringBoot將本類中的所有屬性和配置文件中相關的配置進行綁定 參數 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 Student alex; }
8、確認以上配置都OK之后，我們去測試類中測試一下
@SpringBootTest class DemoApplicationTests { @Autowired Person person; //將person自動注入進來 @Test public void contextLoads() { System.out.println(person); //打印person信息 } }
yaml配置注入到實體類完全OK！
2、加載制定的配置文件
@PropertySource ：加載指定的配置文件；
@configurationProperties：默認從全局配置文件中獲取值；
1、我們去在resources目錄下新建一個person.properties文件
name=alex
2、然后在我們的代碼中指定加載person.properties文件
@PropertySource(value = "classpath:person.properties") // 注意路徑的寫法 @Component //注冊bean public class Person { @Value("${name}") private String name; ...... }
3、在測試類里進行測試
3、配置文件占位符
配置文件還可以編寫占位符生成隨機數
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
4、回顧properties配置文件
我們上面采用的yaml方法都是最簡單的方式，開發中最常用的；也是springboot所推薦的！那我們來嘮嘮其他的實現方式，道理都是相同的；寫還是那樣寫；配置文件除了yml還有我們之前常用的properties
[注意]properties配置文件在寫中文的時候，會有亂碼 ， 我們需要去IDEA中設置編碼格式為UTF-8；
settings-->FileEncodings 中配置；
測試步驟
1、新建一個實體類User
@Component //注冊bean public class User { private String name; private int age; private String sex; }
2、編輯配置文件 user.properties
user.name=kuangshen user.age=18 user.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); } }
5、對比總結
@Value這個使用起來並不友好！我們需要為每個屬性單獨注解賦值，比較麻煩；我們來看個功能對比圖
1、@ConfigurationProperties只需要寫一次即可 ， @Value則需要每個字段都添加
2、松散綁定：這個什么意思呢? 比如我的yml中寫的last-name，這個和lastName是一樣的， - 后面跟着的字母默認是大寫的。這就是松散綁定。可以測試一下
3、JSR303數據校驗 ， 這個就是我們可以在字段是增加一層過濾器驗證 ， 可以保證數據的合法性
4、復雜類型封裝，yml中可以封裝對象 ， 使用value就不支持
結論：
配置yml和配置properties都可以獲取到值 ， 強烈推薦 yml；
如果我們在某個業務中，只需要獲取配置文件中的某個值，可以使用一下 @value；
如果說，我們專門編寫了一個JavaBean來和配置文件進行一一映射，就直接@configurationProperties，不要猶豫！