自定義屬性與加載
我們在使用Spring Boot的時(shí)候退客,通常也需要定義一些自己使用的屬性冠跷,我們可以如下方式直接定義:在src/main/resources/application.properties:加入:
#自定義屬性.
com.xwork.system.name=david
com.xwork.system.title=demoshow
然后通過@Value("${屬性名}")注解來加載對應(yīng)的配置屬性,具體如下:
(這種方式已經(jīng)不推薦使用了,但能正常運(yùn)行)
@Component
public class SystemProperties {
@Value("${com.xwork.system.name}")
private String name;//系統(tǒng)名稱
@Value("${com.xwork.system.title}")
private String title;//系統(tǒng)標(biāo)題
// 省略getter和setter
}
通過單元測試來驗(yàn)證BlogProperties中的屬性是否已經(jīng)根據(jù)配置文件加載了虏辫。
引入單元測試依賴:
<!-- spring boot 單元測試. -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
進(jìn)行編碼進(jìn)行單元測試:
package com.xwork;
import org.junit.Assert;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.SpringApplicationConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
import com.xwork.properties.SystemProperties;
/**
*
* @version v.0.1
*/
@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(App.class)
public class AppTest{
@Autowired
private SystemProperties systemProperties;
@Test
public void testBlog() throws Exception {
System.out.println("AppTest.testSystem()="+systemProperties);
Assert.assertEquals("david",systemProperties.getName());
Assert.assertEquals("demoshow", systemProperties.getTitle());
}
}
運(yùn)行單元測試疤苹,完美的看到我們想要的結(jié)果了赶舆,但是我們剛剛提到了SystemProperties寫法已經(jīng)不推薦使用了信峻,那么怎么寫會(huì)比較perfect呢倦青?看如下優(yōu)雅的編碼風(fēng)格:
先引入spring boot提供的一個(gè)配置依賴:
<!--spring boot 配置處理器 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>
在這里我們主要使用@ConfigurationProperties注解進(jìn)行編碼,
修改BlogProperties為:
/**
* prefix="com.system.blog" :
*
* 在application.properties配置的屬性前綴盹舞,
*
* 在類中的屬性就不用使用{@value}進(jìn)行注入了产镐。
*
* @version v.0.1
*/
@ConfigurationProperties(prefix="com.system.blog")
public class BlogProperties {
private String name;//博客作者
private String title;//博客標(biāo)題
// 省略getter和setter
}
在啟動(dòng)類中加入:
@EnableConfigurationProperties({SystemProperties.class})
在運(yùn)行單元測試還是能夠正常進(jìn)行的。
這種的好處就是只需要配置一個(gè)地方矾策,其它地方就是正常定義類的屬性即可了。
參數(shù)間引用
在application.properties中的各個(gè)參數(shù)之間也可以直接引用來使用峭沦,就像下面的設(shè)置:
com.xwork.system.desc=${com.xwork.system.name}正在寫《${com.xwork.system.title}》
com.xwork.system.desc參數(shù)引用了上文中定義的name和title屬性贾虽,最后該屬性的值就是Angel正在努力寫《Spring Boot教程》。
使用隨機(jī)數(shù)
在一些情況下吼鱼,有些參數(shù)我們需要希望它不是一個(gè)固定的值蓬豁,比如密鑰绰咽、服務(wù)端口等。Spring Boot的屬性配置文件中可以通過${random}來產(chǎn)生int值地粪、long值或者string字符串取募,來支持屬性的隨機(jī)值。
# 隨機(jī)字符串
com.xwork.system.value=${random.value}
# 隨機(jī)int
com.xwork.system.number=${random.int}
# 隨機(jī)long
com.xwork.system.bignumber=${random.long}
# 10以內(nèi)的隨機(jī)數(shù)
com.xwork.system.test1=${random.int(10)}
# 10-20的隨機(jī)數(shù)
com.xwork.system.test2=${random.int[10,20]}
通過命令行設(shè)置屬性值
相信使用過一段時(shí)間Spring Boot的用戶蟆技,一定知道這條命令:java -jar xxx.jar --server.port=8888玩敏,通過使用--server.port屬性來設(shè)置xxx.jar應(yīng)用的端口為8888。
在命令行運(yùn)行時(shí)质礼,連續(xù)的兩個(gè)減號--就是對application.properties中的屬性值進(jìn)行賦值的標(biāo)識旺聚。所以,java -jar xxx.jar --server.port=8888命令眶蕉,等價(jià)于我們在application.properties中添加屬性server.port=8888砰粹,該設(shè)置在樣例工程中可見,讀者可通過刪除該值或使用命令行來設(shè)置該值來驗(yàn)證造挽。
通過命令行來修改屬性值固然提供了不錯(cuò)的便利性碱璃,但是通過命令行就能更改應(yīng)用運(yùn)行的參數(shù),那豈不是很不安全饭入?是的嵌器,所以Spring Boot也貼心的提供了屏蔽命令行訪問屬性的設(shè)置,只需要這句設(shè)置就能屏蔽:SpringApplication.setAddCommandLineProperties(false)圣拄。
多環(huán)境配置
以上都不是重點(diǎn)嘴秸,這才是重點(diǎn),這才是重點(diǎn)庇谆,這才是重點(diǎn)岳掐,重要的事情說3遍。我們在開發(fā)Spring Boot應(yīng)用時(shí)饭耳,通常同一套程序會(huì)被應(yīng)用和安裝到幾個(gè)不同的環(huán)境串述,比如:開發(fā)、測試寞肖、生產(chǎn)等纲酗。其中每個(gè)環(huán)境的數(shù)據(jù)庫地址、服務(wù)器端口等等配置都會(huì)不同新蟆,如果在為不同環(huán)境打包時(shí)都要頻繁修改配置文件的話觅赊,那必將是個(gè)非常繁瑣且容易發(fā)生錯(cuò)誤的事。
對于多環(huán)境的配置琼稻,各種項(xiàng)目構(gòu)建工具或是框架的基本思路是一致的吮螺,通過配置多份不同環(huán)境的配置文件,再通過打包命令指定需要打包的內(nèi)容之后進(jìn)行區(qū)分打包,Spring Boot也不例外鸠补,或者說更加簡單萝风。
在Spring Boot中多環(huán)境配置文件名需要滿足application-{profile}.properties的格式,其中{profile}對應(yīng)你的環(huán)境標(biāo)識紫岩,比如:
application-dev.properties: 開發(fā)環(huán)境
application-test.properties: 測試環(huán)境
application-prod.properties:生產(chǎn)環(huán)境
至于哪個(gè)具體的配置文件會(huì)被加載规惰,需要在application.properties文件中通過spring.profiles.active屬性來設(shè)置,其值對應(yīng){profile}值泉蝌。
如:spring.profiles.active=test就會(huì)加載application-test.properties配置文件內(nèi)容下面歇万,以不同環(huán)境配置不同的服務(wù)端口為例,進(jìn)行樣例實(shí)驗(yàn)梨与。
針對各環(huán)境新建不同的配置文件application-dev.properties堕花、application-test.properties、application-prod.properties
在這三個(gè)文件均都設(shè)置不同的server.port屬性粥鞋,如:dev環(huán)境設(shè)置為8080缘挽,test環(huán)境設(shè)置為9090,prod環(huán)境設(shè)置為80
application.properties中設(shè)置spring.profiles.active=dev呻粹,就是說默認(rèn)以dev環(huán)境設(shè)置
測試不同配置的加載:
執(zhí)行java -jar xxx.jar壕曼,可以觀察到服務(wù)端口被設(shè)置為8080,也就是默認(rèn)的開發(fā)環(huán)境(dev)
執(zhí)行java -jar xxx.jar --spring.profiles.active=test等浊,可以觀察到服務(wù)端口被設(shè)置為9090腮郊,也就是測試環(huán)境的配置(test)
執(zhí)行java -jar xxx.jar --spring.profiles.active=prod,可以觀察到服務(wù)端口被設(shè)置為80筹燕,也就是生產(chǎn)環(huán)境的配置(prod)
按照上面的實(shí)驗(yàn)轧飞,可以如下總結(jié)多環(huán)境的配置思路:
application.properties中配置通用內(nèi)容,并設(shè)置spring.profiles.active=dev撒踪,以開發(fā)環(huán)境為默認(rèn)配置
application-{profile}.properties中配置各個(gè)環(huán)境不同的內(nèi)容
通過命令行方式去激活不同環(huán)境的配置过咬。
多環(huán)境高級應(yīng)用
在某些情況下,應(yīng)用的某些業(yè)務(wù)邏輯可能需要有不同的實(shí)現(xiàn)制妄。例如郵件服務(wù)掸绞,假設(shè)EmailService中包含的send(String email)方法向指定地址發(fā)送電子郵件,但是我們僅僅希望在生產(chǎn)環(huán)境中才執(zhí)行真正發(fā)送郵件的代碼耕捞,而開發(fā)環(huán)境里則不發(fā)送以免向用戶發(fā)送無意義的垃圾郵件衔掸。
我們可以借助Spring的注解@Profile實(shí)現(xiàn)這樣的功能,這樣需要定義兩個(gè)實(shí)現(xiàn)EmailService接口的類:
/**
* 發(fā)送郵件接口.
* @version v.0.1
*/
public interface EmailService {
/**發(fā)送郵件*/
publicvoid send();
}
發(fā)送郵件的具體實(shí)現(xiàn)(dev-開發(fā)環(huán)境的代碼):
@Service
@Profile("dev") //開發(fā)環(huán)境的時(shí)候.
public class DevEmailServiceImpl implements EmailService{
@Override
publicvoid send() {
System.out.println("DevEmailServiceImpl.send().開發(fā)環(huán)境不執(zhí)行郵件的發(fā)送.");
}
}
發(fā)送郵件的具體實(shí)現(xiàn)(prod-生產(chǎn)環(huán)境的代碼):
@Service
@Profile("prod") //生產(chǎn)環(huán)境.
public class ProdEmailServiceImpl2 implements EmailService{
@Override
publicvoid send() {
System.out.println("DevEmailServiceImpl.send().生產(chǎn)環(huán)境執(zhí)行郵件的發(fā)送.");
//具體的郵件發(fā)送代碼.
//mail.send();
}
}
@Profile("dev")表明只有Spring定義的Profile為dev時(shí)才會(huì)實(shí)例化DevEmailService這個(gè)類俺抽。那么如何設(shè)置Profile呢敞映?
在配置文件中指定
在application.properties中加入:
spring.profiles.active=dev
通過命令行參數(shù)
java -jar app.jar --spring.profiles.active=dev