SpringBoot中bootstrap.properties文件加载的原理是什么

# SpringBoot中bootstrap.properties文件加载的原理是什么

## 引言

在Spring Boot应用中，`bootstrap.properties`（或`bootstrap.yml`）是一个特殊的配置文件，它通常用于Spring Cloud环境下的应用启动阶段配置。与常见的`application.properties`不同，它的加载时机和用途有着本质区别。本文将深入剖析其加载原理，涵盖**加载时机、优先级机制、底层实现**等核心内容，并结合源码分析其工作原理。

---

## 一、bootstrap.properties的定位与作用

### 1.1 与application.properties的区别
| 特性                | bootstrap.properties       | application.properties      |
|---------------------|---------------------------|----------------------------|
| **加载阶段**         | 应用上下文初始化**之前**   | 应用上下文初始化**之后**     |
| **主要用途**         | 配置远程配置中心、加密信息 | 配置常规应用参数            |
| **依赖组件**         | 需`spring-cloud-starter`   | Spring Boot原生支持         |

### 1.2 典型使用场景
- 连接Spring Cloud Config Server获取远程配置
- 配置加密/解密相关的密钥（如Jasypt）
- 需要**最早加载**的基础参数（如日志初始化参数）

---

## 二、加载流程的核心原理

### 2.1 整体加载时序图
```mermaid
sequenceDiagram
    participant Bootstrap
    participant Application
    Bootstrap->>Bootstrap: 1. 创建Bootstrap上下文
    Bootstrap->>Bootstrap: 2. 加载bootstrap.properties
    Bootstrap->>Application: 3. 传递环境变量
    Application->>Application: 4. 创建主应用上下文
    Application->>Application: 5. 加载application.properties

2.2 关键阶段解析

阶段1：Bootstrap上下文初始化

通过BootstrapApplicationListener监听器触发：

// org.springframework.cloud.bootstrap.BootstrapApplicationListener
public void onApplicationEvent(ApplicationEnvironmentPreparedEvent event) {
    // 创建Bootstrap上下文
    ConfigurableApplicationContext context = bootstrapServiceContext(
        event.getEnvironment(), event.getSpringApplication());
}

阶段2：属性源(PropertySource)加载

1. 优先级排序：
   Bootstrap属性源会被插入到环境变量最前面，确保优先加载

   // PropertySourceBootstrapConfiguration
   public void initialize(ConfigurableApplicationContext context) {
      PropertySource<?> propertySource = propertySourceLocator.locate(environment);
      environment.getPropertySources().addFirst(propertySource);
   }
   

2. 文件定位逻辑：
   通过PropertySourceLocator实现类（如ConfigServicePropertySourceLocator）定位文件

三、深度源码分析

3.1 加载链条追踪

1. 启动入口：
   SpringApplication.run() → prepareEnvironment()

2. Bootstrap触发点：

   // SpringApplication
   private ConfigurableEnvironment prepareEnvironment(...) {
      // 发布ApplicationEnvironmentPreparedEvent事件
      listeners.environmentPrepared(bootstrapContext, environment);
   }
   

3. 属性源处理：
   BootstrapApplicationListener → BootstrapServiceContext → PropertySourceBootstrapConfiguration

3.2 关键类说明

四、配置优先级机制

4.1 属性源顺序规则

从高到低优先级： 1. 命令行参数（–key=value） 2. JNDI属性 3. Bootstrap属性（bootstrap.properties） 4. 应用属性（application.properties）

4.2 覆盖行为验证

# bootstrap.properties
spring.application.name=myapp-bootstrap
server.port=8888

# application.properties
server.port=8080

最终server.port取8080，因为虽然bootstrap先加载，但application属性会后置覆盖

五、与Spring Cloud的协同机制

5.1 远程配置加载流程

1. Bootstrap阶段读取spring.cloud.config.uri
2. 通过ConfigClientProperties发起远程请求
3. 将远程配置合并到环境变量

// ConfigServicePropertySourceLocator
public PropertySource<?> locate(Environment env) {
    // 通过RestTemplate获取远程配置
    ConfigClientProperties properties = this.defaultProperties.override(env);
    String[] labels = new String[] { "" };
    return loadRemoteConfiguration(properties, labels);
}

5.2 健康检查机制

通过/actuator/health端点可查看配置中心连接状态：

{
  "status": "UP",
  "components": {
    "configServer": {
      "status": "UP",
      "details": {
        "repository": "https://github.com/spring-cloud-samples/config-repo"
      }
    }
  }
}

六、常见问题解决方案

6.1 文件不加载的可能原因

1. 依赖缺失：未引入spring-cloud-starter-bootstrap

   
   <dependency>
      <groupId>org.springframework.cloud</groupId>
      <artifactId>spring-cloud-starter-bootstrap</artifactId>
   </dependency>
   

2. 命名错误：文件必须命名为bootstrap.properties（非.yml或其它）

3. Spring Boot版本冲突：
   Spring Boot 2.4+需要显式启用bootstrap：

   spring.config.use-legacy-processing=true
   

6.2 自定义扩展方案

实现自定义PropertySourceLocator：

@Configuration
public class CustomPropertySourceConfig {
    @Bean
    public PropertySourceLocator customLocator() {
        return env -> new MapPropertySource("custom", 
            Collections.singletonMap("custom.key", "value"));
    }
}

结论

bootstrap.properties的加载机制体现了Spring Boot在上下文分层设计上的精巧构思。通过独立的Bootstrap上下文实现： 1. 更早的配置加载时机 2. 更灵活的远程配置集成 3. 更清晰的配置隔离边界

理解这一原理，对于构建需要复杂配置管理的Spring Cloud应用具有重要意义。 “`