【SpringBoot】Spring Boot配置优先级详解

Spring Boot配置优先级详解

Spring Boot的配置优先级决定了不同配置源之间的覆盖关系，遵循高优先级配置覆盖低优先级的原则。以下是详细的优先级排序及配置方法说明：

---

一、配置优先级从高到低排序

1. 命令行参数
   优先级最高，通过--key=value形式传递，直接覆盖其他配置。
   示例：

   java -jar app.jar --server.port=8081
   

2. Java系统属性（-D参数）
   通过JVM参数设置，优先级仅次于命令行参数。
   示例：

   java -Dserver.port=8081 -jar app.jar
   

3. 操作系统环境变量
   通过系统环境变量设置，例如SPRING_PROFILES_ACTIVE=dev。
   示例（Linux/Mac）：

   export SERVER_PORT=8081
   

4. 外部配置文件（JAR包外部的配置文件）

   • 目录优先级：
     • /config/目录（JAR包同级） > 项目根目录 > classpath:/config/ > classpath:/
   • 文件类型优先级：.properties > .yml > .yaml。
     示例：

   java -jar app.jar --spring.config.location=file:/opt/config/application.yml
   

5. 内部配置文件（JAR包内部的配置文件）
   默认加载classpath:/application.properties或application.yml。若存在多个同名文件，按目录优先级加载。

6. @PropertySource注解指定的配置文件
   需在代码中显式指定配置文件路径。
   示例：

   @Configuration
   @PropertySource("classpath:custom.properties")
   public class AppConfig {}
   

7. 默认属性（通过SpringApplication.setDefaultProperties设置）
   代码中设置的默认值，优先级最低。

---

二、特殊配置场景说明

1. Bootstrap配置文件

• 应用场景：Spring Cloud项目中用于加载配置中心信息（如spring.cloud.config.uri）。
• 优先级：bootstrap.properties > bootstrap.yml > application.properties > application.yml。
• 示例：

  # bootstrap.yml
  spring.cloud.config.uri=http://config-server:8888
  

2. Profile-specific配置

• 规则：通过application-{profile}.properties激活特定环境配置。
• 示例：

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

3. 多配置源互补与覆盖

• 互补加载：所有配置源均被加载，不冲突的配置项会合并。
• 覆盖规则：高优先级配置覆盖低优先级同名配置，如命令行参数覆盖环境变量。

---

三、配置方法实例

1. 命令行参数配置

• 覆盖端口：

  java -jar app.jar --server.port=8081
  

• 指定外部配置文件：

  java -jar app.jar --spring.config.location=classpath:/external/
  

2. Java系统属性配置

• 设置JVM参数：

  java -Dserver.port=8081 -jar app.jar
  

• 代码中读取：

  @Value("${server.port}")
  private String port;
  

3. 环境变量配置

• 设置环境变量（Linux/Mac）：

  export SERVER_PORT=8081
  

• Spring Boot自动映射：环境变量中的SERVER_PORT会映射到server.port属性。

4. 配置文件示例

• application.yml：

  server:
    port: 8080
  spring:
    profiles:
      active: dev
  

• application-prod.yml：

  server:
    port: 8081
  

5. 动态刷新配置（结合Spring Cloud）

• 使用@RefreshScope注解实现配置热更新：

  @RefreshScope
  @RestController
  public class ConfigController {
      @Value("${dynamic.config}")
      private String config;
  }
  

---

四、注意事项

1. 配置优先级验证：可通过Environment对象查看生效的配置值：

   @Autowired
   private Environment env;
   System.out.println(env.getProperty("server.port"));
   

2. 配置文件冲突规则：

   • 同一目录下，.properties优先级高于.yml。
   • 外部配置文件优先级高于内部文件。

3. Spring Boot 2.4+特性：

   • 支持多文档配置文件（类似YAML），通过#---分隔不同配置块。

---

通过上述规则和实例，可以灵活管理Spring Boot应用的配置，适应不同环境需求。具体配置方式需根据实际场景选择，如生产环境推荐使用外部配置文件或环境变量，开发环境可使用命令行参数快速调试。