spring boot項(xiàng)目application.properties文件存放及使用介紹
我們一般都會(huì)有多個(gè)應(yīng)用環(huán)境,開發(fā)環(huán)境、測(cè)試環(huán)境、生產(chǎn)環(huán)境,各個(gè)環(huán)境的配置會(huì)略有不同,我可以根據(jù)這個(gè)創(chuàng)建多份配置文件,由主配置文件來(lái)控制讀取那個(gè)子配置
創(chuàng)建spring boot項(xiàng)目后可以同時(shí)創(chuàng)建多個(gè).properties文件,只要符合它要求的格式即可
格式:application-{profile}.properties;{profile}是變量用于自定義配置文件名稱
分別創(chuàng)建三個(gè)應(yīng)用環(huán)境的配置和一個(gè)主配置
1、application.properties主配置(以下是配置內(nèi)容,這里的dev就是其他配置文件的標(biāo)識(shí)名dev、test、prod)
# 具體使用那個(gè)配置文件的標(biāo)識(shí)名稱(格式: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測(cè)試環(huán)境(以下是配置內(nèi)容)
spring.application.name=tyh-demo-prop# 測(cè)試環(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這個(gè)參數(shù)就可以切換不同子配置文件了
由于此方法.properties文件依然在jar中,我們修改時(shí)并不方便,而且太多信息暴露在開發(fā)中容易泄露,所以結(jié)合方法二進(jìn)行使用
三、方法二jar包外部配置文件我們?cè)陂_發(fā)完成發(fā)布生產(chǎn)環(huán)境時(shí)往往都會(huì)修改一下配置文件的相關(guān)內(nèi)容,而默認(rèn).properties配置文件會(huì)被封裝到j(luò)ar包中修改起來(lái)不方便,所以spring boot給了幾個(gè)讀取配置文件的位置,我們可以通過(guò)這個(gè)方式去從jar包外部修改配置文件
一般我們會(huì)將.properties放在resources文件夾內(nèi)
spring boot會(huì)按以下順序去尋找配置文件
1、“當(dāng)前目錄”的/config文件夾下
2、“當(dāng)前目錄”下
3、classpath的/config文件夾下
4、classpath下
以下是圖例解釋:
當(dāng)找到配置文件后將不會(huì)再繼續(xù)尋找,也就說(shuō)該文件優(yōu)先級(jí)以下的配置文件將不會(huì)被讀取,找到即停止
“當(dāng)前目錄”指的是我們打成可執(zhí)行jar包后,一般會(huì)用bat文件來(lái)啟動(dòng),這個(gè)當(dāng)前目錄指的就是bat文件的目錄
我們常規(guī)存放的位置就是優(yōu)先級(jí)最低的位置,所以我們只需要再單獨(dú)拷貝一份配置文件,放在bat的“當(dāng)前目錄”即可
四、配置項(xiàng)加密我們的application.properties文件中會(huì)有很多敏感信息,如:數(shù)據(jù)庫(kù)連接、緩存服務(wù)器連接等等,這些用戶名密碼都應(yīng)該是外部不可見的,所以最好將其加密后存儲(chǔ)
我們使用jasypt來(lái)進(jìn)行加解密,首先先建立項(xiàng)目,我搭建了spring boot項(xiàng)目
1、添加pom.xml信息
<!-- 配置文件項(xiàng)加密 --><dependency> <groupId>com.github.ulisesbocchio</groupId> <artifactId>jasypt-spring-boot-starter</artifactId> <version>2.1.0</version></dependency>
2、在application.properties文件中增加配置項(xiàng),需要jasypt來(lái)解密的密文需要用“ENC(......)”括起來(lái)
spring.application.name=tyh-demo-propserver.port=10001# 配置文件項(xiàng)加解密密碼,此處注釋,而放在代碼中(放在代碼中使加密密鑰和密文分開)#jasypt.encryptor.password=112233# 模擬數(shù)據(jù)庫(kù)連接帳號(hào)密碼spring.datasource.username=ENC(nm3F96GtUIwZUHzsP0Mp1A==)spring.datasource.password=ENC(lmn7lAlePy1hZu505WO0xQ==)
3、程序啟動(dòng)類,默認(rèn)jasypt的密鑰是放在配置文件中但這樣會(huì)導(dǎo)致密文和密鑰都在配置文件中,所以我把密鑰放在程序中
@SpringBootApplicationpublic class App { public static void main(String[] args) {//設(shè)置配置文件項(xiàng)加密密鑰(放在這里使加密密鑰和密文分開)System.setProperty('jasypt.encryptor.password', '112233');SpringApplication.run(App.class, args); }}
4、使用注解的方式來(lái)注入配置文件中的配置項(xiàng)
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來(lái)調(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自動(dòng)注入就會(huì)將密文解密return sysConfig; }}
由于其使用的是PBEWithMD5AndDES加密方式,所以每次加密出來(lái)的結(jié)果都不一樣,所以很適合對(duì)數(shù)據(jù)進(jìn)行加密
運(yùn)行后,可以看到自動(dòng)解密的配置項(xiàng)
我們有很多編碼需求需要使用.properties文件中自定義的配置項(xiàng),傳統(tǒng)使用Properties對(duì)象來(lái)操作,類似如下代碼,
這種方式太過(guò)靈活我們不想使用的配置項(xiàng)可能也會(huì)被提取出來(lái),而且當(dāng)我們不想使用jar包內(nèi)的配置文件,而是利用優(yōu)先級(jí)使用外部的,這種直接讀取的方式就很不方便,所以推薦使用@Value的方式來(lái)使用
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); }}
還是剛才的項(xiàng)目,使用@Value來(lái)注入想讓程序使用的配置項(xiàng),而不想讓程序使用的就不注入,這樣來(lái)使配置項(xiàng)可控
1、我們?cè)?properties文件中增加兩個(gè)自定義配置項(xiàng)
spring.application.name=tyh-demo-propserver.port=10001# 配置文件項(xiàng)加解密密碼,此處注釋,而放在代碼中(放在代碼中使加密密鑰和密文分開)#jasypt.encryptor.password=112233# 模擬數(shù)據(jù)庫(kù)連接帳號(hào)密碼spring.datasource.username=ENC(nm3F96GtUIwZUHzsP0Mp1A==)spring.datasource.password=ENC(lmn7lAlePy1hZu505WO0xQ==)# 模擬其他自定義配置項(xiàng)#tyh.url.web.admin=http://www.admin.comtyh.url.web.agent=http://www.agent.com
2、@Value注入可以給靜態(tài)屬性也可以給非靜態(tài)屬性,具體根據(jù)使用場(chǎng)景自行決定,如果配置項(xiàng)可能不存在也可以設(shè)置默認(rèn)值,避免程序無(wú)法啟動(dòng)
@Componentpublic class SysConfig { @Value('${spring.datasource.username}') private String dbUsername; @Value('${spring.datasource.password}') private String dbPassword; /* 非靜態(tài)屬性注入(注入屬性) */ //@Value的參數(shù)代表配置項(xiàng)的key,如果沒(méi)有啟動(dòng)會(huì)報(bào)錯(cuò),加上“:”為其設(shè)置默認(rèn)值即可解決冒號(hào)后面的就是默認(rèn)值內(nèi)容,也可以直接:冒號(hào)后面空白就是空 @Value('${tyh.url.web.admin:www.abc.com}') private String urlAdmin; //###自己創(chuàng)建get/set方法### /* 靜態(tài)屬性注入(注入set()方法) */ //使用@Component把當(dāng)前類當(dāng)作組件啟動(dòng)時(shí)注入該靜態(tài)屬性值,靜態(tài)屬性注入set()方法 public static String urlAgent; @Value('${tyh.url.web.agent:}') private void setUrlAgent(String urlAgent) {SysConfig.urlAgent = urlAgent; }}
3、使用時(shí)非靜態(tài)屬性使用Autowired注入,靜態(tài)屬性直接取值
//非靜態(tài)屬性注入取值(必須使用Autowired注入) @Autowired SysConfig sysConfig; public void test() {//靜態(tài)屬性注入取值(直接獲取)String str = SysConfig.urlAgent; }
推薦使用@Value來(lái)注入配置項(xiàng)進(jìn)行使用,便與后續(xù)接入Apollo等配置管理中心進(jìn)行配置統(tǒng)一管理
到此這篇關(guān)于spring boot項(xiàng)目application.properties文件存放及使用介紹的文章就介紹到這了,更多相關(guān)spring boot application.properties文件內(nèi)容請(qǐng)搜索好吧啦網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持好吧啦網(wǎng)!
相關(guān)文章:
1. asp(vbs)Rs.Open和Conn.Execute的詳解和區(qū)別及&H0001的說(shuō)明2. 利用promise及參數(shù)解構(gòu)封裝ajax請(qǐng)求的方法3. 解決AJAX返回狀態(tài)200沒(méi)有調(diào)用success的問(wèn)題4. PHP設(shè)計(jì)模式中工廠模式深入詳解5. ThinkPHP5實(shí)現(xiàn)JWT Token認(rèn)證的過(guò)程(親測(cè)可用)6. .NET中l(wèi)ambda表達(dá)式合并問(wèn)題及解決方法7. ASP 信息提示函數(shù)并作返回或者轉(zhuǎn)向8. JSP數(shù)據(jù)交互實(shí)現(xiàn)過(guò)程解析9. Ajax實(shí)現(xiàn)表格中信息不刷新頁(yè)面進(jìn)行更新數(shù)據(jù)10. CSS hack用法案例詳解
