spring boot 入門 使用spring.profiles.active來分區配置

不少時候,咱們項目在開發環境和生成環境的環境配置是不同的,例如,數據庫配置,在開發的時候,咱們通常用測試數據庫,而在生產環境的時候,咱們是用正式的數據,這時候,咱們能夠利用profile在不一樣的環境下配置用不一樣的配置文件或者不一樣的配置html

spring boot容許你經過命名約定按照必定的格式(application-{profile}.properties)來定義多個配置文件,而後經過在application.properyies經過spring.profiles.active來具體激活一個或者多個配置文件,若是沒有沒有指定任何profile的配置文件的話,spring boot默認會啓動application-default.properties。java

profile的配置文件能夠按照application.properyies的放置位置同樣,放於如下四個位置,spring

  1. 當前目錄的 「/config」的子目錄下
  2. 當前目錄下
  3. classpath根目錄的「/config」包下
  4. classpath的根目錄下

在這裏咱們就定義倆個profile文件,application-cus1.properties和application-cus2.properties,並在倆個文件中都分別寫上變量cusvar=cus1和cusvar=cus2sql


咱們在application.properyies也寫上,並把profile切換到application-cus1.properties的配置文件數據庫

cusvar=cus3 spring.profiles.active=cus1

能夠經過這樣子來測試安全

@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註解來進行配置,例如數據庫配置,這裏咱們先定義一個接口
 app

public interface DBConnector { public void configure(); }


分別定義倆個實現類來實現它框架

/** * 測試數據庫 */ @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"); } }

經過在配置文件激活具體使用哪一個實現類ide

spring.profiles.active=testdb

而後就能夠這麼用了

@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

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.propertiesapplication-test.propertiesapplication-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藉口的類:

/**  * 發送郵件接口.  */ public interface EmailService {     /**發送郵件*/     publicvoid send(); } 發送郵件的具體實現(dev-開發環境的代碼): @Service @Profile("dev") //開發環境的時候. public class DevEmailServiceImpl implements EmailService{       @Override     publicvoid send() {        System.out.println("DevEmailServiceImpl.send().開發環境不執行郵件的發送.");     } }


 
 
發送郵件的具體實現(prod-生產環境的代碼):

@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中加入:

spring.profiles.active=dev

 

經過命令行參數

轉http://www.leftso.com/blog/111.htmljava -jar app.jar --spring.profiles.active=dev
相關文章
相關標籤/搜索