一、簡介

spring boot專案application.properties檔案存放及使用介紹

二、方法一多環境配置檔案

我們一般都會有多個應用環境，開發環境、測試環境、生產環境，各個環境的配置會略有不同，我可以根據這個建立多份配置檔案，由主配置檔案來控制讀取那個子配置

建立spring boot專案後可以同時建立多個.properties檔案，只要符合它要求的格式即可

格式：application-{profile}.properties；{profile}是變數用於自定義配置檔名稱

分別建立三個應用環境的配置和一個主配置

1、application.properties　　主配置（以下是配置內容，這裡的dev就是其他配置檔案的標識名dev、test、prod）

# 具體使用那個配置檔案的標識名稱（格式：application-{profile}.properties；{profile}是變數用於自定義配置檔名稱）
spring.profiles.active=dev

2、application-dev.properties　　開發環境（以下是配置內容）

spring.application.name=tyh-demo-prop
# 開發環境埠
server.port=10001

3、application-test.properties　　測試環境（以下是配置內容）

spring.application.name=tyh-demo-prop
#
 
 測試環境埠
server.port=10002

4、application-prod.properties　　生產環境（以下是配置內容）

spring.application.name=tyh-demo-prop
# 生產環境埠
server.port=10003

更改主配置中的spring.profiles.active=dev這個引數就可以切換不同子配置檔案了

由於此方法.properties檔案依然在jar中，我們修改時並不方便，而且太多資訊暴露在開發中容易洩露，所以結合方法二進行使用

三、方法二jar包外部配置檔案

我們在開發完成釋出生產環境時往往都會修改一下配置檔案的相關內容，而預設.properties配置檔案會被封裝到jar包中修改起來不方便，所以spring boot給了幾個讀取配置檔案的位置，我們可以通過這個方式去從jar包外部修改配置檔案

一般我們會將.properties放在resources資料夾內

spring boot會按以下順序去尋找配置檔案

1、“當前目錄”的/config資料夾下

2、“當前目錄”下

3、classpath的/config資料夾下

4、classpath下

 以下是圖例解釋 ：

當找到配置檔案後將不會再繼續尋找，也就說該檔案優先順序以下的配置檔案將不會被讀取，找到即停止

“當前目錄”指的是我們打成可執行jar包後，一般會用bat檔案來啟動，這個當前目錄指的就是bat檔案的目錄

我們常規存放的位置就是優先順序最低的位置，所以我們只需要再單獨拷貝一份配置檔案，放在bat的“當前目錄”即可

四、配置項加密

我們的application.properties檔案中會有很多敏感資訊，如：資料庫連線、快取伺服器連線等等，這些使用者名稱密碼都應該是外部不可見的，所以最好將其加密後儲存

我們使用jasypt來進行加解密，首先先建立專案，我搭建了spring boot專案

1、新增pom.xml資訊

<!-- 配置檔案項加密 -->
<dependency>
    <groupId>com.github.ulisesbocchio</groupId>
    <artifactId>jasypt-spring-boot-starter</artifactId>
    <version>2.1.0</version>
</dependency>

2、在application.properties檔案中增加配置項，需要jasypt來解密的密文需要用“ENC(......)”括起來

spring.application.name=tyh-demo-prop
server.port=10001
# 配置檔案項加解密密碼，此處註釋，而放在程式碼中（放在程式碼中使加密金鑰和密文分開）
#jasypt.encryptor.password=112233
# 模擬資料庫連線帳號密碼
spring.datasource.username=ENC(nm3F96GtUIwZUHzsP0Mp1A==)
spring.datasource.password=ENC(lmn7lAlePy1hZu505WO0xQ==)

3、程式啟動類，預設jasypt的金鑰是放在配置檔案中但這樣會導致密文和金鑰都在配置檔案中，所以我把金鑰放在程式中

@SpringBootApplication
public class App {
    public static void main(String[] args) {
        //設定配置檔案項加密金鑰（放在這裡使加密金鑰和密文分開）
        System.setProperty("jasypt.encryptor.password", "112233");
        SpringApplication.run(App.class, args);
    }
}

