SpringBoot自定義配置文件（xxx.properties）

轉載 ：https://www.cnblogs.com/V1haoge/p/7183408.html

SpringBoot中免除了大部分手動配置，但是對於一些特定的情況，還是需要我們進行手動配置的，SpringBoot爲我們提供了application.properties配置文件，讓我們可以進行自定義配置，來對默認的配置進行修改，以適應具體的生產情況，當然還包括一些第三方的配置。幾乎所有配置都可以寫到application.peroperties文件中，這個文件會被SpringBoot自動加載，免去了我們手動加載的煩惱。但實際上，很多時候我們卻會自定義配置文件，這些文件就需要我們進行手動加載，SpringBoot是不會自動識別這些文件的，下面就來仔細看看這些方面的內容。

1、配置文件的格式

　　SpringBoot可以識別兩種格式的配置文件，分別是yml文件與properties文件，我們可以將application.properties文件換成application.yml，這兩個文件都可以被SpringBoot自動識別並加載，但是如果是自定義的配置文件，就最好還是使用properties格式的文件，因爲SpringBoot中暫時還並未提供手動加載yml格式文件的功能（這裏指註解方式）。

　　application.properties配置文件欲被SpringBoot自動加載，需要放置到指定的位置：src/main/resource目錄下，一般自定義的配置文件也位於此目錄之下。

2、配置文件的加載

　　加載的意思就是將文件讀取到Spring容器之中，更確切的說就是將各個配置項裝載到Spring上下文容器之中供隨時取用。

　　application.properties配置文件是在SpringBoot項目啓動的時候被自動加載的，其內部的相關設置會自動覆蓋SpringBoot默認的對應設置項，所以的配置項均會保存到Spring容器之中。

1-公共配置文件：application.properties

donghao.name=唯一浩哥
donghao.sex=男
donghao.age=80

　　自定義的xxx.properties配置文件是不會被SpringBoot自動加載的，需要手動去進行加載，這裏的手動加載一般指的是註解的方式加載，這裏就涉及到我們今天的重點之一：加載自定義屬性文件的註解：@PropertySource("classpath:xxx.properties")，這個註解專門用來加載指定位置的properties文件，Spring暫未提供加載指定位置yml文件的註解，所以纔有之前的說法。

2-自定義配置文件：donghao.properties

donghao1.name=動畫
donghao1.sex=女
donghao1.age=22

　　其實無論對於哪裏的properties文件，當我們需要使用其中配置內容的時候，就在當前類的頂部加註該註解，將該配置文件加載到內存，這些配置文件一次加載即可多次使用。但更通用的情況是新建一個配置類，使用@Configuration標註，再加上之前的@PropertySource("classpath:xxx.properties")註解，而類的內部並不需要任何內容，這是一個純粹的配置加載類。由於@Configuration的作用（底層爲@Component），他會被Spring的掃描器掃到，並加載到JVM，並創建Bean，而創建的時候就會執行配置文件中配置項的加載。這種方式加載的配置可以在任何Spring管轄的類中用@Value("${key}")的方式使用，見下方介紹。

3、配置項的使用

　　配置項的使用其實很簡單，只要是加載到Spring容器中的配置項都可以直接使用@Value("${key}")的方式來引用，一般將其配置在字段頂部，表示將配置項的值賦值給該字段。

　　當然更多的情況是將這些配置項與一個JavaBean綁定起來使用，這樣綁定一次，我們就可以隨時使用。這裏涉及到兩種情況，一種是將application.properties中的配置與JavaBean綁定，一種是將自定義配置文件中的配置與Javabean綁定。

　　第一種：applicaiton.properties屬性綁定JavaBean

　　這種情況相對簡單（因爲application.properties文件會被自動加載，也就是說配置項會被自動加載到內存，到Spring容器之中，省去了手動加載的配置），然後我們在要與屬性綁定的JavaBean的類定義頂部加@Component註解和@ConfigurationProperties(prefix="key")註解，前者的目的是爲了這個JavaBean可以被SpringBoot項目啓動時候被掃描到並加載到Spring容器之中，重點是後者，這個註解一般不是單獨使用的，他一般與後面要說的@EnableConfigurationProperties(JavaBean.class)配合使用，但是二者並非使用在同一位置，@ConfigurationProperties(prefix="key")註解加註在JavaBean類定義之上，按字面可以理解爲屬性配置註解，更直接點的說法就是屬性綁定註解，官方解釋是：如果想要綁定或者驗證一些來源自.properties文件中的額外屬性時，你可以在一個標註的@Configuration的類的注有@Bean註解的方法或者一個類之上加註這個註解。我們完全可以將其理解爲綁定專用註解。它的作用就是將指定的前綴的配置項的值與JavaBean的字段綁定，這裏要注意，爲了綁定的成功，一般將字段的名稱與配置項鍵的最後一個鍵名相同，這樣整個鍵在去掉前綴的情況下就和字段名稱一致，以此來進行綁定。

