前言:Spring-boot的yml配置文件,這裏就不在藉助人、狗介紹了,試試套下微信!
創建yml文件
- 值得注意的是下圖中有三種命名方法,前兩種是對的,且第二種必須是橫線而不是下劃線!
- yml文件的基本語法:由鍵值對和空格組成
- 值得注意的是:作爲yml的固定格式,如wxmessage、contacts這樣的鍵後面,都需要加一個空格
weixin:
wxmessage: message
contacts: friends
discover: find_list
me: owner_message
- yml的Map寫法:一般情況下好友列表都會有ID,對應的暱稱,頭像地址,我們這裏拿不到id,
則可以將好友列表當做Map
- 這裏需要注意的是再使用IDEA 編輯配置文件的時候,如果發現配置文件的編輯項顯示異常,
比如:contacts :{image_qiankui: “百人錢坤”, image_qianmo: “百人阡陌”*},
那麼很有可能是配置文件的類型和實際映射的實體類型不一致,即:在java文件裏定義了
一個屬性:private Contacts contacts,實體卻定義成Map類型,就會出錯或者值爲null
weixin:
contacts :{image_qiankui: "百人錢坤",image_qianmo: "百人阡陌",}
- yml的 數組寫法:微信的發現表面看很明顯是一個List
find-list: [moments,Scan QR Code,Shake]
find-list:
- moments
- Scan QR Code
- Shake
- yml的對象寫法:“我”模塊中包含着用戶的暱稱、頭像、支付、相冊等,可以當做一個對象來處理。
me:
wxNickName: .
wxId: miao90***
wxPay: payAdress
- 配置文件相關的兩個註解:
//將對象注入到容器內
@Component
//標註在類名上表示該類對應配置文件的“weixin”
@ConfigurationProperties(prefix = “weixin”)
總結: 以上四種yml的常用寫法,除第一種很少能用上之外,其他的三種看似簡單,但經常會因爲空格層級關係不明確、實體類型映射不匹配等問題導致項目運行不成功!
附:測試相關代碼
package com.wujianqinjian.springboot_note.bean;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
import java.util.List;
import java.util.Map;
@Component
@ConfigurationProperties(prefix = "weixin")
public class Weixin {
private List<String> message;
private Map<String,String> contacts;
private List<String> findList;
private Me me;
@Override
public String toString() {
return "Weixin{" +
"message=" + message +
", contacts=" + contacts +
", findList=" + findList +
", me=" + me +
'}';
}
public List<String> getMessage() {
return message;
}
public void setMessage(List<String> message) {
this.message = message;
}
public Map<String, String> getContacts() {
return contacts;
}
public void setContacts(Map<String, String> contacts) {
this.contacts = contacts;
}
public List<String> getFindList() {
return findList;
}
public void setFindList(List<String> findList) {
this.findList = findList;
}
public Me getMe() {
return me;
}
public void setMe(Me me) {
this.me = me;
}
}
package com.wujianqinjian.springboot_note.bean;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
@Component
@ConfigurationProperties(prefix = "contacts")
public class Contacts {
private String imageUrl;
private String nickName;
@Override
public String toString() {
return "Contacts{" +
"imageUrl='" + imageUrl + '\'' +
", nickName='" + nickName + '\'' +
'}';
}
public String getNickName() {
return nickName;
}
public void setNickName(String nickName) {
this.nickName = nickName;
}
public String getImageUrl() {
return imageUrl;
}
public void setImageUrl(String imageUrl) {
this.imageUrl = imageUrl;
}
}
package com.wujianqinjian.springboot_note.bean;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
@Component
@ConfigurationProperties(prefix = "me")
public class Me {
private String wxNickName;
private String wxId;
private String wxPay;
private String wxCollect;
private String wxPhoto;
private String wxCards;
private String wxExpression;
@Override
public String toString() {
return "Me{" +
"wxNickName='" + wxNickName + '\'' +
", wxId='" + wxId + '\'' +
", wxPay='" + wxPay + '\'' +
", wxCollect='" + wxCollect + '\'' +
", wxPhoto='" + wxPhoto + '\'' +
", wxCards='" + wxCards + '\'' +
", wxExpression='" + wxExpression + '\'' +
'}';
}
public String getWxNickName() {
return wxNickName;
}
public void setWxNickName(String wxNickName) {
this.wxNickName = wxNickName;
}
public String getWxId() {
return wxId;
}
public void setWxId(String wxId) {
this.wxId = wxId;
}
public String getWxPay() {
return wxPay;
}
public void setWxPay(String wxPay) {
this.wxPay = wxPay;
}
public String getWxCollect() {
return wxCollect;
}
public void setWxCollect(String wxCollect) {
this.wxCollect = wxCollect;
}
public String getWxPhoto() {
return wxPhoto;
}
public void setWxPhoto(String wxPhoto) {
this.wxPhoto = wxPhoto;
}
public String getWxCards() {
return wxCards;
}
public void setWxCards(String wxCards) {
this.wxCards = wxCards;
}
public String getWxExpression() {
return wxExpression;
}
public void setWxExpression(String wxExpression) {
this.wxExpression = wxExpression;
}
}