【springboot】配置文件加载顺序

引言

官方文档地址

Spring Boot Documentation
Spring Boot 2.3.x Externalized Configuration

Spring Boot的配置机制的重要性

在现代软件开发中，配置管理 是确保应用可在不同环境下平滑运行的关键因素之一。Spring Boot，作为一个广泛使用的Java企业级应用开发框架，提供了一个强大而灵活的配置系统，允许开发者通过简单的配置文件管理应用的行为和属性。

Spring Boot的配置机制的重要性体现在几个方面：

• 灵活性：开发者可以通过配置文件快速调整应用行为，而无需改动代码，这使得维护和部署变得更加容易。
• 环境适应性：通过为不同环境（如开发、测试和生产环境）提供不同的配置文件，Spring Boot应用可以无缝地迁移和适应各种部署环境。
• 简化开发：Spring Boot的自动配置特性大大减少了配置的复杂性和所需的样板代码，让开发者可以更专注于业务逻辑。

配置文件对Spring Boot应用的影响

配置文件在Spring Boot应用中的作用不仅仅是参数调整那么简单。它们直接影响着应用的安全性、性能、以及功能性。例如：

• 安全性：敏感信息如数据库密码可以通过配置文件配合Spring环境变量加以保护。
• 性能调优：数据库连接池的大小、线程池配置等性能相关的参数，都可以通过配置文件灵活调整。
• 功能开关：功能的启用与禁用，可以通过在配置文件中设置相应的属性来控制，这样做可以非常便捷地进行功能的迭代和测试。

通过以上概述，我们可以看到，配置文件在Spring Boot应用中扮演着至关重要的角色。接下来的章节，我们将详细探讨Spring Boot配置文件的种类、加载顺序以及如何通过配置实现环境适应性和功能控制。这将帮助开发者更好地理解和利用Spring Boot的配置机制，以优化应用的开发、部署和运行。

Spring Boot配置文件的种类

Spring Boot支持两种主要的配置文件格式：application.properties 和 application.yml。这两种格式都被广泛使用，它们各自有不同的特点和优势。

application.properties

application.properties 是一种传统的配置格式，使用简单的键值对来存储配置数据。这种格式易于阅读和编辑，非常适合简单的配置需求。例如：

server.port=8080
spring.datasource.url=jdbc:mysql://localhost/test
spring.datasource.username=dbuser
spring.datasource.password=dbpass

application.yml

application.yml 使用YAML（YAML Ain’t Markup Language）格式，这是一种面向数据序列化的格式，具有层次结构，更适合复杂或分层的配置结构。YAML文件通常更易于阅读和维护，特别是当配置项较多或需要更清晰的组织结构时。例如：

server:
  port: 8080

spring:
  datasource:
    url: jdbc:mysql://localhost/test
    username: dbuser
    password: dbpass

配置文件的格式选择（Properties vs YAML）

选择properties格式还是YAML格式，主要取决于个人偏好和项目需求：

• 简洁性 vs. 可读性：如果配置项不多，可能会倾向于使用.properties，因为它更简洁。而.yml文件由于支持层次结构，使得它在处理复杂或分层的配置时更为直观和易于管理。
• 错误容忍性：.properties文件在格式错误时通常更容易诊断和修复，而.yml文件对缩进非常敏感，一个小小的缩进错误就可能导致整个配置文件无法解析。
• 工具支持：大多数现代IDE都支持.properties和.yml，并提供语法高亮、自动完成和格式验证等功能，但对YAML的支持可能更为先进，特别是在视觉上区分不同层级时。

总的来说，选择哪种格式取决于您的具体需求和偏好。在复杂的应用配置中，YAML可能是更好的选择，因为它的层次结构可以帮助组织和管理大量的配置项。而对于简单的应用，properties文件可能已经足够。

配置文件的加载顺序

在Spring Boot中，配置文件的加载顺序和位置对于理解应用如何读取和优先处理不同配置来源至关重要。Spring Boot设计了一套复杂的加载顺序，以确保灵活性和细粒度控制。

Spring Boot配置文件的搜索位置

Spring Boot在启动时会从多个位置搜索配置文件，这些位置包括：

1. 当前目录下的/config子目录
2. 当前目录
3. 类路径下的/config包
4. 类路径的根目录

这些位置不仅包括你的应用内部资源，还包括外部设置，比如外部配置文件或通过命令行指定的配置。此外，Spring Boot也支持通过环境变量或系统属性来覆盖配置。

配置文件在不同位置的优先级

当存在多个配置文件时，Spring Boot需要决定哪些设置将被采用。这是通过确定每个配置来源的优先级来实现的。配置文件的加载优先级从高到低如下：

