一个应用为了在不同的环境下工作,常常会有不同的配置,代码逻辑处理。Spring Boot 对此提供了简便的支持。
关键词: @Profile
、 spring.profiles.active
假设,一个应用的工作环境有:dev、test、prod
那么,我们可以添加 4 个配置文件:
applcation.properties application-dev.properties application-test.properties application-prod.properties
在 applcation.properties
文件中可以通过以下配置来激活 profile:
spring.profiles.active = test 复制代码
与 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"); } } 复制代码
spring-boot:run -Drun.profiles=prod 复制代码
--spring.profiles.active=prod 复制代码
java -jar -Dspring.profiles.active=prod *.jar 复制代码
直接指定环境变量来激活 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 复制代码