文章目錄

• 什么是profile
• 1. application-{profile}.properties文件
• • 1.1 profile的多種激活方式
  • 1.2 spring.profiles.include屬性
  • 1.3 總結
• 2. @Profile
• • 2.1 注解可以使用的位置
  • 2.2 自定義注解
  • 2.3 注意
• 3. 和maven的profile一起使用

什么是profile

? ? ? ?想必大家都有這種經歷，我們開發項目的時候要有多個環境，如開發環境、測試環境、生產環境，他們的配置文件一般不同，如數據庫地址。當我們要向各個環境發布程序時，需要人工處理這些配置文件，這顯然麻煩且易錯。有了profile，一切問題就簡單了。簡單講profile就是一組配置，不同profile提供不同組合的配置，程序運行時可以選擇使用哪些profile來適應環境。

1. application-{profile}.properties文件

我們先來搭建一個簡單的springboot項目快速了解多profile的使用。項目結構非常簡單：

? ? ? ?除了application.properties還有多個application-{profile}.properties（格式必須為這樣）,在每個配置文件中項目啟動的端口是不一樣的。

? ? ? ?在application.properties使用spring.profiles.active=prod來指定生效的配置文件為application-prod.properties.啟動項目后可以在控制臺看到啟動端口為application-prod.properties里配置的server.port=8084

1.1 profile的多種激活方式

• 第一種就是上面的在配置文件中通過spring.profiles.active=來指定，注意可以激活多個profile，如spring.profiles.active=prod，dev,如果都存在某值，執行last win策略。
• 通過命令行方式。優先級高于第一種的spring.profiles.active
  ? ? ? ?執行java -jar xxx.jar，可以觀察到服務端口被設置為8082。
  ? ? ? ?執行java -jar xxx.jar –spring.profiles.active=test，可以觀察到服務端口被設置為8083，也就是（test）環境的配置
  ? ? ? ?
• 通過虛擬機參數。-Dspring.profiles.active=dev
• 使用編程的方式激活。

@SpringBootApplication public class Application {public static void main(String[] args) {ConfigurableApplicationContext applicationContext = SpringApplication.run(Application.class, args);applicationContext.getEnvironment().setActiveProfiles("dev");} }

1.2 spring.profiles.include屬性

? ? ? ?意思是無論執行哪個profile，都會去加載application-mq.properties里的配置。但是注意，只會去加載application-mq.properties里獨有的配置，如果application-mq.properties也有server.port字段并不會生效。
? ? ? ?可以利用這種方式簡化配置文件的書寫，如在application-mq.properties書寫各個環境都有的mq配置信息，不必都夾雜在application.properties里。

1.3 總結

• application.properties文件是必定要加載的，而且是先加載的，無論是通過哪種方式指定的。
• 當加載完application文件之后才加載指定的profiles文件
• 如果application文件和指定的profile文件有相同的配置或沖突的配置項，則以profile中的為基準
• application文件中寫通用的配置項，profile文件中寫特定環境的配置項，spring.profiles.include指定公共的配置項（起到了分離的作用），這樣可以簡化配置文件的書寫。

2. @Profile

通過@Profile注解，我們可以根據所激活的不同的環境，生成不同的bean。
如只在dev環境下啟動swagger2：

/*** swagger2的配置,只在開發環境dev下存在*/ @Configuration @EnableSwagger2 @Profile("dev") public class Swagger2Config {}

@profile官方博客介紹

2.1 注解可以使用的位置

• @component或@Configuration修飾的類上
• 作為元注解修飾自定義注解
• 任何@Bean修飾的方法上

2.2 自定義注解

? ? ? ?@Profile注解需要接受一個字符串，作為場景名。這樣每個地方都需要記住這個字符串。Spring的@Profile注解支持定義在其他注解之上，以創建自定義場景注解。

@Target({ElementType.TYPE, ElementType.METHOD}) @Retention(RetentionPolicy.RUNTIME) @Profile("dev") public @interface Dev{ }

? ? ? ?這樣就創建了一個@Dev注解，該注解可以標識bean使用于@Dev這個場景。后續就不再需要使用@Profile(“dev”)的方式(這樣即可以簡化代碼)。

2.3 注意

• @Profile({“p1”, “!p2”})的意思為p1的profile生效或p2的profile為生效時就會去生成修飾的類
• 如果要使用不同環境下生成不同配置的同一個bean，方法名不要相同，即盡量不要重載。

3. 和maven的profile一起使用

參看這篇博客結合maven的profile使用

總結

以上是生活随笔為你收集整理的profile之springboot的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。