application.properties多環境配置文件、jar包外部配置文件、配置項加密、程序中配置使用

1、簡介

spring boot項目application.properties文件存放及使用介紹

 

2、方法一多環境配置文件

咱們通常都會有多個應用環境，開發環境、測試環境、生產環境，各個環境的配置會略有不一樣，我能夠根據這個建立多份配置文件，由主配置文件來控制讀取那個子配置

建立spring boot項目後能夠同時建立多個.properties文件，只要符合它要求的格式便可

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

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

一、application.properties　　主配置（如下是配置內容，這裏的dev就是其餘配置文件的標識名dev、test、prod）

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

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

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

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

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

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

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

更改主配置中的spring.profiles.active=dev這個參數就能夠切換不一樣子配置文件了

因爲此方法.properties文件依然在jar中，咱們修改時並不方便，並且太多信息暴露在開發中容易泄露，因此結合方法二進行使用

 

3、方法二jar包外部配置文件

咱們在開發完成發佈生產環境時每每都會修改一下配置文件的相關內容，而默認.properties配置文件會被封裝到jar包中修改起來不方便，因此spring boot給了幾個讀取配置文件的位置，咱們能夠經過這個方式去從jar包外部修改配置文件

通常咱們會將.properties放在resources文件夾內

spring boot會按如下順序去尋找配置文件

一、「當前目錄」的/config文件夾下

二、「當前目錄」下

三、classpath的/config文件夾下

四、classpath下

 如下是圖例解釋 ：

當找到配置文件後將不會再繼續尋找，也就說該文件優先級如下的配置文件將不會被讀取，找到即中止

「當前目錄」指的是咱們打成可執行jar包後，通常會用bat文件來啓動，這個當前目錄指的就是bat文件的目錄

咱們常規存放的位置就是優先級最低的位置，因此咱們只須要再單獨拷貝一份配置文件，放在bat的「當前目錄」便可

 

4、配置項加密

咱們的application.properties文件中會有不少敏感信息，如：數據庫鏈接、緩存服務器鏈接等等，這些用戶名密碼都應該是外部不可見的，因此最好將其加密後存儲

咱們使用jasypt來進行加解密，首先先創建項目，我搭建了spring boot項目

一、添加pom.xml信息

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

二、在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==)

三、程序啓動類，默認jasypt的密鑰是放在配置文件中但這樣會致使密文和密鑰都在配置文件中，因此我把密鑰放在程序中

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

四、使用註解的方式來注入配置文件中的配置項

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方法
}

五、編寫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加密方式，因此每次加密出來的結果都不同，因此很適合對數據進行加密

 運行後，能夠看到自動解密的配置項

 

5、配置項注入靜態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來注入想讓程序使用的配置項，而不想讓程序使用的就不注入，這樣來使配置項可控

一、咱們在.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

二、@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;
    }
}

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

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

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

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