對 Spring 里面的 Properties 不理解的開發(fā)者可能會覺得有點亂,主要是因為配置方式很多種,使用方式也很多種。
成都創(chuàng)新互聯(lián)主營渾江網(wǎng)站建設(shè)的網(wǎng)絡(luò)公司,主營網(wǎng)站建設(shè)方案,APP應(yīng)用開發(fā),渾江h(huán)5成都小程序開發(fā)搭建,渾江網(wǎng)站營銷推廣歡迎渾江等地區(qū)企業(yè)咨詢
本文不是原理分析、源碼分析文章,只是希望可以幫助讀者更好地理解和使用 Spring Properties。
Properties 的使用
本文的讀者都是使用過 Spring 的,先來看看 Properties 是怎么使用的,Spring 中常用的有以下幾種使用方式:
1. 在 xml 配置文件中使用
即自動替換 ${} 里面的值。
2. 通過 @Value 注入使用
@Value("${javadoop.jdbc.url}") private String url;
3. 通過 Environment 獲取
此法有需要注意的地方。并不是所有的配置方式都支持通過 Environment 接口來獲取屬性值,親測只有使用注解 @PropertySource 的時候可以用,否則會得到 null,至于怎么配置,下面馬上就會說。
@Autowired private Environment env; public String getUrl() { return env.getProperty("javadoop.jdbc.url"); }
如果是 Spring Boot 的 application.properties 注冊的,那也是可以的。
Properties 配置
前面我們說了怎么使用我們配置的 Properties,那么該怎么配置呢?Spring 提供了很多種配置方式。
1. 通過 xml 配置
下面這個是最常用的配置方式了,很多項目都是這么寫的:
2. 通過 @PropertySource 配置
前面的通過 xml 配置非常常用,但是如果你也有一種要消滅所有 xml 配置文件的沖動的話,你應(yīng)該使用以下方式:
@PropertySource("classpath:sys.properties") @Configuration public class JavaDoopConfig { }
注意一點,@PropertySource 在這里必須搭配 @Configuration 來使用,具體不展開說了。
3. PropertyPlaceholderConfigurer
如果讀者見過這個,也不必覺得奇怪,在 Spring 3.1 之前,經(jīng)常就是這么使用的:
classpath:sys.properties
當(dāng)然,我們也可以用相應(yīng)的 java configuration 的版本:
@Bean public PropertyPlaceholderConfigurer propertiess() { PropertyPlaceholderConfigurer ppc = new PropertyPlaceholderConfigurer(); Resource[] resources = new ClassPathResource[]{new ClassPathResource("sys.properties")}; ppc.setLocations(resources); ppc.setIgnoreUnresolvablePlaceholders(true); return ppc; }
4. PropertySourcesPlaceholderConfigurer
到了 Spring 3.1 的時候,引入了 PropertySourcesPlaceholderConfigurer,這是一個新的類,注意看和之前的 PropertyPlaceholderConfigurer 在名字上多了一個 Sources,所屬的包也不一樣,它在 Spring-Context 包中。
在配置上倒是沒有什么區(qū)別:
classpath:sys.properties
也來一個 java configuration 版本吧:
@Bean public PropertySourcesPlaceholderConfigurer properties() { PropertySourcesPlaceholderConfigurer pspc = new PropertySourcesPlaceholderConfigurer(); Resource[] resources = new ClassPathResource[]{new ClassPathResource("sys.properties")}; pspc.setLocations(resources); pspc.setIgnoreUnresolvablePlaceholders(true); return pspc; }
Spring Boot 相關(guān)
Spring Boot 真的是好東西,開箱即用的感覺實在是太好了。這里簡單介紹下相關(guān)的內(nèi)容。
快速生成一個 Spring Boot 項目: https://start.spring.io/
application.properties
我們每個項目都默認(rèn)有一個 application.properties 文件,這個配置文件不需要像前面說的那樣進(jìn)行 注冊 ,Spring Boot 會幫我們自動注冊。
當(dāng)然,也許你想換個名字也是可以的,在啟動的時候指定你的文件名字就可以了:
java -Dspring.config.location=classpath:sys.properties -jar app.jar
application-{env}.properties
為了給不同的環(huán)境指定不同的配置,我們會用到這個。
比如測試環(huán)境和生產(chǎn)環(huán)境的數(shù)據(jù)庫連接信息就不一樣。
所以,在 application.properties 的基礎(chǔ)上,我們還需要新建 application-dev.properties 和 application-prd.properties,用于配置環(huán)境相關(guān)的信息,然后啟動的時候指定環(huán)境。
java -Dspring.profiles.active=prd -jar app.jar
結(jié)果就是,application.properties 和 application-prd.properties 兩個文件中的配置都會注冊進(jìn)去,如果有重復(fù)的 key,application-prd.properties 文件中的優(yōu)先級較高。
@ConfigurationProperties
這個注解是 Spring Boot 中才有的。
即使大家不使用這個注解,大家也可能會在開源項目中看到這個,這里簡單介紹下。
來一個例子直觀一些。按照之前說的,在配置文件中填入下面的信息,你可以選擇寫入 application.properties 也可以用第一節(jié)介紹的方法。
javadoop.database.url=jdbc:MySQL: javadoop.database.username=admin javadoop.database.password=admin123456
java 文件:
@Configuration @ConfigurationProperties(prefix = "javadoop.database") public class DataBase { String url; String username; String password; // getters and setters }
這樣,就在 Spring 的容器中就自動注冊了一個類型為 DataBase 的 bean 了,而且屬性都已經(jīng) set 好了。
在啟動過程中動態(tài)修改屬性值
這個我覺得都不需要太多介紹,用 Spring Boot 的應(yīng)該基本上都知道。
屬性配置有個覆蓋順序,也就是當(dāng)出現(xiàn)相同的 key 的時候,以哪里的值為準(zhǔn)。
啟動參數(shù) > application-{env}.properties > application.properties
啟動參數(shù)動態(tài)設(shè)置屬性:
java -Djavadoop.database.password=admin4321 -jar app.jar
另外,還可以利用系統(tǒng)環(huán)境變量設(shè)置屬性,還可以指定隨機(jī)數(shù)等等,確實很靈活,不過沒什么用,就不介紹了。
總結(jié)
讀者如果想要更加深入地了解 Spring 的 Properties,需要去理解 Spring 的 Environment 接口相關(guān)的源碼。建議感興趣的讀者去翻翻源代碼看看。
以上就是本文的全部內(nèi)容,希望對大家的學(xué)習(xí)有所幫助,也希望大家多多支持創(chuàng)新互聯(lián)。