springboot 讀取 yml 配置的幾種方式

 

前言: 在 springboot 項目中通常默認的配置文件是 application.properties, 可是實際項目中咱們通常會使用 application.yml 文件, 下面就介紹一下在 springboot 中讀取 yml 配置的幾種方式.

yml 文件規則

• yml 文件的好處，自然的樹狀結構，一目瞭然，實質上跟 properties 是差很少的。

• 不支持 tab 縮進

• 能夠使用 "- 小寫字母" 或 "_小寫字母" 來 代替 "大寫字母", 如 userName 與 user-name ,user_name 含義是同樣的
  key: value 格式書寫
  key 後面跟着冒號, 再後面跟着一個空格, 而後是值

 

幾種數據格式的表示方式

•  

1. 普通的值（數字，字符串，布爾）

2.  

3. 對象、Map (屬性和值) (鍵值對)

3.  

4. 數組 (List、Set)

 

普通的值（數字，字符串，布爾）

直接就是 key: value , 如:

config set maxmemory-policy allkeys-lru
age: 18
name: mysgk

注:

字符串默認不用加上單引號或者雙引號；
""：雙引號；不會轉義字符串裏面的特殊字符；特殊字符會做爲自己想表示的意思
name: "zhangsan \n lisi"：輸出；zhangsan 換行 lisi
''：單引號；會轉義特殊字符，特殊字符最終只是一個普通的字符串數據
name: ‘zhangsan \n lisi’：輸出；zhangsan \n lisi

 

對象、Map（屬性和值）（鍵值對）

對象仍是 k: v 的方式
k: v：在下一行來寫對象的屬性和值的關係；注意縮進 (不支持 tab, 使用空格), 如:

config set maxmemory-policy allkeys-lru
person:
    age: 18
    name: mysgk

數組（List、Set）

用 - 值表示數組中的一個元素, 如:

config set maxmemory-policy allkeys-lru
hands:
    - left
    - right

第一種讀取方式 @value

若是咱們只須要配置文件中的一兩個值,@Value 是最簡單方便的方式.

config set maxmemory-policy allkeys-lru
server:
  port: 8081

咱們在代碼中能夠這樣取值

config set maxmemory-policy allkeys-lru
@Value("${server.port}")
public String port; 

注: 此處的 prot 所在的類須要是一個組件, 若是是實體類須要加上 @Component

第二種讀取方式 @ConfigurationProperties

若是須要一個 JavaBean 來專門映射配置的話, 咱們通常會使用 @ConfigurationProperties 來讀取.

config set maxmemory-policy allkeys-lru
student:
    age: 18
    name: mysgk

javabean:

config set maxmemory-policy allkeys-lru
@Component
@ConfigurationProperties(prefix = "student")
public class Student {

    private String name;

    private Integer age;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    @Override
    public String toString() {
        return "Student{" +
                " + name + '\'' +
                ", age=" + age +
                '}';
    }
}

使用 @ConfigurationProperties, 須要配置一個 prefix (前綴) 參數, 即寫上 key 就能夠了.

第三種讀取方式 @Environment

這種方法好像用的比較少, 基本沒用過...

config set maxmemory-policy allkeys-lru
test:
    msg: aaa

代碼:

config set maxmemory-policy allkeys-lru
    @Autowired
    private Environment env

    @RequestMapping(value = "index2", method = RequestMethod.GET)
    public String index2() {
        System.out.println(env.getProperty("test.msg"));
        return "The Way 2 : "+ env.getProperty("test.msg");
    }
}