Spring Boot入門(二)：獲取配置文件值

2019 年 10 月 28 日
筆記

本篇部落格主要講解下在Spring Boot中如何獲取配置文件的值。

1. 使用yaml配置文件

Spring Boot默認生成的配置文件為application.properties，不過它也支援yaml語言的配置文件，

兩者之間的差別並不是很大，只是yaml語言的配置文件層次結構更明顯，可讀性更強，因此目前使用的更多一些。

我們假設本來application.properties的配置為：

spring.main.banner-mode=off

那麼如何將配置文件切換為application.yml呢？

首先刪除掉原來的配置文件application.properties，新增配置文件application.yml，新增方式如下：

然後修改application.yml為：

spring:    main:      banner-mode: "off"

運行結果和原來使用properties配置文件時一致。

2. 使用@Value註解獲取配置文件值

首先在application.yml中添加如下配置：

book:    author: wangyunfei    name: spring boot

然後修改啟動類的程式碼為：

package com.zwwhnly.springbootaction;    import org.springframework.beans.factory.annotation.Value;  import org.springframework.boot.SpringApplication;  import org.springframework.boot.autoconfigure.SpringBootApplication;  import org.springframework.web.bind.annotation.RequestMapping;  import org.springframework.web.bind.annotation.RestController;    @RestController  @SpringBootApplication  public class SpringbootActionApplication {      @Value("${book.name}")      private String bookName;        @Value("${book.author}")      private String bookAuthor;        @RequestMapping("/")      public String index() {          return "book name is:" + bookName + " and book author is:" + bookAuthor;      }        public static void main(String[] args) {          SpringApplication.run(SpringbootActionApplication.class, args);      }  }

運行項目，在瀏覽器中輸入http://localhost:8080/，會看到如下資訊：

這種方式和在Spring項目中的使用方式一樣，更多的細節，可以查看我之前總結的部落格：

Spring入門(九)：運行時值注入。

3. 使用@ConfigurationProperties註解獲取配置文件值

Spring Boot還提供了@ConfigurationProperties註解來獲取配置文件值，該種方式可把配置文件值和一個Bean自動關聯起來，使用起來更加方便而且類型安全，建議使用這種方式。

首先，在application.yml中添加如下配置：

author:    name: wangyunfei    age: 32

然後，新建類AuthorSettings，添加@Component註解和@ConfigurationProperties註解：

package com.zwwhnly.springbootaction;    import org.springframework.boot.context.properties.ConfigurationProperties;  import org.springframework.stereotype.Component;    @Component  @ConfigurationProperties(prefix = "author")  public class AuthorSettings {      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;      }  }

這裡的重點是@ConfigurationProperties註解，它的prefix屬性用來指定配置的前綴，如本例中的author。

然後修改啟動類的程式碼為：

package com.zwwhnly.springbootaction;    import org.springframework.beans.factory.annotation.Autowired;  import org.springframework.boot.SpringApplication;  import org.springframework.boot.autoconfigure.SpringBootApplication;  import org.springframework.web.bind.annotation.RequestMapping;  import org.springframework.web.bind.annotation.RestController;    @RestController  @SpringBootApplication  public class SpringbootActionApplication {      @Autowired      private AuthorSettings authorSettings;        @RequestMapping("/")      public String index() {          return "author name is " + authorSettings.getName() + " and author age is " + authorSettings.getAge();      }        public static void main(String[] args) {          SpringApplication.run(SpringbootActionApplication.class, args);      }  }

運行項目，在瀏覽器中輸入http://localhost:8080/，會看到如下資訊：