很多時候,我們項目在開發環境和生成環境的環境配置是不一樣的,例如,數據庫配置,在開發的時候,我們一般用測試數據庫,而在生產環境的時候,我們是用正式的數據,這時候,我們可以利用profile在不同的環境下配置用不同的配置文件或者不同的配置
spring boot允許你通過命名約定按照一定的格式(application-{profile}.properties)來定義多個配置文件,然后通過在application.properyies通過spring.profiles.active來具體激活一個或者多個配置文件,如果沒有沒有指定任何profile的配置文件的話,spring boot默認會啟動application-default.properties。
profile的配置文件可以按照application.properyies的放置位置一樣,放于以下四個位置,
1.當前目錄的 “/config”的子目錄下
2.當前目錄下
3.classpath根目錄的“/config”包下
4.classpath的根目錄下
在這里我們就定義倆個profile文件,application-cus1.properties和application-cus2.properties,并在倆個文件中都分別寫上變量cusvar=cus1和cusvar=cus2
我們在application.properyies也寫上,并把profile切換到application-cus1.properties的配置文件
1
2
|
cusvar=cus3 spring.profiles.active=cus1 |
可以通過這樣子來測試
1
2
3
4
5
6
7
8
9
10
11
|
@restcontroller @requestmapping ( "/task" ) public class taskcontroller { @requestmapping (value = { "/" , "" }) public string helltask( @value ( "${cusvar}" )string cusvar ){ return "hello task !! myage is " + cusvar; } } |
在這里可以看到spring.profiles.active激活的profile不同,打印出來的結果也不一樣。
除了可以用profile的配置文件來分區配置我們的環境變量,在代碼里,我們還可以直接用@profile注解來進行配置,例如數據庫配置,這里我們先定義一個接口
1
2
3
|
public interface dbconnector { public void configure(); } |
分別定義倆個實現類來實現它
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
|
/** * 測試數據庫 */ @component @profile ( "testdb" ) public class testdbconnector implements dbconnector { @override public void configure() { system.out.println( "testdb" ); } } /** * 生產數據庫 */ @component @profile ( "devdb" ) public class devdbconnector implements dbconnector { @override public void configure() { system.out.println( "devdb" ); } } |
通過在配置文件激活具體使用哪個實現類
1
|
spring.profiles.active=testdb |
然后就可以這么用了
1
2
3
4
5
6
7
8
9
10
11
12
13
14
|
@restcontroller @requestmapping ( "/task" ) public class taskcontroller { @autowired dbconnector connector ; @requestmapping (value = { "/" , "" }) public string helltask(){ connector.configure(); //最終打印testdb return "hello task !! myage is " + myage; } } |
除了spring.profiles.active來激活一個或者多個profile之外,還可以用spring.profiles.include來疊加profile
1
2
|
spring.profiles: testdb spring.profiles.include: proddb,prodmq |
以上就是spring boot用profile的作用
通過命令行設置屬性值
相信使用過一段時間spring boot的用戶,一定知道這條命令:java -jar xxx.jar --server.port=8888,通過使用--server.port屬性來設置xxx.jar應用的端口為8888。
在命令行運行時,連續的兩個減號--就是對application.properties中的屬性值進行賦值的標識。所以,java -jar xxx.jar --server.port=8888命令,等價于我們在application.properties中添加屬性server.port=8888,該設置在樣例工程中可見,讀者可通過刪除該值或使用命令行來設置該值來驗證。
通過命令行來修改屬性值固然提供了不錯的便利性,但是通過命令行就能更改應用運行的參數,那豈不是很不安全?是的,所以spring boot也貼心的提供了屏蔽命令行訪問屬性的設置,只需要這句設置就能屏蔽:springapplication.setaddcommandlineproperties(false)。
多環境配置
以上都不是重點,這才是重點,這才是重點,這才是重點,重要的事情說3遍。我們在開發spring boot應用時,通常同一套程序會被應用和安裝到幾個不同的環境,比如:開發、測試、生產等。其中每個環境的數據庫地址、服務器端口等等配置都會不同,如果在為不同環境打包時都要頻繁修改配置文件的話,那必將是個非常繁瑣且容易發生錯誤的事。
對于多環境的配置,各種項目構建工具或是框架的基本思路是一致的,通過配置多份不同環境的配置文件,再通過打包命令指定需要打包的內容之后進行區分打包,spring boot也不例外,或者說更加簡單。
在spring boot中多環境配置文件名需要滿足application-{profile}.properties的格式,其中{profile}對應你的環境標識,比如:
- application-dev.properties:開發環境
- application-test.properties:測試環境
- application-prod.properties:生產環境
至于哪個具體的配置文件會被加載,需要在application.properties文件中通過spring.profiles.active屬性來設置,其值對應{profile}值。
如:spring.profiles.active=test就會加載application-test.properties配置文件內容
下面,以不同環境配置不同的服務端口為例,進行樣例實驗。
針對各環境新建不同的配置文件application-dev.properties、application-test.properties、application-prod.properties
在這三個文件均都設置不同的server.port屬性,如:dev環境設置為8080,test環境設置為9090,prod環境設置為80
application.properties中設置spring.profiles.active=dev,就是說默認以dev環境設置
測試不同配置的加載:
執行java -jar xxx.jar,可以觀察到服務端口被設置為8080,也就是默認的開發環境(dev)
執行java -jar xxx.jar --spring.profiles.active=test,可以觀察到服務端口被設置為9090,也就是測試環境的配置(test)
執行java -jar xxx.jar --spring.profiles.active=prod,可以觀察到服務端口被設置為80,也就是生產環境的配置(prod)
按照上面的實驗,可以如下總結多環境的配置思路:
application.properties中配置通用內容,并設置spring.profiles.active=dev,以開發環境為默認配置
application-{profile}.properties中配置各個環境不同的內容
通過命令行方式去激活不同環境的配置。
多環境高級應用
在某些情況下,應用的某些業務邏輯可能需要有不同的實現。例如郵件服務,假設emailservice中包含的send(string email)方法向指定地址發送電子郵件,但是我們僅僅希望在生產環境中才執行真正發送郵件的代碼,而開發環境里則不發送以免向用戶發送無意義的垃圾郵件。
我們可以借助spring的注解@profile實現這樣的功能,這樣需要定義兩個實現emailservice借口的類:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
|
/** * 發送郵件接口. */ public interface emailservice { /**發送郵件*/ publicvoid send(); } 發送郵件的具體實現(dev-開發環境的代碼): @service @profile ( "dev" ) //開發環境的時候. public class devemailserviceimpl implements emailservice{ @override publicvoid send() { system.out.println( "devemailserviceimpl.send().開發環境不執行郵件的發送." ); } } |
發送郵件的具體實現(prod-生產環境的代碼):
1
2
3
4
5
6
7
8
9
10
11
|
@service @profile ( "prod" ) //生產環境. public class prodemailserviceimpl2 implements emailservice{ @override publicvoid send() { system.out.println( "devemailserviceimpl.send().生產環境執行郵件的發送." ); //具體的郵件發送代碼. //mail.send(); } } |
@profile("dev")表明只有spring定義的profile為dev時才會實例化devemailservice這個類。那么如何設置profile呢?
在配置文件中指定
在application.properties中加入:
1
|
spring.profiles.active=dev |
通過命令行參數
1
|
java -jar app.jar --spring.profiles.active=dev |
以上就是本文的全部內容,希望對大家的學習有所幫助,也希望大家多多支持服務器之家。
原文鏈接:http://www.cnblogs.com/xinglongbing521/p/10275291.html