如何使用spring.profiles.active來分區配置

這篇文章將為大家詳細講解有關如何使用spring.profiles.active來分區配置，小編覺得挺實用的，因此分享給大家做個參考，希望大家閱讀完這篇文章后可以有所收獲。

很多時候，我們項目在開發環境和生成環境的環境配置是不一樣的，例如，數據庫配置，在開發的時候，我們一般用測試數據庫，而在生產環境的時候，我們是用正式的數據，這時候，我們可以利用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的配置文件

 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注解來進行配置，例如數據庫配置，這里我們先定義一個接口

 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");

  }

}

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

 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.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借口的類：

/**
 * 發送郵件接口.
 */
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

通過命令行參數

java -jar app.jar --spring.profiles.active=dev

關于“如何使用spring.profiles.active來分區配置”這篇文章就分享到這里了，希望以上內容可以對大家有一定的幫助，使各位可以學到更多知識，如果覺得文章不錯，請把它分享出去讓更多的人看到。