SpringBoot 教程之 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=prod
複製代碼

main 方法激活 profile

--spring.profiles.active=prod
複製代碼

jar 激活 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
複製代碼

引伸和引用

引伸

• Spring Boot 教程

參考

• Bean Definition Profiles
• boot-features-profiles