4、使用註解的方式來注入配置檔案中的配置項

import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

@Component
public class SysConfig {

    @Value("${spring.datasource.username}")
    private String dbUsername;

    @Value("${spring.datasource.password}")
    private String dbPassword;
//自己生成get set方法
}

5、編寫controller及action來呼叫一下

import com.tyh.demo.prop.config.SysConfig;
import org.jasypt.encryption.StringEncryptor;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

@Controller
@RequestMapping("/test")
public class TestController {

    @Autowired
    StringEncryptor encryptor;

    @ResponseBody
    @RequestMapping("/index")
    public String index() {
        return encryptor.encrypt("taiyonghai");
    }

    @Autowired
    SysConfig sysConfig;

    @ResponseBody
    @RequestMapping("/getConfig")
    public SysConfig getConfig() {
        //spring boot自動注入就會將密文解密
        return sysConfig;
    }
}

由於其使用的是PBEWithMD5AndDES加密方式，所以每次加密出來的結果都不一樣，所以很適合對資料進行加密

 執行後，可以看到自動解密的配置項

五、配置項注入靜態static與非靜態屬性

我們有很多編碼需求需要使用.properties檔案中自定義的配置項，傳統使用Properties物件來操作，類似如下程式碼，

這種方式太過靈活我們不想使用的配置項可能也會被提取出來，而且當我們不想使用jar包內的配置檔案，而是利用優先順序使用外部的，這種直接讀取的方式就很不方便，所以推薦使用@Value的方式來使用

public class SysConfigUtil {
    private static Properties props;
    static {
        try {
            // TODO：讀取使用者配置
            Resource resource = new ClassPathResource("/application.properties");
            props = PropertiesLoaderUtils.loadProperties(resource);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
    public static String getProperty(String key) {
        return props == null ? null : props.getProperty(key);
    }
｝

還是剛才的專案，使用@Value來注入想讓程式使用的配置項，而不想讓程式使用的就不注入，這樣來使配置項可控

1、我們在.properties檔案中增加兩個自定義配置項

spring.application.name=tyh-demo-prop
server.port=10001
# 配置檔案項加解密密碼，此處註釋，而放在程式碼中（放在程式碼中使加密金鑰和密文分開）
#jasypt.encryptor.password=112233
# 模擬資料庫連線帳號密碼
spring.datasource.username=ENC(nm3F96GtUIwZUHzsP0Mp1A==)
spring.datasource.password=ENC(lmn7lAlePy1hZu505WO0xQ==)
# 模擬其他自定義配置項
#tyh.url.web.admin=http://www.admin.com
tyh.url.web.agent=http://www.agent.com

2、@Value注入可以給靜態屬性也可以給非靜態屬性，具體根據使用場景自行決定，如果配置項可能不存在也可以設定預設值，避免程式無法啟動

@Component
public class SysConfig {

    @Value("${spring.datasource.username}")
    private String dbUsername;

    @Value("${spring.datasource.password}")
    private String dbPassword;

    /*
    非靜態屬性注入（注入屬性）
     */
    //@Value的引數代表配置項的key，如果沒有啟動會報錯，加上“:”為其設定預設值即可解決冒號後面的就是預設值內容，也可以直接:冒號後面空白就是空
    @Value("${tyh.url.web.admin:www.abc.com}")
    private String urlAdmin;

    //###自己建立get/set方法###

    /*
    靜態屬性注入（注入set()方法）
     */
    //使用@Component把當前類當作元件啟動時注入該靜態屬性值，靜態屬性注入set()方法
    public static String urlAgent;
    @Value("${tyh.url.web.agent:}")
    private void setUrlAgent(String urlAgent) {
        SysConfig.urlAgent = urlAgent;
    }
}

3、使用時非靜態屬性使用Autowired注入，靜態屬性直接取值

    //非靜態屬性注入取值（必須使用Autowired注入）
    @Autowired
    SysConfig sysConfig;

    public void test() {
        //靜態屬性注入取值（直接獲取）
        String str = SysConfig.urlAgent;
    }

 推薦使用@Value來注入配置項進行使用，便與後續接入Apollo等配置管理中心進行配置統一管理