Spring Boot 之 Profile 使用
阿新 • • 發佈：2018-12-20
Spring Boot 之 Profile 使用
一個應用為了在不同的環境下工作，常常會有不同的配置，程式碼邏輯處理。Spring Boot 對此提供了簡便的支援。
關鍵詞：
@Profile、spring.profiles.active
區分環境的配置
properties 配置
假設，一個應用的工作環境有：dev、test、prod
那麼，我們可以新增 4 個配置檔案：
applcation.properties- 公共配置application-dev.properties- 開發環境配置application-test.properties- 測試環境配置application-prod.properties- 生產環境配置
在 applcation.properties 檔案中可以通過以下配置來啟用 profile：
spring.profiles.active = test
yml 配置
與 properties 檔案類似，我們也可以新增 4 個配置檔案：
applcation.yml- 公共配置application-dev.yml- 開發環境配置application-test.yml- 測試環境配置application-prod.yml- 生產環境配置
在 applcation.yml 檔案中可以通過以下配置來啟用 profile：
spring:
profiles:
active: prod此外，yml 檔案也可以在一個檔案中完成所有 profile 的配置：
# 啟用 prod spring: profiles: active: prod # 也可以同時啟用多個 profile # spring.profiles.active: prod,proddb,prodlog --- # dev 配置 spring: profiles: dev # 略去配置 --- spring: profiles: test # 略去配置 --- spring.profiles: prod spring.profiles.include: - proddb - prodlog --- spring: profiles: proddb # 略去配置 --- spring: profiles: prodlog # 略去配置
注意：不同 profile 之間通過 --- 分割
區分環境的程式碼
使用 @Profile 註解可以指定類或方法在特定的 Profile 環境生效。
修飾類
@Configuration
@Profile("production")
public class JndiDataConfig {
@Bean(destroyMethod="")
public DataSource dataSource() throws Exception {
Context ctx = new InitialContext();
return (DataSource) ctx.lookup("java:comp/env/jdbc/datasource");
}
}修飾註解
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Profile("production")
public @interface Production {
}修飾方法
@Configuration
public class AppConfig {
@Bean("dataSource")
@Profile("development")
public DataSource standaloneDataSource() {
return new EmbeddedDatabaseBuilder()
.setType(EmbeddedDatabaseType.HSQL)
.addScript("classpath:com/bank/config/sql/schema.sql")
.addScript("classpath:com/bank/config/sql/test-data.sql")
.build();
}
@Bean("dataSource")
@Profile("production")
public DataSource jndiDataSource() throws Exception {
Context ctx = new InitialContext();
return (DataSource) ctx.lookup("java:comp/env/jdbc/datasource");
}
}啟用 profile
外掛啟用 profile
spring-boot:run -Drun.profiles=prodmain 方法啟用 profile
--spring.profiles.active=prodjar 啟用 profile
java -jar -Dspring.profiles.active=prod *.jar在 Java 程式碼中啟用 profile
直接指定環境變數來啟用 profile：
System.setProperty("spring.profiles.active", "test");在 Spring 容器中啟用 profile：
AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext();
ctx.getEnvironment().setActiveProfiles("development");
ctx.register(SomeConfig.class, StandaloneDataConfig.class, JndiDataConfig.class);
ctx.refresh();原始碼
完整示例：原始碼
使用方法：
mvn clean package
cd target
java -jar -Dspring.profiles.active=prod sbe-core-profile.jar引申和引用
引申
參考