spring boot項目application.properties文件存放及使用介紹
我們一般都會有多個應用環(huán)境,開發(fā)環(huán)境、測試環(huán)境、生產(chǎn)環(huán)境,各個環(huán)境的配置會略有不同,我可以根據(jù)這個創(chuàng)建多份配置文件,由主配置文件來控制讀取那個子配置
創(chuàng)建spring boot項目后可以同時創(chuàng)建多個.properties文件,只要符合它要求的格式即可
格式:application-{profile}.properties;{profile}是變量用于自定義配置文件名稱
分別創(chuàng)建三個應用環(huán)境的配置和一個主配置
1、application.properties主配置(以下是配置內(nèi)容,這里的dev就是其他配置文件的標識名dev、test、prod)
# 具體使用那個配置文件的標識名稱(格式:application-{profile}.properties;{profile}是變量用于自定義配置文件名稱)spring.profiles.active=dev
2、application-dev.properties開發(fā)環(huán)境(以下是配置內(nèi)容)
spring.application.name=tyh-demo-prop# 開發(fā)環(huán)境端口server.port=10001
3、application-test.properties測試環(huán)境(以下是配置內(nèi)容)
spring.application.name=tyh-demo-prop# 測試環(huán)境端口server.port=10002
4、application-prod.properties生產(chǎn)環(huán)境(以下是配置內(nèi)容)
spring.application.name=tyh-demo-prop# 生產(chǎn)環(huán)境端口server.port=10003
更改主配置中的spring.profiles.active=dev這個參數(shù)就可以切換不同子配置文件了
由于此方法.properties文件依然在jar中,我們修改時并不方便,而且太多信息暴露在開發(fā)中容易泄露,所以結合方法二進行使用
三、方法二jar包外部配置文件我們在開發(fā)完成發(fā)布生產(chǎn)環(huán)境時往往都會修改一下配置文件的相關內(nèi)容,而默認.properties配置文件會被封裝到jar包中修改起來不方便,所以spring boot給了幾個讀取配置文件的位置,我們可以通過這個方式去從jar包外部修改配置文件
一般我們會將.properties放在resources文件夾內(nèi)
spring boot會按以下順序去尋找配置文件
1、“當前目錄”的/config文件夾下
2、“當前目錄”下
3、classpath的/config文件夾下
4、classpath下
以下是圖例解釋:
當找到配置文件后將不會再繼續(xù)尋找,也就說該文件優(yōu)先級以下的配置文件將不會被讀取,找到即停止
“當前目錄”指的是我們打成可執(zhí)行jar包后,一般會用bat文件來啟動,這個當前目錄指的就是bat文件的目錄
我們常規(guī)存放的位置就是優(yōu)先級最低的位置,所以我們只需要再單獨拷貝一份配置文件,放在bat的“當前目錄”即可
四、配置項加密我們的application.properties文件中會有很多敏感信息,如:數(shù)據(jù)庫連接、緩存服務器連接等等,這些用戶名密碼都應該是外部不可見的,所以最好將其加密后存儲
我們使用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-propserver.port=10001# 配置文件項加解密密碼,此處注釋,而放在代碼中(放在代碼中使加密密鑰和密文分開)#jasypt.encryptor.password=112233# 模擬數(shù)據(jù)庫連接帳號密碼spring.datasource.username=ENC(nm3F96GtUIwZUHzsP0Mp1A==)spring.datasource.password=ENC(lmn7lAlePy1hZu505WO0xQ==)
3、程序啟動類,默認jasypt的密鑰是放在配置文件中但這樣會導致密文和密鑰都在配置文件中,所以我把密鑰放在程序中
@SpringBootApplicationpublic 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;@Componentpublic class SysConfig { @Value('${spring.datasource.username}') private String dbUsername; @Value('${spring.datasource.password}') private String dbPassword;//自己生成get set方法}
5、編寫controller及action來調(diào)用一下
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加密方式,所以每次加密出來的結果都不一樣,所以很適合對數(shù)據(jù)進行加密
運行后,可以看到自動解密的配置項
我們有很多編碼需求需要使用.properties文件中自定義的配置項,傳統(tǒng)使用Properties對象來操作,類似如下代碼,
這種方式太過靈活我們不想使用的配置項可能也會被提取出來,而且當我們不想使用jar包內(nèi)的配置文件,而是利用優(yōu)先級使用外部的,這種直接讀取的方式就很不方便,所以推薦使用@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-propserver.port=10001# 配置文件項加解密密碼,此處注釋,而放在代碼中(放在代碼中使加密密鑰和密文分開)#jasypt.encryptor.password=112233# 模擬數(shù)據(jù)庫連接帳號密碼spring.datasource.username=ENC(nm3F96GtUIwZUHzsP0Mp1A==)spring.datasource.password=ENC(lmn7lAlePy1hZu505WO0xQ==)# 模擬其他自定義配置項#tyh.url.web.admin=http://www.admin.comtyh.url.web.agent=http://www.agent.com
2、@Value注入可以給靜態(tài)屬性也可以給非靜態(tài)屬性,具體根據(jù)使用場景自行決定,如果配置項可能不存在也可以設置默認值,避免程序無法啟動
@Componentpublic class SysConfig { @Value('${spring.datasource.username}') private String dbUsername; @Value('${spring.datasource.password}') private String dbPassword; /* 非靜態(tài)屬性注入(注入屬性) */ //@Value的參數(shù)代表配置項的key,如果沒有啟動會報錯,加上“:”為其設置默認值即可解決冒號后面的就是默認值內(nèi)容,也可以直接:冒號后面空白就是空 @Value('${tyh.url.web.admin:www.abc.com}') private String urlAdmin; //###自己創(chuàng)建get/set方法### /* 靜態(tài)屬性注入(注入set()方法) */ //使用@Component把當前類當作組件啟動時注入該靜態(tài)屬性值,靜態(tài)屬性注入set()方法 public static String urlAgent; @Value('${tyh.url.web.agent:}') private void setUrlAgent(String urlAgent) {SysConfig.urlAgent = urlAgent; }}
3、使用時非靜態(tài)屬性使用Autowired注入,靜態(tài)屬性直接取值
//非靜態(tài)屬性注入取值(必須使用Autowired注入) @Autowired SysConfig sysConfig; public void test() {//靜態(tài)屬性注入取值(直接獲取)String str = SysConfig.urlAgent; }
推薦使用@Value來注入配置項進行使用,便與后續(xù)接入Apollo等配置管理中心進行配置統(tǒng)一管理
到此這篇關于spring boot項目application.properties文件存放及使用介紹的文章就介紹到這了,更多相關spring boot application.properties文件內(nèi)容請搜索好吧啦網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持好吧啦網(wǎng)!
相關文章:
1. Android 實現(xiàn)徹底退出自己APP 并殺掉所有相關的進程2. Vue實現(xiàn)仿iPhone懸浮球的示例代碼3. vue使用moment如何將時間戳轉(zhuǎn)為標準日期時間格式4. 一個 2 年 Android 開發(fā)者的 18 條忠告5. js select支持手動輸入功能實現(xiàn)代碼6. Spring的異常重試框架Spring Retry簡單配置操作7. Android studio 解決logcat無過濾工具欄的操作8. 什么是Python變量作用域9. PHP正則表達式函數(shù)preg_replace用法實例分析10. vue-drag-chart 拖動/縮放圖表組件的實例代碼
