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

Posted on by

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

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

創建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等配置管理中心進行配置統一管理

到此這篇關於spring boot項目application.properties文件存放及使用介紹的文章就介紹到這瞭,更多相關spring boot application.properties文件內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：