一、yaml語法
1)配置文件
SpringBoot使用一個全局的配置文件 , 配置文件名稱是固定的
-
application.properties
-
語法結構 :key=value
-
application.yml
-
語法結構 :key:空格 value
配置文件的作用 :修改SpringBoot自動配置的默認值,因為SpringBoot在底層都給我們自動配置好了;
比如我們可以在配置文件中修改Tomcat 默認啟動的端口號!測試一下!
server.port=8081
2)yaml概述
YAML是 "YAML Ain't a Markup Language" (YAML不是一種標記語言)的遞歸縮寫。在開發的這種語言時,YAML 的意思其實是:"Yet Another Markup Language"(仍是一種標記語言)
這種語言以數據作為中心,而不是以標記語言為重點!
以前的配置文件,大多數都是使用xml來配置;比如一個簡單的端口配置,我們來對比下yaml和xml
傳統xml配置:
<server> <port>8081<port> </server>
yaml配置:
server: prot: 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: qinjiang age: 3
行內寫法
student: {name: qinjiang,age: 3}
數組( List、set )
用 - 值表示數組中的一個元素,比如:
pets: - cat - dog - pig
行內寫法
pets: [cat,dog,pig]
修改SpringBoot的默認端口號
配置文件中添加,端口號的參數,就可以切換端口;
server: port: 8082
二、注入配置文件
yaml文件更強大的地方在於,他可以給我們的實體類直接注入匹配值!
● 我們原來是通過@Value配置注入bean屬性值的:
1、使用@Value注入屬性
@Component //注冊bean public class Dog { @Value("大黃") private String name; @Value("2") private Integer age; }
2、在SpringBoot的測試類下注入狗狗輸出一下;
@SpringBootTest class DemoApplicationTests { @Autowired //將狗狗自動注入進來 Dog dog; @Test public void contextLoads() { System.out.println(dog); //打印看下狗狗對象 } }
3、結果成功輸出,@Value注入成功,這是我們原來的辦法
下面我們通過配置文件方式配置注入
1)yaml注入配置文件 - @configurationProperties
使用yml注入屬性:默認從全局配置文件中獲取值,在springboot項目中的resources目錄下新建一個文件 application.yml
1、使用yaml配置的方式進行注入,寫的時候注意區別和優勢
person: name: 納魯多 age: 22 happy: true birth: 2019/09/14 maps: {k1: v1,k2: v2} lists: - 哈哈哈 - 呵呵呵 - 嘻嘻嘻 dog: name: 旺財 age: 3
2、@ConfigurationProperties:將yml配置中的person這個對象,注入到我們的類中!
作用:
將配置文件中配置的每一個屬性的值,映射到這個組件中;
告訴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 Dog dog; // 有參無參構造、get、set方法、toString()方法 }
3、配置@ConfigurationProperties注解:IDEA 提示,springboot配置注解處理器沒有找到,我們可以查看文檔,找到一個依賴!
導入配置文件處理器,配置文件進行綁定就會有提示,需要重啟或刷新Maven
4、確認以上配置都之后,進行一下測試:
@SpringBootTest class Springboot002ApplicationTests { @Autowired private Person person; @Test void contextLoads() { System.out.println(person); } }
yaml配置注入到實體類完全OK!
2)加載指定的配置文件 - @PropertySource
注意:properties配置文件在寫中文的時候,會有亂碼 , 我們需要去IDEA中設置編碼格式為UTF-8;
[ settings -> FileEncodings 中配置;
1、resources目錄下新建一個 person.properties 文件
name=一只人
age=18
2、使用@PropertySource注解在類中指定加載 person.properties 文件,含中文時可以使用encoding屬性指定編碼
@Component @PropertySource(value = "classpath:person.properties",encoding = "UTF-8") public class Person { @Value("${name}") // 使用@Value+EL表達式,取出配置文件的屬性值 private String name; @Value("${age}") private Integer age; .... }
3、再次輸出測試一下:指定配置文件綁定成功!
3)配置文件占位符
配置文件還可以編寫占位符生成隨機數
person: name: ${random.uuid} # 隨機uuid age: ${random.int} # 隨機int happy: true dogname: bigbig maps: {k1: v1,k2: v2} lists: - 哈哈哈 - 呵呵呵 - 嘻嘻嘻 dog: name: ${person.dogname:dogname} # 如果冒號左邊不為空':'就輸出左邊的,否則輸出右邊 age: ${person.dogage:1} happy: ${person.doghappy:${person.happy}} # 可以嵌套
測試輸出:
Person{name='b531332d-ae05-4587-8980-1eda5d05bcc2', age=350630538,
happy=true, maps={k1=v1, k2=v2}, lists=[哈哈哈, 呵呵呵, 嘻嘻嘻],
dog=Dog{name='bigbig', age=1, happy=true}}
4)對比小結
@Value這個使用起來並不友好!我們需要為每個屬性單獨注解賦值,比較麻煩。
@ConfigurationProperties | @Value | |
功能 | 支持 | 一個個綁定 |
松散綁定(松散語法) | 支持 | 不支持 |
SpEl | 不支持 | 支持 |
JSP303數據校驗 | 支持 | 不支持 |
復雜類型封裝 | 支持 | 不支持 |
1、@ConfigurationProperties只需要寫一次即可 ,@Value則需要每個字段都添加
2、松散綁定:這個什么意思呢? 比如我的yml中寫的last-name,這個和lastName是一樣的,- 后面跟着的字母默認是大寫的。這就是松散綁定。可以測試一下
3、JSR303數據校驗 , 這個就是我們可以在字段是增加一層過濾器驗證,可以保證數據的合法性
4、復雜類型封裝,yml中可以封裝對象 , 使用value就不支持
結論:
配置 yml 和配置 properties 都可以獲取到值,強烈推薦 yml;
如果我們在某個業務中,只需要獲取配置文件中的某個值,可以使用一下 @Value;
如果說,我們專門編寫了一個JavaBean來和配置文件進行一一映射,就直接@ConfigurationProperties
@轉載於 - 狂神