1. 命令行参数：通过命令行传递给应用的任何参数具有最高优先级。
2. 来自Java系统属性（System.getProperties()）的属性
3. 操作系统环境变量
4. application-{profile}.properties或application-{profile}.yml文件中的配置，按照Spring profiles的激活顺序应用（从后往前）
5. 应用打包外部的application.properties或application.yml（在config子目录中或当前目录下）
6. 应用打包内部的application.properties或application.yml（在config包中或类路径的根目录下）
7. 在@Configuration类上通过@PropertySource注解指定的属性文件
8. 默认属性

通过这种方式，Spring Boot允许在不同环境之间灵活切换配置，同时保持代码的整洁和维护性。这种优先级设置确保了在本地开发过程中可以轻松覆盖某些生产配置，而不必修改主配置文件。

环境特定的配置文件

Spring Boot支持基于不同环境（如开发、测试、生产等）使用特定的配置文件，这使得管理多环境配置变得非常简单和高效。这些环境特定的配置文件通常遵循命名约定 application-{profile}.properties 或 application-{profile}.yml，其中 {profile} 是指定的环境名称。

如何使用 application-{profile}.properties 或 application-{profile}.yml

1. 创建配置文件：

   • 对于每一个环境，创建一个对应的配置文件。例如，对于开发环境，你可能会有一个 application-dev.properties 或 application-dev.yml 文件；对于生产环境，则可能是 application-prod.properties 或 application-prod.yml。

2. 配置环境特定的参数：

   • 在这些文件中，你可以覆盖或定义默认配置文件（如 application.properties 或 application.yml）中的参数。这些环境特定的配置将会在相应的环境中被激活并覆盖默认配置。

激活特定的配置文件

激活环境特定的配置文件可以通过多种方式实现，包括环境变量和运行时参数：

1. 通过环境变量：

   • 可以通过设置环境变量 SPRING_PROFILES_ACTIVE 来指定活跃的配置文件。例如，在Linux或macOS系统中，你可以在启动应用之前设置环境变量：

     export SPRING_PROFILES_ACTIVE=dev
     java -jar your-app.jar
     

   • 在Windows系统中，设置环境变量的命令略有不同：

     set SPRING_PROFILES_ACTIVE=dev
     java -jar your-app.jar
     

2. 在运行时通过命令行参数：

   • 也可以在启动应用时直接通过命令行参数来激活特定的配置文件：

     java -jar your-app.jar --spring.profiles.active=dev
     

这种灵活的配置方式允许开发者根据不同环境轻松切换配置，而无需更改代码或进行复杂的配置管理，极大地简化了多环境部署和管理过程。

命令行参数的影响

命令行参数在Spring Boot应用中提供了一种非常强大的方式来覆盖配置文件中的属性。这种方法非常适合在不同环境下进行动态配置，特别是在生产环境或持续集成的部署过程中。

如何通过命令行参数覆盖配置文件中的属性

在Spring Boot中，你可以通过在启动应用时传递命令行参数来覆盖任何配置属性。命令行参数以--为前缀，后面跟属性名和等号连接的值。例如，如果你想覆盖server.port和数据库连接信息，可以这样做：

java -jar myapp.jar --server.port=9000 --spring.datasource.url=jdbc:mysql://localhost/proddb --spring.datasource.username=produser --spring.datasource.password=prodpass

这些参数直接传递给Spring Boot的main方法，Spring Boot会解析这些参数并将它们应用为配置属性。

命令行参数的优先级

命令行参数具有非常高的优先级，它们会覆盖除了一些特定的系统属性和API通过编程方式设置的属性之外的所有其他配置源。这意味着，无论配置文件中的设置如何，命令行参数都可以提供最终的配置值。

这种高优先级设计确保了开发者可以在不修改代码或配置文件的情况下，快速调整应用的行为，特别是在多环境部署和管理时非常有用。这也是为什么命令行参数在自动化部署和管理中是一种常用的技术。

总结来说，命令行参数在Spring Boot中提供了一种强大的机制，用于在应用启动时动态覆盖配置设置，这对于灵活地管理不同环境的配置非常关键。

外部配置的影响

在Spring Boot中，外部配置源是一种重要的配置手段，允许开发者在不修改代码的情况下调整应用的行为。这些配置源包括操作系统的环境变量、JVM的系统属性等，它们对于实现应用的灵活部署和管理至关重要。

外部配置源

操作系统环境变量：

• 环境变量可以在操作系统级别设置，Spring Boot可以通过环境变量来覆盖配置文件中的属性。例如，你可以设置SPRING_DATASOURCE_URL环境变量来指定数据库连接。

系统属性：

