背景
很多時候,我們項目在開發(fā)環(huán)境和生成環(huán)境的環(huán)境配置是不一樣的,例如,數(shù)據(jù)庫配置,在開發(fā)的時候,我們一般用測試數(shù)據(jù)庫,而在生產(chǎn)環(huán)境的時候,我們是用正式的數(shù)據(jù),這時候,我們可以利用profile在不同的環(huán)境下配置用不同的配置文件或者不同的配置。
spring boot 提供
spring boot允許你通過命名約定按照一定的格式(application-{profile}.properties)來定義多個配置文件,然后通過在application.properyies通過spring.profiles.active來具體激活一個或者多個配置文件,如果沒有沒有指定任何profile的配置文件的話,spring boot默認會啟動application-default.properties。
profile的配置文件可以按照application.properyies的放置位置一樣,放于以下四個位置:
當前目錄的 “/config”的子目錄下
當前目錄下
classpath根目錄的“/config”包下
classpath的根目錄下
demo 演示
在這里我們就定義倆個profile文件,
application-sit.properties和application-prd.properties,
并在倆個文件中都分別
寫上變量
我們在application.properyies也寫上,并把profile切換到application-sit.properties的配置文件

我們在application.properyies也寫上,并把profile切換到application-sit.properties的配置文件
#修改tomcat的默認的端口號,將8080改為8889
server.port=8889
#啟用shutdown endpoint的HTTP訪問
endpoints.shutdown.enabled=true
#不需要用戶名密碼驗證
endpoints.shutdown.sensitive=false
#默認curvar值
curvar=default.curvar
#切換配置文件
spring.profiles.active=sit
可以通過這樣子來測試
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;
? ? }
}

分別定義倆個實現(xiàn)類來實現(xiàn)它
package config;
import org.springframework.context.annotation.Profile;
import org.springframework.stereotype.Component;
/**
* 測試數(shù)據(jù)庫
*/
@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ù)庫
*/
@Component
@Profile("prddb")
public class PrdDBConnector implements DBConnector {
? ? @Override
? ? public void configure() {
? ? ? ? System.out.println("prd-db");
? ? }
}
通過在配置文件激活具體使用哪個實現(xiàn)類
#修改tomcat的默認的端口號,將8080改為8889
server.port=8889
#啟用shutdown endpoint的HTTP訪問
endpoints.shutdown.enabled=true
#不需要用戶名密碼驗證
endpoints.shutdown.sensitive=false
#默認curvar值
curvar=default.curvar
#切換配置文件
#修改tomcat的默認的端口號,將8080改為8889
server.port=8889
#啟用shutdown endpoint的HTTP訪問
endpoints.shutdown.enabled=true
#不需要用戶名密碼驗證
endpoints.shutdown.sensitive=false
#默認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的作用。
以下為可選(主要是命令行使用):
通過命令行設(shè)置屬性值
相信使用過一段時間Spring Boot的用戶,一定知道這條命令:java -jar xxx.jar --server.port=8888,通過使用–server.port屬性來設(shè)置xxx.jar應(yīng)用的端口為8888。
在命令行運行時,連續(xù)的兩個減號–就是對application.properties中的屬性值進行賦值的標識。所以,java -jar xxx.jar --server.port=8888命令,等價于我們在application.properties中添加屬性server.port=8888,該設(shè)置在樣例工程中可見,讀者可通過刪除該值或使用命令行來設(shè)置該值來驗證。
通過命令行來修改屬性值固然提供了不錯的便利性,但是通過命令行就能更改應(yīng)用運行的參數(shù),那豈不是很不安全?是的,所以Spring Boot也貼心的提供了屏蔽命令行訪問屬性的設(shè)置,只需要這句設(shè)置就能屏蔽:SpringApplication.setAddCommandLineProperties(false)。
多環(huán)境配置
以上都不是重點,這才是重點,這才是重點,這才是重點,重要的事情說3遍。我們在開發(fā)Spring Boot應(yīng)用時,通常同一套程序會被應(yīng)用和安裝到幾個不同的環(huán)境,比如:開發(fā)、測試、生產(chǎn)等。其中每個環(huán)境的數(shù)據(jù)庫地址、服務(wù)器端口等等配置都會不同,如果在為不同環(huán)境打包時都要頻繁修改配置文件的話,那必將是個非常繁瑣且容易發(fā)生錯誤的事。
對于多環(huán)境的配置,各種項目構(gòu)建工具或是框架的基本思路是一致的,通過配置多份不同環(huán)境的配置文件,再通過打包命令指定需要打包的內(nèi)容之后進行區(qū)分打包,Spring Boot也不例外,或者說更加簡單。
在Spring Boot中多環(huán)境配置文件名需要滿足application-{profile}.properties的格式,其中{profile}對應(yīng)你的環(huán)境標識,比如:
application-dev.properties:開發(fā)環(huán)境
application-test.properties:測試環(huán)境
application-prod.properties:生產(chǎn)環(huán)境
至于哪個具體的配置文件會被加載,需要在application.properties文件中通過spring.profiles.active屬性來設(shè)置,其值對應(yīng){profile}值。
如:spring.profiles.active=test就會加載application-test.properties配置文件內(nèi)容
下面,以不同環(huán)境配置不同的服務(wù)端口為例,進行樣例實驗。
針對各環(huán)境新建不同的配置文件application-dev.properties、application-test.properties、application-prod.properties
在這三個文件均都設(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,就是說默認以dev環(huán)境設(shè)置
測試不同配置的加載:
執(zhí)行java -jar xxx.jar,可以觀察到服務(wù)端口被設(shè)置為8080,也就是默認的開發(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)
按照上面的實驗,可以如下總結(jié)多環(huán)境的配置思路:
application.properties中配置通用內(nèi)容,并設(shè)置spring.profiles.active=dev,以開發(fā)環(huán)境為默認配置
application-{profile}.properties中配置各個環(huán)境不同的內(nèi)容
通過命令行方式去激活不同環(huán)境的配置。
多環(huán)境高級應(yīng)用
在某些情況下,應(yīng)用的某些業(yè)務(wù)邏輯可能需要有不同的實現(xiàn)。例如郵件服務(wù),假設(shè)EmailService中包含的send(String email)方法向指定地址發(fā)送電子郵件,但是我們僅僅希望在生產(chǎn)環(huán)境中才執(zhí)行真正發(fā)送郵件的代碼,而開發(fā)環(huán)境里則不發(fā)送以免向用戶發(fā)送無意義的垃圾郵件。
我們可以借助Spring的注解@Profile實現(xiàn)這樣的功能,這樣需要定義兩個實現(xiàn)EmailService借口的類:
/**
* 發(fā)送郵件接口.
*/
public interface EmailService {
? ? /**發(fā)送郵件*/
? ? publicvoid send();
}
發(fā)送郵件的具體實現(xiàn)(dev-開發(fā)環(huán)境的代碼):
@Service
@Profile("dev") //開發(fā)環(huán)境的時候.
public class DevEmailServiceImpl implements EmailService{
? ? @Override
? ? publicvoid send() {
? ? ? System.out.println("DevEmailServiceImpl.send().開發(fā)環(huán)境不執(zhí)行郵件的發(fā)送.");
? ? }
}
發(fā)送郵件的具體實現(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時才會實例化DevEmailService這個類。那么如何設(shè)置Profile呢?
在application.properties中加入:
spring.profiles.active=dev
通過命令行參數(shù)
java -jar app.jar --spring.profiles.active=dev