1. 程式人生 > >第二篇:Spring Boot配置檔案詳解

第二篇:Spring Boot配置檔案詳解

Spring Boot採納了建立生產就緒Spring應用程式的觀點。 Spring Boot優先於配置的慣例,旨在讓您儘快啟動和執行。在一般情況下,我們不需要做太多的配置就能夠讓Spring Boot正常執行。在一些特殊的情況下,我們需要做一些配置修改,或者配置自定義屬性。

自定義屬性

當我們建立一個Spring Boot專案的時候,系統預設會為我們在src/main/java/resources目錄下建立一個application.properties。個人習慣,我喜歡使用application.yml檔案,當然Spring Boot兩種檔案格式都支援。

在application.yml自定義一組屬性:

my:
 name: chenjay
 age: 12

如果你需要讀取配置檔案的值只需要加@Value("${屬性名}"):

@RestController
public class HelloController {
    @Value("${my.name}")
    private String name;
    @Value("${my.age}")
    private int age;

    @RequestMapping(value = "/hello")
    public String miya() {
        return name + ":"
+ age; } }

啟動工程,訪問:localhost:8080/hello,瀏覽器顯示:
在這裡插入圖片描述

將配置檔案的屬性賦給實體類

當我們有很多配置屬性的時候,這時我們會把這些屬性作為欄位來建立一個實體類,並將屬性值賦予給他們,比如:

my:
  name: chenjay
  age: 22
  uuid: ${random.uuid}
  max: ${random.int(10)}
  value: ${random.value}
  greeting: hi,I'm  ${my.name} and I'm ${my.age} years old.

其中配置檔案中用到了${random} ,它可以用來生成各種不同型別的隨機值。
那怎麼才能把這些屬性賦於給一個實體類呢,首先建立一個實體類:

@ConfigurationProperties(prefix = "my")
@Component
public class ConfigBean {
    private String name;
    private int age;
    private String uuid;
    private int max;
    private String value;
    private String greeting;

    //省略了getter setter....
}

需要加個註解@ConfigurationProperties,並加上它的prrfix。另外@Component聲明瞭這個實體類是一個bean。另外需要在應用類或者application類,加EnableConfigurationProperties註解。

@RestController
public class ConfigController {
    @Autowired
    ConfigBean configBean;

    @RequestMapping(value = "/chenjay")
    public String Chenjay() {
        return configBean.getGreeting() + " >>>>" + configBean.getValue() + " >>>>" + configBean.getUuid() + " >>>>" + configBean.getMax();
    }
}

啟動工程,訪問localhost:8080/chenjay,我們會發現配置檔案資訊讀到了。
在這裡插入圖片描述

自定義配置檔案

上面介紹的是我們都把配置檔案寫到application.yml中。有時我們不願意把配置都寫到application配置檔案中,這時需要我們自定義配置檔案,比如customize.yml:

com:
  blog:
    name: chenjay
    age: 22

怎麼將這個配置檔案資訊賦予給一個實體類呢?

@Configuration
@PropertySource(value = "classpath:customize.yml")
@ConfigurationProperties(prefix = "com.blog")
public class User {
    private String name;
    private int age;
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public int getAge() {
        return age;
    }
    public void setAge(int age) {
        this.age = age;
    }
}
@RestController
public class UserController {

    @Autowired
    User user;

    @RequestMapping(value = "/user")
    public String user() {
        return user.getName() + ":" + user.getAge();
    }
}

啟動工程,開啟localhost:8080/user;瀏覽器會顯示:
在這裡插入圖片描述

多個環境配置檔案

在現實的開發環境中,我們需要不同的配置環境;格式為application-{profile}.yml,其中{profile}對應你的環境標識,比如:

  • application-test.yml:測試環境
  • application-dev.yml:開發環境
  • application-prod.yml:生產環境

怎麼使用?只需要我們在application.yml中加:

spring:
  profiles:
    active: dev

其中application-dev.yml:

 server:
  port: 8081

啟動工程,發現程式的埠不再是8080,而是8081。
在這裡插入圖片描述

原始碼下載:https://github.com/chenjary/SpringBoot