多环境开发-Profiles

news2025/3/19 4:13:41

在实际的项目开发中，我们通常会涉及多个环境，如开发环境（dev）、测试环境（test）和生产环境（pro）。在不同的环境下，程序的配置信息会有所不同，例如连接的数据库肯定不一样。

一、多环境配置的基本概念

Spring Boot 的多环境配置主要依赖于 application.yml 或 application.properties 文件以及 spring.profiles.active 属性。通过激活不同的环境配置文件，我们可以为不同环境设置不同的配置参数。

二、创建多环境配置文件

在 Spring Boot 项目中，我们可以在 src/main/resources 目录下创建多个环境配置文件，文件命名规则如下：

application-dev.yml：开发环境配置文件
application-test.yml：测试环境配置文件
application-pro.yml：生产环境配置文件

示例配置文件

1. 开发环境配置文件（`application-dev.yml`）

spring:
  application:
    name: my-service
  profiles:
    active: dev
  datasource:
    url: jdbc:mysql://localhost:3306/mydb_dev
    username: dev_user
    password: dev_password
    driver-class-name: com.mysql.cj.jdbc.Driver
logging:
  level:
    root: DEBUG

2. 测试环境配置文件（`application-test.yml`）

spring:
  application:
    name: my-service
  profiles:
    active: test
  datasource:
    url: jdbc:mysql://localhost:3306/mydb_test
    username: test_user
    password: test_password
    driver-class-name: com.mysql.cj.jdbc.Driver
logging:
  level:
    root: INFO

3. 生产环境配置文件（`application-pro.yml`）

spring:
  application:
    name: my-service
  profiles:
    active: pro
  datasource:
    url: jdbc:mysql://pro-db-server:3306/mydb_pro
    username: pro_user
    password: pro_password
    driver-class-name: com.mysql.cj.jdbc.Driver
logging:
  level:
    root: ERROR

三、激活特定环境

1. 通过命令行激活

在运行 Spring Boot 应用时，可以通过命令行参数激活特定的环境。例如：

# 激活开发环境
java -jar my-service.jar --spring.profiles.active=dev

# 激活测试环境
java -jar my-service.jar --spring.profiles.active=test

# 激活生产环境
java -jar my-service.jar --spring.profiles.active=pro

2. 通过环境变量激活

你也可以通过设置环境变量来激活特定的环境。例如，在 Linux 系统中，可以使用以下命令：

# 设置环境变量
export SPRING_PROFILES_ACTIVE=dev

# 启动应用
java -jar my-service.jar

3. 通过配置文件激活

在 application.yml 或 application.properties 文件中直接指定激活的环境：

spring:
  profiles:
    active: dev    #配置文件名称组成里面的环境名称部分

四、分组管理配置文件

为了更好地管理多环境配置，我们可以将不同环境的配置文件分组管理。例如，将数据库配置、日志配置等分别放在不同的文件中。

示例：分组管理

1. 数据库配置文件（`application-datasource.yml`）

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/mydb
    username: db_user
    password: db_password
    driver-class-name: com.mysql.cj.jdbc.Driver

2. 日志配置文件（`application-logging.yml`）

logging:
  level:
    root: INFO

然后，在不同环境的配置文件中引入这些分组配置文件：

这样active激活的就不是单个文件了，而是激活的是组的名称

开发环境配置文件（`application-dev.yml`）

spring:
  application:
    name: my-service
  profiles:
    active: dev 
    group:
     "dev": datasource,logging

测试环境配置文件（`application-test.yml`）

spring:
  application:
    name: my-service
  profiles:
    active: test
    group:
     "test": datasource,logging

生产环境配置文件（`application-pro.yml`）

spring:
  application:
    name: my-service
  profiles:
    active: pro
    group:
     "pro": datasource,logging

五、注意事项

敏感信息管理：在生产环境中，避免将敏感信息（如数据库密码）直接写入配置文件。可以使用加密工具或环境变量来管理这些敏感信息。
配置文件优先级：Spring Boot 会按照以下顺序加载配置文件：
- 命令行参数
- 环境变量
- application.yml 或 application.properties 文件
- 激活的环境配置文件（如 application-dev.yml）
配置文件的命名规范：确保配置文件的命名规范，避免因文件名错误导致配置加载失败。