spring.profiles.active配置介绍与使用说明

spring.profiles.active配置介绍

spring.profiles.active 配置在 Spring 应用程序中用于指定当前激活的配置文件（profiles）。配置文件是 Spring 提供的一种机制，用于将应用程序的配置划分为不同的环境，比如开发（development）、测试（test）、生产（production）等。

作用

1. 环境特定配置：

   • 不同环境可能需要不同的配置。例如，开发环境可能使用本地数据库，而生产环境使用远程数据库。
   • 可以为每个环境创建单独的属性文件，如 application-dev.properties、application-test.properties、application-prod.properties。

2. 激活指定配置文件：

   • 通过设置 spring.profiles.active，可以告诉 Spring 在启动时加载哪些配置文件。
   • 可以在 application.properties 文件中指定，也可以通过命令行参数或环境变量来指定。

3. 支持多个配置文件：

   • 可以同时激活多个配置文件，使用逗号分隔，如 spring.profiles.active=dev,test。

示例

application.properties

spring.profiles.active=dev

application-dev.properties

db.url=jdbc:mysql://localhost:3306/devdb
db.username=devuser
db.password=devpass

application-prod.properties

db.url=jdbc:mysql://localhost:3306/proddb
db.username=produser
db.password=prodpass

在上述示例中，spring.profiles.active=dev 表示 Spring 启动时会加载 application-dev.properties 文件中的配置。

编程方式激活配置文件

也可以通过 Java 代码在运行时激活配置文件：

import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Profile;

@Configuration
@Profile("dev")
public class DevConfig {
    // 开发环境特定的 Bean 和配置
}

命令行激活配置文件

通过命令行参数在启动 Spring Boot 应用程序时激活配置文件：

java -jar myapp.jar --spring.profiles.active=prod

其他问题：

配置文件指定dev的话，那dev的配置文件名称只能叫application-dev吗？

在 Spring 中，虽然 application-dev.properties 是一个常见的命名惯例，但你并不局限于这个命名格式。你可以自由命名你的配置文件，只要你在适当的位置指定它们。

自定义配置文件命名

如果你希望使用不同的命名方式，可以在主配置文件 application.properties 或 application.yml 中使用 spring.config.additional-location 或 spring.config.import 来指定其他配置文件的位置。

示例：自定义配置文件名称

假设你有一个自定义命名的配置文件 custom-dev-config.properties，可以通过以下方式引用它：

application.properties

spring.profiles.active=dev
spring.config.additional-location=classpath:/config/custom-dev-config.properties

或者

application.yml

spring:
  profiles:
    active: dev
  config:
    additional-location: classpath:/config/custom-dev-config.properties

使用 spring.config.import (Spring Boot 2.4+)

从 Spring Boot 2.4 开始，引入了 spring.config.import 属性，可以更灵活地引入其他配置文件：

application.properties

spring.profiles.active=dev
spring.config.import=optional:classpath:/config/custom-dev-config.properties

application.yml

spring:
  profiles:
    active: dev
  config:
    import: optional:classpath:/config/custom-dev-config.properties

完整示例

假设你有以下两个文件：

1. application.properties:

   spring.profiles.active=dev
   spring.config.import=optional:classpath:/config/custom-dev-config.properties
   

2. custom-dev-config.properties:

   db.url=jdbc:mysql://localhost:3306/devdb
   db.username=devuser
   db.password=devpass
   

在这种配置下，Spring 启动时会加载 custom-dev-config.properties 中的内容，因为它与激活的 dev 配置文件关联。

总结

​ spring.profiles.active 配置使得应用程序能够在不同的环境中使用不同的配置，从而简化了开发、测试和部署过程中的配置管理。这一机制可以确保应用程序在不同环境中具有一致性和灵活性。

​ 虽然 application-{profile}.properties 是 Spring 的默认命名约定，但你可以使用 spring.config.additional-location 或 spring.config.import 属性来自定义配置文件的命名和位置。这使得你的配置更加灵活，可以根据项目需求进行调整。