　　第二種：自定義配置的屬性綁定JavaBean

　　這種情況與之前的基本相同，只是不能自動加載，需要手動加載，在JavaBean之上加上之前介紹的@PropertySource註解進行配置文件加載。還有一點就是將@Component改爲@Configuration，爲什麼這麼做呢？

　　@Configuration註解的底層就是@Component，但是二者意義不同，@Configuration註解側重配置之意，@Component側重組件之意，當然配置也是項目組件之一，在這裏我們要將配置文件屬性與JavaBean綁定，當然更側重配置之意。

　　將配置與JavaBean綁定之後，我們就可以通過JavaBean來獲取配置的內容，而且JavaBean已經被@Component註解或者@Configuration註解加載到Spring容器，我們可以使用自動注入的方式在其他類中隨便使用。

　　這裏要注意一點：當我們在某個類中要使用這個JavaBean時，需要在這個類中指定這個JavaBean的類型，這個指定也要使用註解來指定，正是之前介紹的@EnableConfigurationProperties註解，這個註解與@ConfigurationProperties註解配套使用。官方給出的解釋：這個註解是對@ConfigurationProperties的有效支持。標註有@ConfigurationProperties註解的Beans可以被使用標準的方式註冊（使用@Bean註解），或者，爲了方便起見，直接用使用@EnableConfigurationProperties指定註冊。意思是這個註解提供了一種方便直接的註冊Bean的方式。

3-綁定JavaBean：Donghao.java

package com.donghao.model;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;

@Configuration
@PropertySource("classpath:donghao.properties")
@ConfigurationProperties(prefix="donghao1")
public class Donghao {
    private String name;
    private String sex;
    private String age;
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public String getSex() {
        return sex;
    }
    public void setSex(String sex) {
        this.sex = sex;
    }
    public String getAge() {
        return age;
    }
    public void setAge(String age) {
        this.age = age;
    }
}

4-定義控制器：DonghaoController

package com.donghao.controller;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import com.donghao.model.Donghao;

@RestController
@RequestMapping("/donghao")
@EnableConfigurationProperties(Donghao.class)
public class DonghaoController {
    
    @Autowired
    Donghao donghao;
    
    @Value("${donghao.name}")
    private String name;
    
    @Value("${donghao.sex}")
    private String sex;
    
    @Value("${donghao.age}")
    private String age;

    
    @RequestMapping("/hello")
    public String hello(){
        return "我的名字叫"+name+",我是"+sex+"生,今年"+age+"歲了!";
    }
    
    @RequestMapping("/ss")
    public String ss(){
        return donghao.getName()+donghao.getSex()+donghao.getAge();
    }
}

5-定義啓動入口類：DonghaoApplication.java

package com.donghao;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class DonghaoApplication {

    public static void main(String[] args) {
        
        SpringApplication.run(DonghaoApplication.class, args);
        
    }

}

　　啓動程序之後，瀏覽器訪問：http://localhost:8080/donghao/hello，結果爲：

　　瀏覽器訪問：http://localhost:8080/donghao/ss

　　我這裏要重點強調一點，加載和使用並不相關聯，雖然加載的目的是爲了使用，但是加載和使用之間並不是強關聯的，我們完全可以加載但不使用，所以我們應該將加載的過程與使用的過程分開來分析，它們對應於不同的註解，這些註解之間也不是強關聯的，他們各有各的用途，如果只是加載自定義配置文件，只要一個@PropertySource註解就完事，使用方面的註解不用去管，當需要使用的時候，我們完全可以選擇多種使用的方式，直接使用的話我們就使用@Value註解進行直接賦值，這個註解就可以直接將被加載到Spring容器中（environment）的屬性配置的值賦值到指定的字段，當然也可以使用綁定JavaBean的方式。

　　還有一點要注意，千萬不要在公共配置文件application.properties和自定義配置文件xxx.properties中配置相同的的配置項的不同值，因爲公共配置文件的優先權最高，會覆蓋掉自定義配置文件中的內容，你可以這麼理解，公共配置文件中的某個配置被在啓動時加載到Spring容器中，之後又在另外一個自定義配置文件中加載了同名的配置項，二者有不同的值，但是系統會檢查二者的優先權，誰高誰留，誰低誰走，最後自定義配置文件中的值無效。