Spring Boot中的Profiles。

在Spring Boot中，profiles（配置文件）是一个非常有用的功能，它允许您根据不同环境使用不同的配置。这对于开发、测试、生产等不同环境下的配置管理非常有帮助。下面详细介绍Spring Boot中profiles的相关概念和使用方法。

Profiles 的概念

• Profile：在Spring中，profile是一种机制，可以让您在不同的环境下使用不同的配置。例如，您可以为开发环境、测试环境和生产环境分别定义不同的配置。
• Active Profile：活动的profile是指当前正在使用的profile。Spring Boot会在启动时确定哪个profile是active的。
• Default Profile：如果没有显式地激活某个profile，那么Spring Boot会使用默认的profile。默认情况下，没有显式指定的profile会被认为是默认的。

使用Profiles

1. 配置文件

在Spring Boot中，您可以为不同的profiles创建不同的配置文件。这些文件通常放在src/main/resources目录下，并遵循特定的命名规则。

• YAML 格式：

  • application.yml：默认配置文件。
  • application-dev.yml：开发环境的配置文件。
  • application-test.yml：测试环境的配置文件。
  • application-prod.yml：生产环境的配置文件。

• Properties 格式：

  • application.properties：默认配置文件。
  • application-dev.properties：开发环境的配置文件。
  • application-test.properties：测试环境的配置文件。
  • application-prod.properties：生产环境的配置文件。

2. 激活Profiles

• 命令行参数：

  java -jar yourapp.jar --spring.profiles.active=dev
  

• 环境变量：

  export SPRING_PROFILES_ACTIVE=dev
  # 或者在Windows上
  set SPRING_PROFILES_ACTIVE=dev
  

• 配置文件：
  在application.properties或application.yml中指定：

  spring.profiles.active=dev
  

• Java代码：
  您也可以在Java代码中激活profiles：

  import org.springframework.boot.SpringApplication;
  import org.springframework.boot.autoconfigure.SpringBootApplication;
  import org.springframework.context.ConfigurableApplicationContext;
  
  @SpringBootApplication
  public class YourApp {
      public static void main(String[] args) {
          ConfigurableApplicationContext context = SpringApplication.run(YourApp.class, args, "--spring.profiles.active=dev");
      }
  }
  

3. 使用Profiles注解

• @Profile：用于指定哪些bean或配置类仅在特定的profile下可用。

  import org.springframework.context.annotation.Profile;
  import org.springframework.stereotype.Component;
  
  @Component
  @Profile("dev")
  public class DevDataSourceConfig {
      // ...
  }
  

• @ConditionalOnProfile：Spring Boot 2.0 引入了一个新的注解，可以用来控制bean的条件性注册。

  import org.springframework.boot.autoconfigure.condition.ConditionalOnProfile;
  import org.springframework.context.annotation.Bean;
  import org.springframework.context.annotation.Configuration;
  
  @Configuration
  @ConditionalOnProfile("test")
  public class TestConfig {
      @Bean
      public DataSource testDataSource() {
          // ...
      }
  }
  

示例

假设您有一个简单的Spring Boot项目，想要为开发环境和生产环境分别配置不同的DataSource。

创建配置文件

在src/main/resources目录下创建以下配置文件：

• application.yml：

  spring:
    profiles:
      active: dev
  

• application-dev.yml：

  spring:
    datasource:
      url: jdbc:mysql://localhost:3306/dev_db
      username: dev_user
      password: dev_pass
  

• application-prod.yml：

  spring:
    datasource:
      url: jdbc:mysql://localhost:3306/prod_db
      username: prod_user
      password: prod_pass
  

主类

在主类中指定活动的profile：

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class YourApp {
    public static void main(String[] args) {
        SpringApplication.run(YourApp.class, args, "--spring.profiles.active=dev");
    }
}

注意事项

• 如果没有指定spring.profiles.active，Spring Boot将会使用默认的profile，也就是不包含任何profile后缀的配置文件。
• 如果有多个profiles需要同时激活，可以用逗号分隔：

  --spring.profiles.active=dev,logging
  

• 如果配置文件中有冲突，特定profile的配置会覆盖默认配置。

通过使用profiles，您可以轻松地管理不同环境下的配置，使得代码更加模块化和易于维护。