SpringBoot04_配置檔案相關
配置檔案
SpringBoot使用一個全域性配置檔案，且配置檔案的名稱是固定的
application.properties
語法結構 key=value
application.yaml(application.yml)
語法結構key: value （注意：後有一個空格）
**配置檔案的作用 ：**修改SpringBoot自動配置的預設值，因為SpringBoot在底層都給我們自動配置好了；
比如我們可以在配置檔案中修改Tomcat 預設啟動的埠號！測試一下！
server.port=8081
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
yaml基礎語法
說明：語法要求嚴格！
1、空格不能省略
2、以縮排來控制層級關係，只要是左邊對齊的一列資料都是同一個層級的。
3、屬性和值的大小寫都是十分敏感的。
字面量：普通的值 [ 數字，布林值，字串 ]
字面量直接寫在後面就可以 ， 字串預設不用加上雙引號或者單引號；
k: v
注意：
-
“ ” 雙引號，會轉義字串裡面的特殊字元 ， 特殊字元會作為本身想表示的意思；
比如 ：name: “kuang \n shen” 輸出 ：kuang 換行 shen
-
‘’ 單引號，不會轉義特殊字元 ， 特殊字元最終會變成和普通字元一樣輸出
比如 ：name: ‘kuang \n shen’ 輸出 ：kuang \n shen
在下一行來寫物件的屬性和值得關係，注意縮排；比如：
student: name: qinjiang age: 3行內寫法
student: {name: qinjiang,age: 3}陣列（ List、set ）
用 - 值表示陣列中的一個元素,比如：
注意 -後要有個空格
pets: - cat - dog - pig行內寫法
pets: [cat,dog,pig]修改SpringBoot的預設埠號
配置檔案中新增，埠號的引數，就可以切換埠；
server: port: 8082
注入值到Bean中
yaml檔案更強大的地方在於，他可以給我們的實體類直接注入匹配值！
person:
name: zyf
age: 21
happy: false
birth: 1999/03/28
map: {v1: k1,v2: k2}
list:
- code
- basketball
- sleep
dog:
name: 旺財
age: 3
dog:
name: 小白
age: 4
寫兩個實體類 然後再測試類中測試是否注入成功
@Component
@Data
@ConfigurationProperties(prefix = "person")
public class Person {
private String name;
private int age;
private Boolean happy;
private Date birth;
private Map<String,Object> map;
private List<Object> list;
private Dog dog;
}
@Component
@Data
@ConfigurationProperties(prefix = "dog")
public class Dog {
private String name;
private int age;
}
class SpringbootstudyApplicationTests {
@Autowired
Person person;
@Autowired
Dog dog;
@Test
void contextLoads() {
System.out.println(person);
Map<String,Object> map = person.getMap();
Set set = map.keySet();
for (Object obj:set
) {
System.out.println(obj+":"+map.get(obj));
}
List<Object> list = person.getList();
System.out.println(list.size());
for (int i=0;i<list.size();i++){
System.out.println(list.get(i));
}
}
}
@ConfigurationProperties作用：將配置檔案中配置的每一個屬性的值，對映到這個元件中；告訴SpringBoot將本類中的所有屬性和配置檔案中相關的配置進行繫結引數 prefix = “person” : 將配置檔案中的person下面的所有屬性一一對應
載入指定的配置檔案
**@PropertySource ：**載入指定的配置檔案；
@configurationProperties：預設從全域性配置檔案中獲取值；
1、我們去在resources目錄下新建一個person.properties檔案
name=kuangshen
2、然後在我們的程式碼中指定載入person.properties檔案
@PropertySource(value = "classpath:person.properties")@Component
//註冊bean
public class Person {
@Value("${name}")
private String name;
......
}
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}_旺財 //三元運算 如果person.hello不存在則使用other
age: 1
回顧properties配置
我們上面採用的yaml方法都是最簡單的方式，開發中最常用的；也是springboot所推薦的！那我們來嘮嘮其他的實現方式，道理都是相同的；寫還是那樣寫；配置檔案除了yml還有我們之前常用的properties ， 我們沒有講，我們來嘮嘮！
【注意】properties配置檔案在寫中文的時候，會有亂碼 ， 我們需要去IDEA中設定編碼格式為UTF-8；
settings–>FileEncodings 中配置；
測試步驟：
1、新建一個實體類User
@Component //註冊beanpublic 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測試
@SpringBootTestclass
DemoApplicationTests {
@Autowired
User user;
@Test
public void contextLoads() {
System.out.println(user);
}
}
結果正常輸出：
對比小結
@Value這個使用起來並不友好！我們需要為每個屬性單獨註解賦值，比較麻煩；我們來看個功能對比圖
1、@ConfigurationProperties只需要寫一次即可 ， @Value則需要每個欄位都新增
2、鬆散繫結：這個什麼意思呢? 比如我的yml中寫的last-name，這個和lastName是一樣的， - 後面跟著的字母預設是大寫的。這就是鬆散繫結。可以測試一下
3、JSR303資料校驗 ， 這個就是我們可以在欄位是增加一層過濾器驗證 ， 可以保證資料的合法性
4、複雜型別封裝，yml中可以封裝物件 ， 使用value就不支援
結論：
配置yml和配置properties都可以獲取到值 ， 強烈推薦 yml；
如果我們在某個業務中，只需要獲取配置檔案中的某個值，可以使用一下 @value；
如果說，我們專門編寫了一個JavaBean來和配置檔案進行一一對映，就直接@configurationProperties，不要猶豫！
配置檔案要怎麼寫
SpringBoot官方文件中有大量配置，如果都記住不現實
我們可以通過分析自動配置原理來學習配置檔案應該怎麼去寫
在前面我們知道了在專案啟動時會自動裝配很多元件，那麼在spring.factories檔案我們看到有很多xxxxAutoConfiguration類（自動配置類）
這裡以HttpEncodingAutoConfiguration為例子來再瞭解一下自動裝配
[外鏈圖片轉存失敗,源站可能有防盜鏈機制,建議將圖片儲存下來直接上傳(img-wErKIx6O-1608086633267)(C:\Users\hah\AppData\Roaming\Typora\typora-user-images\image-20200506132725905.png)]
可以發現這些自動配置類都會是一個Spring的配置類 使用了@Configuration
然後還可以發現都基本有@EnableConfigurationProperties(xxxxx.class)這樣的一個註解
我們進入HttpProperties類看看
[外鏈圖片轉存失敗,源站可能有防盜鏈機制,建議將圖片儲存下來直接上傳(img-Ae18f09I-1608086633268)(C:\Users\hah\AppData\Roaming\Typora\typora-user-images\image-20200506132922307.png)]
發現有前面我們測試yaml配置檔案注入值到bean中時使用的註解
@ConfigurationProperties(prefix = "spring.http")
那麼我們可以知道這個類的屬性的值會被配置檔案裡的spring.http的值注入
可以發現HttpProperties有內部類Encoding 有屬性charset和force等等
[外鏈圖片轉存失敗,源站可能有防盜鏈機制,建議將圖片儲存下來直接上傳(img-7NiHEIwq-1608086633270)(C:\Users\hah\AppData\Roaming\Typora\typora-user-images\image-20200506133519453.png)]
然後發現可以在配置檔案中也可以配置這些值
[外鏈圖片轉存失敗,源站可能有防盜鏈機制,建議將圖片儲存下來直接上傳(img-plOfH3G1-1608086633271)(C:\Users\hah\AppData\Roaming\Typora\typora-user-images\image-20200506133707159.png)]
所以可以發現xxxProperties這些類裡的屬性與配置檔案中可以配置的屬性是一一對應的
再根據之前自動裝配原理初探可以總結得到，這些自動配置類（xxxxAutoConfiguration）會根據當前不同的條件判斷（ConditionXXXX），決定這個配置類是否生效！
- 一但這個配置類生效；這個配置類就會給容器中新增各種元件(元件就是註解了@Bean的)；
- 這些元件的屬性是從對應的properties類中獲取的，這些類裡面的每一個屬性又是和配置檔案繫結的；
- 所有在配置檔案中能配置的屬性都是在xxxxProperties類中封裝著；
- 配置檔案能配置什麼就可以參照某個功能對應的這個屬性類
所以當我們需要配置什麼時就可以去找相對應的自動配置類然後找到對應的xxxProperties類去看有哪些屬性可以進行配置
那麼多的自動配置類，必須在一定的條件下才能生效；也就是說，我們載入了這麼多的配置類，但不是所有的都生效了。
我們怎麼知道哪些自動配置類生效？
我們可以通過啟用 debug=true屬性；來讓控制檯列印自動配置報告，這樣我們就可以很方便的知道哪些自動配置類生效；
#開啟springboot的除錯類
debug： true
Positive matches:（自動配置類啟用的：正匹配）
Negative matches:（沒有啟動，沒有匹配成功的自動配置類：負匹配）
Unconditional classes: （沒有條件的類）