背景
很多時(shí)候荣倾,我們項(xiàng)目在開(kāi)發(fā)環(huán)境和生成環(huán)境的環(huán)境配置是不一樣的,例如骑丸,數(shù)據(jù)庫(kù)配置舌仍,在開(kāi)發(fā)的時(shí)候,我們一般用測(cè)試數(shù)據(jù)庫(kù)通危,而在生產(chǎn)環(huán)境的時(shí)候铸豁,我們是用正式的數(shù)據(jù),這時(shí)候菊碟,我們可以利用profile在不同的環(huán)境下配置用不同的配置文件或者不同的配置节芥。
spring boot 提供
spring boot允許你通過(guò)命名約定按照一定的格式(application-{profile}.properties)來(lái)定義多個(gè)配置文件,然后通過(guò)在application.properyies通過(guò)spring.profiles.active來(lái)具體激活一個(gè)或者多個(gè)配置文件逆害,如果沒(méi)有沒(méi)有指定任何profile的配置文件的話(huà)头镊,spring boot默認(rèn)會(huì)啟動(dòng)application-default.properties。
profile的配置文件可以按照application.properyies的放置位置一樣魄幕,放于以下四個(gè)位置:
當(dāng)前目錄的 “/config”的子目錄下
當(dāng)前目錄下
classpath根目錄的“/config”包下
classpath的根目錄下
demo 演示
在這里我們就定義倆個(gè)profile文件相艇,
application-sit.properties和application-prd.properties,
并在倆個(gè)文件中都分別
寫(xiě)上變量
我們?cè)赼pplication.properyies也寫(xiě)上纯陨,并把profile切換到application-sit.properties的配置文件
我們?cè)赼pplication.properyies也寫(xiě)上坛芽,并把profile切換到application-sit.properties的配置文件
#修改tomcat的默認(rèn)的端口號(hào),將8080改為8889
server.port=8889
#啟用shutdown endpoint的HTTP訪問(wèn)
endpoints.shutdown.enabled=true
#不需要用戶(hù)名密碼驗(yàn)證
endpoints.shutdown.sensitive=false
#默認(rèn)curvar值
curvar=default.curvar
#切換配置文件
spring.profiles.active=sit
可以通過(guò)這樣子來(lái)測(cè)試
package HelloWord;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
@RequestMapping("/task")
public class TaskController {
? ? @RequestMapping(value = {"/",""})
? ? public String hellTask(@Value("${curvar}")String cusvar ){
? ? ? ? return "hello task !! my current variable is " + cusvar;
? ? }
}
分別定義倆個(gè)實(shí)現(xiàn)類(lèi)來(lái)實(shí)現(xiàn)它
package config;
import org.springframework.context.annotation.Profile;
import org.springframework.stereotype.Component;
/**
* 測(cè)試數(shù)據(jù)庫(kù)
*/
@Component
@Profile("sitdb")
public class SitDBConnector implements DBConnector {
? ? @Override
? ? public void configure() {
? ? ? ? System.out.println("sit-db");
? ? }
}
package config;
import org.springframework.context.annotation.Profile;
import org.springframework.stereotype.Component;
/**
* 生產(chǎn)數(shù)據(jù)庫(kù)
*/
@Component
@Profile("prddb")
public class PrdDBConnector implements DBConnector {
? ? @Override
? ? public void configure() {
? ? ? ? System.out.println("prd-db");
? ? }
}
通過(guò)在配置文件激活具體使用哪個(gè)實(shí)現(xiàn)類(lèi)
#修改tomcat的默認(rèn)的端口號(hào)翼抠,將8080改為8889
server.port=8889
#啟用shutdown endpoint的HTTP訪問(wèn)
endpoints.shutdown.enabled=true
#不需要用戶(hù)名密碼驗(yàn)證
endpoints.shutdown.sensitive=false
#默認(rèn)curvar值
curvar=default.curvar
#切換配置文件
#修改tomcat的默認(rèn)的端口號(hào)靡馁,將8080改為8889
server.port=8889
#啟用shutdown endpoint的HTTP訪問(wèn)
endpoints.shutdown.enabled=true
#不需要用戶(hù)名密碼驗(yàn)證
endpoints.shutdown.sensitive=false
#默認(rèn)curvar值
curvar=default.curvar
#切換配置文件
spring.profiles.active=sitdb
然后就可以這么使用
package HelloWord;
import config.DBConnector;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.web.bind.annotation.RequestMapping;
? ? ? ? import org.springframework.web.bind.annotation.RestController;
@RestController
@RequestMapping("/task")
@ComponentScan(basePackages={"config"})
public class TaskController {
? ? @Autowired DBConnector connector;
? ? @RequestMapping(value = {"/",""})
? ? public String hellTask(@Value("${curvar}")String cusvar ){
? ? ? ? connector.configure();//最終打印配置的db
? ? ? ? return "hello task !! my current variable is " + cusvar;
? ? }
}
以上就是spring boot用profile的作用。
以下為可選(主要是命令行使用):
通過(guò)命令行設(shè)置屬性值
相信使用過(guò)一段時(shí)間Spring Boot的用戶(hù)机久,一定知道這條命令:java -jar xxx.jar --server.port=8888臭墨,通過(guò)使用–server.port屬性來(lái)設(shè)置xxx.jar應(yīng)用的端口為8888。
在命令行運(yùn)行時(shí)膘盖,連續(xù)的兩個(gè)減號(hào)–就是對(duì)application.properties中的屬性值進(jìn)行賦值的標(biāo)識(shí)胧弛。所以尤误,java -jar xxx.jar --server.port=8888命令,等價(jià)于我們?cè)赼pplication.properties中添加屬性server.port=8888结缚,該設(shè)置在樣例工程中可見(jiàn)损晤,讀者可通過(guò)刪除該值或使用命令行來(lái)設(shè)置該值來(lái)驗(yàn)證。
通過(guò)命令行來(lái)修改屬性值固然提供了不錯(cuò)的便利性红竭,但是通過(guò)命令行就能更改應(yīng)用運(yùn)行的參數(shù)尤勋,那豈不是很不安全?是的茵宪,所以Spring Boot也貼心的提供了屏蔽命令行訪問(wèn)屬性的設(shè)置最冰,只需要這句設(shè)置就能屏蔽:SpringApplication.setAddCommandLineProperties(false)。
多環(huán)境配置
以上都不是重點(diǎn)稀火,這才是重點(diǎn)暖哨,這才是重點(diǎn),這才是重點(diǎn)凰狞,重要的事情說(shuō)3遍篇裁。我們?cè)陂_(kāi)發(fā)Spring Boot應(yīng)用時(shí),通常同一套程序會(huì)被應(yīng)用和安裝到幾個(gè)不同的環(huán)境赡若,比如:開(kāi)發(fā)达布、測(cè)試、生產(chǎn)等逾冬。其中每個(gè)環(huán)境的數(shù)據(jù)庫(kù)地址往枣、服務(wù)器端口等等配置都會(huì)不同,如果在為不同環(huán)境打包時(shí)都要頻繁修改配置文件的話(huà)粉渠,那必將是個(gè)非常繁瑣且容易發(fā)生錯(cuò)誤的事分冈。
對(duì)于多環(huán)境的配置,各種項(xiàng)目構(gòu)建工具或是框架的基本思路是一致的霸株,通過(guò)配置多份不同環(huán)境的配置文件雕沉,再通過(guò)打包命令指定需要打包的內(nèi)容之后進(jìn)行區(qū)分打包,Spring Boot也不例外去件,或者說(shuō)更加簡(jiǎn)單坡椒。
在Spring Boot中多環(huán)境配置文件名需要滿(mǎn)足application-{profile}.properties的格式,其中{profile}對(duì)應(yīng)你的環(huán)境標(biāo)識(shí)尤溜,比如:
application-dev.properties:開(kāi)發(fā)環(huán)境
application-test.properties:測(cè)試環(huán)境
application-prod.properties:生產(chǎn)環(huán)境
至于哪個(gè)具體的配置文件會(huì)被加載倔叼,需要在application.properties文件中通過(guò)spring.profiles.active屬性來(lái)設(shè)置,其值對(duì)應(yīng){profile}值宫莱。
如:spring.profiles.active=test就會(huì)加載application-test.properties配置文件內(nèi)容
下面丈攒,以不同環(huán)境配置不同的服務(wù)端口為例,進(jìn)行樣例實(shí)驗(yàn)。
針對(duì)各環(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,就是說(shuō)默認(rèn)以dev環(huán)境設(shè)置
測(cè)試不同配置的加載:
執(zhí)行java -jar xxx.jar捕捂,可以觀察到服務(wù)端口被設(shè)置為8080瑟枫,也就是默認(rèn)的開(kāi)發(fā)環(huán)境(dev)
執(zhí)行java -jar xxx.jar --spring.profiles.active=test,可以觀察到服務(wù)端口被設(shè)置為9090指攒,也就是測(cè)試環(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溅呢,以開(kāi)發(fā)環(huán)境為默認(rèn)配置
application-{profile}.properties中配置各個(gè)環(huán)境不同的內(nèi)容
通過(guò)命令行方式去激活不同環(huán)境的配置澡屡。
多環(huán)境高級(jí)應(yīng)用
在某些情況下,應(yīng)用的某些業(yè)務(wù)邏輯可能需要有不同的實(shí)現(xiàn)咐旧。例如郵件服務(wù)驶鹉,假設(shè)EmailService中包含的send(String email)方法向指定地址發(fā)送電子郵件,但是我們僅僅希望在生產(chǎn)環(huán)境中才執(zhí)行真正發(fā)送郵件的代碼铣墨,而開(kāi)發(fā)環(huán)境里則不發(fā)送以免向用戶(hù)發(fā)送無(wú)意義的垃圾郵件室埋。
我們可以借助Spring的注解@Profile實(shí)現(xiàn)這樣的功能,這樣需要定義兩個(gè)實(shí)現(xiàn)EmailService借口的類(lèi):
/**
* 發(fā)送郵件接口.
*/
public interface EmailService {
? ? /**發(fā)送郵件*/
? ? publicvoid send();
}
發(fā)送郵件的具體實(shí)現(xiàn)(dev-開(kāi)發(fā)環(huán)境的代碼):
@Service
@Profile("dev") //開(kāi)發(fā)環(huán)境的時(shí)候.
public class DevEmailServiceImpl implements EmailService{
? ? @Override
? ? publicvoid send() {
? ? ? System.out.println("DevEmailServiceImpl.send().開(kāi)發(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è)類(lèi)伊约。那么如何設(shè)置Profile呢姚淆?
在application.properties中加入:
spring.profiles.active=dev
通過(guò)命令行參數(shù)
java -jar app.jar --spring.profiles.active=dev