Spring Boot 和 Spring Cloud 构建一个完整的微服务架构——在线购物系统

文章目录

• Pre
• 概述
• 为什么需要多环境配置
• 多环境配置实现步骤
• • 1. 配置文件准备
  • 2. 激活特定环境
  • • 方法1：命令行参数
    • 方法2：环境变量
    • 方法3：IDE 配置
    • 方法4：全局配置文件默认设置
• 3. 配置文件加载顺序
• • 配置生效的原理
• 4. 常见问题
• • 多个配置文件冲突时怎么办
  • 忘记指定`spring.profiles.active`时会发生什么
  • 敏感信息如何管理
• 5. 注意事项

Pre

SpringBoot - 多环境打包最佳实践

概述

在实际开发中，应用程序往往需要根据不同的环境（如开发环境、测试环境、生产环境等）加载不同的配置。Spring Boot 提供了一个强大的功能——多环境配置，通过spring.profiles.active指定当前应用运行的环境，简单又高效！

spring.profiles.active 是 Spring Boot 用来指定激活环境的核心配置属性。Spring Boot 会根据该属性的值动态加载对应的配置文件，决定应用程序运行时的行为。

为什么需要多环境配置

假设我们有一个Web应用，它在开发和生产环境中的配置差异可能包括：

• 服务器端口：开发环境监听8080，生产环境监听80。
• 数据库连接：开发环境使用本地数据库，生产环境使用远程数据库。
• 日志级别：开发环境需要更详细的日志（DEBUG级别），生产环境只需要关键信息（INFO级别）。

通过多环境配置，我们可以将这些差异化配置分离，统一管理，并根据需求快速切换。

多环境配置实现步骤

1. 配置文件准备

Spring Boot 默认支持 application.yml 或 application.properties 文件来定义配置。我们可以为每个环境创建专属的配置文件，例如：

• application-dev.yml：开发环境配置
• application-test.yml：测试环境配置
• application-prod.yml：生产环境配置

全局配置文件（application.yml）

spring:
  profiles:
    active: dev # 默认激活开发环境

开发环境（application-dev.yml）

server:
  port: 8080
app:
  name: "MyApp-Dev"
logging:
  level:
    root: DEBUG

生产环境（application-prod.yml）

server:
  port: 80
app:
  name: "MyApp-Prod"
logging:
  level:
    root: INFO

2. 激活特定环境

可以通过以下几种方式激活特定的环境配置。

方法1：命令行参数

在启动应用时，通过命令行指定：

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

方法2：环境变量

在操作系统中设置环境变量：

• Linux/Mac

  export SPRING_PROFILES_ACTIVE=prod
  

• Windows

  set SPRING_PROFILES_ACTIVE=prod
  

方法3：IDE 配置

如果你使用 IntelliJ IDEA，可以按照以下步骤配置：

1. 打开 Run/Debug Configurations。
2. 在 VM Options 中添加：

   -Dspring.profiles.active=prod
   

方法4：全局配置文件默认设置

在application.yml文件中直接指定默认环境：

spring:
  profiles:
    active: prod

3. 配置文件加载顺序

Spring Boot 的配置文件加载遵循以下优先级（从高到低）：

1. 命令行参数：最高优先级，覆盖其他所有配置。
2. 环境变量：覆盖全局配置文件。
3. 全局配置文件：application.yml 或 application.properties 中的默认配置。

配置生效的原理

Spring Boot 会根据spring.profiles.active的值加载相应的环境配置文件，并与全局配置文件进行合并。例如：

假设以下配置：

• application.yml

  server:
    port: 8080
  spring:
    profiles:
      active: prod
  

• application-prod.yml

  server:
    port: 80
  app:
    name: "MyApp-Prod"
  

应用启动时将按照以下逻辑：

1. 加载application.yml中的配置，初始端口为8080。
2. 检测到激活的环境为prod，加载application-prod.yml中的配置。
3. 合并配置，并覆盖application.yml中重复的属性（如server.port），最终端口为80。

4. 常见问题

多个配置文件冲突时怎么办

如果application.yml和环境配置文件（如application-prod.yml）中存在冲突的配置，环境配置文件的值会优先生效。

忘记指定spring.profiles.active时会发生什么

默认加载application.yml中的配置，如果未指定spring.profiles.active，将不会加载任何环境特定的配置。

敏感信息如何管理

生产环境的敏感信息（如数据库密码）不建议直接写入配置文件，可以使用：

• 环境变量
• 加密配置
• 配置中心（如 Spring Cloud Config 或 Apollo）

5. 注意事项

• 优先级顺序：命令行参数 > 环境变量 > application.yml 文件配置。
• 命名规范：确保application-{profile}.yml与spring.profiles.active的值一致。
• 敏感信息管理：在生产环境中，不要将敏感信息（如数据库密码）直接写入配置文件