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應用具有重要意義。 “`