Spring Boot 中如何配置 Profile

2025-01-23 技术教程

一个应用为了在不同的环境下工作，常常会有不同的配置，代码逻辑处理。Spring Boot 对此提供了简便的支持。
关键词： @Profile、spring.profiles.active

区分环境的配置

properties 配置

yml 配置

区分环境的代码

修饰类

修饰注解

修饰方法

激活 profile

插件激活 profile

main 方法激活 profile

jar 激活 profile

在 Java 代码中激活 profile

区分环境的配置properties 配置

假设，一个应用的工作环境有：dev、test、prod

那么，我们可以添加 4 个配置文件：

applcation.properties - 公共配置

application-dev.properties - 开发环境配置

application-test.properties - 测试环境配置

application-prod.properties - 生产环境配置

在 applcation.properties 文件中可以通过以下配置来激活 profile：

spring.profiles.active = testyml 配置

与 properties 文件类似，我们也可以添加 4 个配置文件：

applcation.yml - 公共配置

application-dev.yml - 开发环境配置

application-test.yml - 测试环境配置

application-prod.yml - 生产环境配置

在 applcation.yml 文件中可以通过以下配置来激活 profile：

spring: profiles: active: prod

此外，yml 文件也可以在一个文件中完成所有 profile 的配置：

# 激活 prodspring: profiles: active: prod# 也可以同时激活多个 profile# spring.profiles.active: prod,proddb,prodlog---# dev 配置spring: profiles: dev# 略去配置---spring: profiles: test# 略去配置---spring.profiles: prodspring.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 {}修饰方法

@Configurationpublic 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 packagecd targetjava -jar -Dspring.profiles.active=prod sbe-core-profile.jar