• 系统属性通常在启动JVM时通过命令行参数设置，如使用 -D 选项。例如，通过命令行启动应用时，可以使用 -Dspring.datasource.url=jdbc:mysql://localhost/test 来覆盖数据源的URL。

特定的Spring Boot外部配置文件：

• 例如，通过在命令行中使用 --spring.config.location 指定配置文件的路径，可以使应用加载不同的配置文件。

外部配置源的优先级

Spring Boot配置数据的优先级从高到低排序如下：

1. 命令行参数：直接在命令行中指定的参数具有最高的优先级。
2. 系统属性（JVM参数）：通过 -Dproperty=value 形式指定的系统属性。
3. 操作系统环境变量：在操作系统级别定义的环境变量。
4. 应用内部配置文件：如 application.properties 或 application.yml。
5. 应用内部默认属性：在代码中通过 @Value 或 @ConfigurationProperties 等注解设置的默认值。

这种优先级设置确保了开发者可以在不同的层级灵活地覆盖配置，适应各种部署环境的需要。例如，开发环境中可能通过环境变量设置某些参数，而在生产环境中通过命令行参数确保配置的正确性和安全性。这样的设计使得Spring Boot非常适合现代云基础设施和微服务架构，其中配置管理需要高度的灵活性和动态性。

实用案例：配置文件的实际应用

在Spring Boot应用中，配置文件的灵活使用可以极大地提高应用的可配置性和适应不同环境的能力。下面我将提供一个示例，展示如何加载和使用配置文件，以及配置优先级的实际影响。

示例代码：加载和使用配置文件

假设我们有一个简单的Spring Boot应用，我们将通过application.properties文件来配置它。此外，我们还将展示如何通过环境变量和命令行参数覆盖这些设置。

1. 创建配置文件 application.properties

在src/main/resources目录下创建一个文件名为application.properties的文件，内容如下：

app.name=MyApp
server.port=8080

2. 使用配置值

在Spring Boot应用中，你可以使用@Value注解来注入配置文件中的值。创建一个简单的Spring组件来使用这些配置：

package com.example.demo;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

@Component
public class AppConfig {
    @Value("${app.name}")
    private String appName;

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

    public void printConfig() {
        System.out.println("Application Name: " + appName);
        System.out.println("Server Port: " + serverPort);
    }
}

3. 主应用类

package com.example.demo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ConfigurableApplicationContext;

@SpringBootApplication
public class DemoApplication {

    public static void main(String[] args) {
        ConfigurableApplicationContext context = SpringApplication.run(DemoApplication.class, args);
        AppConfig config = context.getBean(AppConfig.class);
        config.printConfig();
    }
}

通过实例解释配置优先级的实际影响

假设你现在运行上述应用，它将输出默认的配置值。但如果你想在不同的环境中运行相同的应用，你可能需要改变这些值。这里是如何使用不同的配置源来覆盖application.properties中的值：

• 命令行参数：

  运行应用时，可以通过命令行参数指定不同的配置值：

  java -jar demo-0.0.1-SNAPSHOT.jar --app.name=ProductionApp --server.port=9090
  

  这将输出：

  Application Name: ProductionApp
  Server Port: 9090
  

• 环境变量：

  你也可以通过设置环境变量来覆盖配置。在Unix系统中，可以这样设置：

  export APP_NAME="EnvApp"
  export SERVER_PORT=8081
  java -jar demo-0.0.1-SNAPSHOT.jar
  

  注意，环境变量通常需要转换为大写，并且点（.）需要替换为下划线（_）。

这个例子展示了Spring Boot如何处理不同配置源的优先级，其中命令行参数具有最高优先级，其次是环境变量，最后是配置文件。这种灵活性允许开发者和运维人员在不同环境中轻松地调整应用配置。

配置文件加载的底层机制

Spring Boot的配置文件加载机制涉及复杂的解析和合并过程，这确保了来自不同来源的配置可以被适当地处理和优先级排序。这一机制的核心是PropertySources和Environment接口，它们在Spring框架中扮演着关键角色。

如何解析和合并不同来源的配置

Spring Boot使用一个非常灵活的策略来加载和合并配置，这个过程主要涉及以下几个步骤：

1. 初始化Environment对象：

   • Spring Boot启动时，会首先创建一个Environment对象，这个对象用于存储所有的配置信息。

2. 加载PropertySources：

   • PropertySources是一个包含多个PropertySource对象的容器，每个PropertySource代表一个配置数据源（如配置文件、环境变量、命令行参数等）。
   • Spring Boot按照特定的顺序将不同的PropertySource加入到Environment的PropertySources列表中。这个顺序决定了当不同的配置源包含相同的属性时，哪个源的配置会被优先使用。

