springboot 讀取 yml 配置的幾種方式

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

yml 文件規則

• yml文件的好處，天然的樹狀結構，一目了然，實質上跟properties是差不多的。
• 不支持tab縮進
• 可以使用 "-小寫字母" 或 "_小寫字母"來 代替 "大寫字母",如 userName 與 user-name ,user_name 含義是一樣的
  key: value 格式書寫
  key 后面跟着冒號,再后面跟着一個空格,然后是值

幾種數據格式的表示方式

• 1.普通的值（數字，字符串，布爾）
• 2.對象、Map (屬性和值) (鍵值對)
• 3.數組 (List、Set)

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

直接就是 key: value ,如:

age: 18
name: mysgk

注:

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

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

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

person:
    age: 18
    name: mysgk

數組（List、Set）

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

hands:
    - left
    - right

第一種讀取方式@value

如果我們只需要配置文件中的一兩個值,@Value 是最簡單方便的方式.

server:
  port: 8081

我們在代碼中可以這樣取值

@Value("${server.port}")
public String port;	

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

第二種讀取方式@ConfigurationProperties

如果需要一個JavaBean 來專門映射配置的話,我們一般會使用@ConfigurationProperties來讀取.

student:
    age: 18
    name: mysgk

javabean:

@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='" + name + '\'' +
                ", age=" + age +
                '}';
    }
}

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

第三種讀取方式@Environment

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

test:
    msg: aaa

代碼:

    @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");
    }
}