本篇部落格主要講解下在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/，會看到如下資訊：

4. 使用Profile實現多環境配置管理

一般情況下，我們開發的應用程式都會有多套環境， 如dev環境，qa環境，prod環境，那麼如何實現多套環境下的配置管理呢？

其實在Spring Boot下，我們可以使用Profile來實現，接下來講解下具體的實現方式。

首先，新建2個配置檔案：application-dev.yml，application-prod.yml。

此時的專案結構如下圖所示：

如果有的同學比較喜歡用properties檔案，可以用下圖中的方式新建：

預設情況下，啟動的埠號為8080，如果我們希望在dev環境使用埠號8082，在prod環境使用埠號8083，那麼可以修改配置檔案如下：

application-dev.yml新增如下配置：

server:
  port: 8082

application-prod.yml新增如下配置：

server:
  port: 8083

執行專案，如下圖所示：

我們會發現，仍然使用的是預設的埠號8080，那麼如何指定使用dev或者prod環境的埠呢？

我們需要在application.yml新增如下配置：

spring:
  profiles:
    active: dev

此時，再次執行專案，會發現使用的是埠號8082，也就是application-dev.yml檔案中配置的。

如果希望使用prod環境的，可以修改配置為：

spring:
  profiles:
    active: prod

執行結果為：

關於Spring專案中Profile的使用可以檢視我之前總結的部落格：Spring入門(七)：Spring Profile使用講解。

5. 原始碼及參考

原始碼地址：https://github.com/zwwhnly/springboot-action.git，歡迎下載。

汪雲飛《Java EE開發的顛覆者：Spring Boot實戰》

SpringBoot - 多Profile使用與切換

IDEA如何建立.properties檔案

6. 最後

歡迎掃碼關注微信公眾號：「申城異鄉人」，定期分享Java技術乾貨，讓我們一起進步。

相關推薦