3. 解析配置：

   • 当应用需要访问配置属性时，Spring Boot通过Environment接口提供的方法（如getProperty）查询PropertySources。
   • 查询过程遵循PropertySources中的顺序，从最高优先级开始，直到找到属性值为止。

PropertySources和Environment的角色

PropertySources：

• 这是配置源的集合，按照优先级排序。每个PropertySource可以是一个配置文件、环境变量集合或者其他任何可配置的属性集合。
• 它允许Spring Boot在运行时动态地添加、替换或者删除某些配置源，使得配置过程非常灵活。

Environment：

• Environment是一个更高级的接口，它提供了访问所有PropertySources的方法，并且可以处理属性占位符（如${jdbc.url}）的解析。
• 它是应用与当前环境交互的主要方式，不仅包括配置数据，还可能包括与运行环境相关的各种属性。

通过这种结构，Spring Boot能够有效地管理和维护来自不同来源的配置数据，确保应用配置的灵活性和可维护性。这种机制支持开发者在不同环境下使用相同的代码基础，通过外部配置来适应各种运行条件，极大地提升了开发效率和应用的可适应性。

常见面试题

在Spring Boot的面试中，了解配置文件的加载顺序是一个重要的考点，因为它关系到应用配置管理的核心理解。以下是一些关于Spring Boot配置文件加载顺序的常见面试题及其答案：

1. Spring Boot中配置文件的加载顺序是怎样的？

答： Spring Boot按照特定的顺序加载配置文件，这个顺序确保了更具体的配置可以覆盖更一般的配置。以下是常见的配置加载顺序：

1. 首先加载application.properties或application.yml文件中的默认配置。
2. 然后加载针对不同profile的配置文件，如application-{profile}.properties或application-{profile}.yml。
3. 接着加载操作系统环境变量。
4. 最后加载命令行参数。

命令行参数具有最高优先级，可以覆盖其他任何配置源的属性。

2. 如何在Spring Boot中设置特定环境的配置文件？

答： 在Spring Boot中，可以为不同的环境创建特定的配置文件，如application-dev.properties（开发环境）、application-test.properties（测试环境）和application-prod.properties（生产环境）。可以通过在启动应用时设置spring.profiles.active属性来指定活动的环境配置，例如通过命令行参数--spring.profiles.active=prod来激活生产环境配置。

3. Spring Boot如何处理配置文件中的属性冲突？

答： 如果同一个属性在多个配置源中被定义，Spring Boot将根据配置源的优先级来解决冲突。命令行参数的优先级最高，其次是系统环境变量、应用打包外部的配置文件、打包内的配置文件以及库中的默认设置。

4. 如何在Spring Boot应用中动态更改配置？

答：

1. 使用Spring Cloud Config Server：

   • Spring Cloud Config Server提供了一个中心化的配置服务，它可以从Git、SVN或本地文件系统中加载配置。应用可以在运行时从Config Server获取最新的配置并应用更新。
   • 通过暴露Actuator的/refresh端点，可以触发应用重新加载配置。

2. 使用配置中心如Nacos、Consul或Apollo：

   • 这些配置中心支持配置的动态更新和管理。它们提供了实时配置更新的功能，无需重启应用即可应用新的配置。
   • Nacos：作为一个更全面的服务发现和配置管理平台，Nacos支持数据的动态变更和访问。Spring Boot应用可以通过添加Nacos Config Starter依赖，并配置必要的属性来集成Nacos，实现配置的动态更新。
   • Consul：Consul提供了键值存储用于配置管理。通过Consul的Spring Cloud库，可以轻松地将Consul集成到Spring Boot应用中，实现配置的动态更新。
   • Apollo：Apollo是一个由CTrip开发的配置中心解决方案，它支持配置的版本管理、环境区分以及配置变更推送等功能。通过添加Apollo客户端依赖并配置服务细节，可以实现配置的动态更新。

3. 使用环境变量和系统属性：

   • 在某些情况下，可以通过修改环境变量或系统属性来调整应用的行为。虽然这通常需要重新启动应用，但在容器化部署环境中，如使用Docker或Kubernetes，这种方法可以通过重启容器的方式快速应用新的环境变量设置。

5. 解释@ConfigurationProperties与@Value的区别和用途？

答： @ConfigurationProperties用于将配置文件的属性绑定到一个带有字段的类上，通常用于加载配置的一组相关属性。它支持松散的绑定（如驼峰、下划线等命名方式）、复杂类型（如列表和地图）和验证。

@Value注解用于将单个配置值注入到Bean的字段中。它适用于简单值的注入，但不支持复杂类型和松散绑定。