Spring Boot 怎么查找配置文件路径的顺序和其优先级别

Spring Boot 是一个用于快速开发 Spring 应用程序的框架，它通过自动配置和约定优于配置的原则，极大地简化了 Spring 应用的开发过程。在 Spring Boot 中，配置文件（如 application.properties 或 application.yml）是应用程序配置的重要组成部分。Spring Boot 提供了多种方式来加载配置文件，并且这些配置文件可以位于不同的路径下。本文将详细介绍 Spring Boot 查找配置文件路径的顺序及其优先级别。

1. Spring Boot 配置文件概述

Spring Boot 支持多种格式的配置文件，最常见的是 application.properties 和 application.yml。这些配置文件可以包含应用程序的各种配置项，如数据库连接、服务器端口、日志级别等。Spring Boot 会根据一定的顺序查找这些配置文件，并根据优先级决定最终生效的配置。

2. 配置文件路径的查找顺序

Spring Boot 在启动时会按照以下顺序查找配置文件：

1. 当前目录下的 /config 子目录
   Spring Boot 首先会查找当前目录下的 /config 子目录中的配置文件。例如，如果你的应用程序在 /app 目录下运行，Spring Boot 会查找 /app/config/application.properties 或 /app/config/application.yml。

2. 当前目录
   如果 /config 子目录中没有找到配置文件，Spring Boot 会继续在当前目录下查找。例如，/app/application.properties 或 /app/application.yml。

3. 类路径下的 /config 包
   如果当前目录下没有找到配置文件，Spring Boot 会查找类路径下的 /config 包中的配置文件。例如，classpath:/config/application.properties 或 classpath:/config/application.yml。

4. 类路径根目录
   最后，Spring Boot 会查找类路径根目录下的配置文件。例如，classpath:/application.properties 或 classpath:/application.yml。

3. 配置文件的优先级别

Spring Boot 不仅会按照上述顺序查找配置文件，还会根据配置文件的加载顺序和位置决定配置项的优先级。具体来说，配置文件的优先级从高到低依次为：

1. 命令行参数
   通过命令行传递的参数具有最高的优先级。例如，使用 --server.port=8081 启动应用程序时，server.port 的值将被设置为 8081，覆盖其他配置文件中的相同配置项。

2. SPRING_APPLICATION_JSON 环境变量
   如果设置了 SPRING_APPLICATION_JSON 环境变量，Spring Boot 会将其解析为 JSON 格式的配置，并应用于应用程序。这些配置项的优先级高于其他配置文件。

3. application-{profile}.properties 或 application-{profile}.yml
   如果启用了特定的 Spring Profile（如 dev、prod 等），Spring Boot 会加载对应的配置文件（如 application-dev.properties 或 application-dev.yml）。这些配置文件中的配置项会覆盖默认配置文件中的相同配置项。

4. application.properties 或 application.yml
   默认的配置文件（application.properties 或 application.yml）中的配置项具有较低的优先级。如果其他配置文件或命令行参数中没有定义相同的配置项，这些配置项才会生效。

5. @Configuration 类中的 @PropertySource 注解
   如果在 Spring Boot 应用程序中使用了 @Configuration 类，并通过 @PropertySource 注解加载了额外的配置文件，这些配置文件中的配置项优先级低于上述配置文件。

6. 默认属性
   Spring Boot 提供了一些默认属性，这些属性在没有任何配置文件或命令行参数的情况下生效。例如，如果没有指定 server.port，Spring Boot 会默认使用 8080 作为服务器端口。

4. 配置文件加载顺序的示例

为了更好地理解 Spring Boot 配置文件加载的顺序和优先级，我们通过一个示例来说明。

假设我们有一个 Spring Boot 应用程序，其目录结构如下：

/app
  ├── config
  │   └── application.properties
  ├── application.properties
  └── src
      └── main
          └── resources
              ├── config
              │   └── application.properties
              └── application.properties

在这个示例中，Spring Boot 会按照以下顺序加载配置文件：

1. /app/config/application.properties
2. /app/application.properties
3. classpath:/config/application.properties
4. classpath:/application.properties

假设这些配置文件中都定义了 server.port 属性，那么最终生效的 server.port 值将来自 /app/config/application.properties，因为它的优先级最高。

5. 使用 Spring Profile 的配置文件

Spring Boot 支持通过 Spring Profile 来加载不同的配置文件。例如，如果你在 application.properties 中设置了 spring.profiles.active=dev，Spring Boot 会加载 application-dev.properties 文件中的配置项。

假设我们有以下配置文件：

• application.properties:

  server.port=8080
  spring.profiles.active=dev
  

• application-dev.properties:

  server.port=8081
  

在这种情况下，server.port 的值将被设置为 8081，因为 application-dev.properties 中的配置项覆盖了 application.properties 中的配置项。

6. 命令行参数的优先级

命令行参数具有最高的优先级。例如，如果你使用以下命令启动应用程序：

java -jar myapp.jar --server.port=8082

那么无论配置文件中如何定义 server.port，最终生效的值都将是 8082。

7. 总结

Spring Boot 提供了灵活的配置文件加载机制，允许开发者通过多种方式配置应用程序。配置文件可以位于不同的路径下，并且 Spring Boot 会根据一定的顺序和优先级加载这些配置文件。理解这些加载顺序和优先级对于正确配置 Spring Boot 应用程序至关重要。

在实际开发中，建议将通用的配置项放在默认的 application.properties 或 application.yml 文件中，而将特定环境的配置项放在 application-{profile}.properties 或 application-{profile}.yml 文件中。此外，可以通过命令行参数或环境变量来覆盖配置文件中的配置项，以满足不同环境的需求。

通过合理使用 Spring Boot 的配置文件机制，开发者可以轻松管理应用程序的配置，确保应用程序在不同环境中都能正确运行。