SpringBoot application.yml和bootstrap.yml的差別是什麼

SpringBoot預設支援properties和YAML兩種格式的設定檔。前者格式簡單，但是只支援鍵值對。如果需要表達列表，最好使用YAML格式。 SpringBoot支援自動載入約定名稱的設定文件，例如application.yml。如果是自訂名稱的設定文件，就要另找方法了。可惜的是，不像前者有@PropertySource這樣方便的載入方式，後者的載入必須藉由編碼邏輯來實現。

一、bootstrap.yml（bootstrap.properties）與application.yml（application.properties）執行順序

bootstrap.yml（bootstrap.properties）用來在程式引導時執行，應用於更早期配置資訊讀取，如可以使用來配置application.yml中使用到參數等

application.yml（application.properties) 應用程式特有配置信息，可以用來配置後續各個模組中需使用的公共參數等。

bootstrap.yml 先於application.yml 載入

二、典型的應用場景如下：

• 當使用Spring Cloud Config Server 的時候，你應該在bootstrap.yml 裡面指定spring.application.name 和spring.cloud.config.server.git.uri

• 和一些加密/解密的訊息

技術上，bootstrap.yml 是被一個父級的Spring ApplicationContext 載入的。這個父級的 Spring ApplicationContext是先載入的，在載入application.yml 的 ApplicationContext之前。

為何需要把 config server 的資訊放在 bootstrap.yml 裡？

當使用 Spring Cloud 的時候，設定資訊一般是從 config server 載入的，為了取得設定資訊（例如密碼等），你需要一些提早的引導設定。因此，把 config server 資訊放在 bootstrap.yml，用來載入這個時期真正需要的設定資訊。

三、進階使用場景

啟動上下文

Spring Cloud會建立一個Bootstrap Context，作為Spring應用的Application Context的父上下文。初始化的時候，Bootstrap Context負責從外部來源載入配置屬性並解析配置。這兩個上下文共用一個從外部取得的Environment。 Bootstrap屬性有高優先級，預設情況下，它們不會被本地配置覆蓋。 Bootstrap context和Application Context有著不同的約定，所以新增了bootstrap.yml文件，而不是使用application.yml (或application.properties)。確保Bootstrap Context和Application Context配置的分離。下面是一個例子：

bootstrap.yml

spring:
  application:
    name: foo
  cloud:
    config:
      uri: ${SPRING_CONFIG_URI:http://localhost:8888}

推薦在bootstrap.yml or application.yml裡面配置spring.application.name. 你可以透過設定spring.cloud.bootstrap.enabled= false來停用bootstrap。

應用上下文層次結構

如果你透過SpringApplication或SpringApplicationBuilder建立一個Application Context,那麼會為spring應用的Application Context建立父上下文Bootstrap Context。在Spring裡有個特性，子上下文會繼承父類別的property sources and profiles ，所以main application context 相對於沒有使用Spring Cloud Config，會新增額外的property sources。額外的property sources有：

• 「bootstrap」 : 如果在Bootstrap Context掃描到PropertySourceLocator並且有屬性，則會加入到CompositePropertySource。 Spirng Cloud Config就是透過這種方式來新增的屬性的，詳細看原始碼ConfigServicePropertySourceLocator`。下面也有一個例子自訂的例子。

• 「applicationConfig: [classpath:bootstrap.yml]」 ，（如果有spring.profiles.active=production則例如applicationConfig: [classpath:/bootstrap.yml]#production）:如果你使用bootstrap.yml來設定Bootstrap Context，他比application.yml優先權要低。它將添加到子上下文，作為Spring Boot應用程式的一部分。下文有介紹。

由於優先權規則，Bootstrap Context不包含從bootstrap.yml來的數據，但是可以用它作為預設設定。

你可以很容易的擴展任何你建立的上下文層次，可以使用它提供的接口，或者使用SpringApplicationBuilder包含的方法（parent()，child()，sibling()）。 Bootstrap Context將是最高等級的父類別。每一個擴充的Context都有自己的bootstrap property source（有可能是空的）。每一個擴充的Context都有不同spring.application.name。同一層層次的父子上下文原則上也有一有不同的名稱，因此，也會有不同的Config Server配置。子上下文的屬性在相同名字的情況下將覆蓋父上下文的屬性。

注意SpringApplicationBuilder允許共享Environment到所有層次，但是不是預設的。因此，同級的兄弟上下文不在和父類共享一些東西的時候不一定有相同的profiles或property sources。

修改Bootstrap屬性設定

原始碼位置BootstrapApplicationListener。

   String configName = environment.resolvePlaceholders("${spring.cloud.bootstrap.name:bootstrap}");

    String configLocation = environment.resolvePlaceholders("${spring.cloud.bootstrap.location:}");

    Map<String, Object> bootstrapMap = new HashMap<>();bootstrapMap.put("spring.config.name",configName);
    if(StringUtils.hasText(configLocation)){
        bootstrapMap.put("spring.config.location", configLocation);
    }

bootstrap.yml是由spring.cloud.bootstrap.name（默认:”bootstrap”）或者spring.cloud.bootstrap.location（默认空）。这些属性行为与spring.config.*类似，通过它的Environment来配置引导ApplicationContext。如果有一个激活的profile（来源于spring.profiles.active或者Environment的Api构建），例如bootstrap-development.properties 就是配置了profile为development的配置文件.

覆盖远程属性

property sources被bootstrap context 添加到应用通常通过远程的方式，比如”Config Server”。默认情况下，本地的配置文件不能覆盖远程配置，但是可以通过启动命令行参数来覆盖远程配置。如果需要本地文件覆盖远程文件，需要在远程配置文件里设置授权
spring.cloud.config.allowOverride=true（这个配置不能在本地被设置）。一旦设置了这个权限，你可以配置更加细粒度的配置来配置覆盖的方式，

比如：

• spring.cloud.config.overrideNone=true 覆盖任何本地属性

• spring.cloud.config.overrideSystemProperties=false 仅仅系统属性和环境变量
  源文件见PropertySourceBootstrapProperties

自定义启动配置

bootstrap context是依赖/META-INF/spring.factories文件里面的org.springframework.cloud.bootstrap.BootstrapConfiguration条目下面，通过逗号分隔的Spring @Configuration类来建立的配置。任何main application context需要的自动注入的Bean可以在这里通过这种方式来获取。这也是ApplicationContextInitializer建立@Bean的方式。可以通过@Order来更改初始化序列，默认是”last”。

# spring-cloud-context-1.1.1.RELEASE.jar
# spring.factories
# AutoConfiguration
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
org.springframework.cloud.autoconfigure.ConfigurationPropertiesRebinderAutoConfiguration,\
org.springframework.cloud.autoconfigure.RefreshAutoConfiguration,\
org.springframework.cloud.autoconfigure.RefreshEndpointAutoConfiguration,\
org.springframework.cloud.autoconfigure.LifecycleMvcEndpointAutoConfiguration

# Application Listeners
org.springframework.context.ApplicationListener=\
org.springframework.cloud.bootstrap.BootstrapApplicationListener,\
org.springframework.cloud.context.restart.RestartListener

# Bootstrap components
org.springframework.cloud.bootstrap.BootstrapConfiguration=\
org.springframework.cloud.bootstrap.config.PropertySourceBootstrapConfiguration,\
org.springframework.cloud.bootstrap.encrypt.EncryptionBootstrapConfiguration,\
org.springframework.cloud.autoconfigure.ConfigurationPropertiesRebinderAutoConfiguration,\
org.springframework.boot.autoconfigure.PropertyPlaceholderAutoConfiguration

警告

小心，你添加的自定义BootstrapConfiguration类没有错误的@ComponentScanned到你的主应用上下文，他们可能是不需要的。使用一个另外的包不被@ComponentScan或者@SpringBootApplication注解覆盖到。

bootstrap context通过spring.factories配置的类初始化的所有的Bean都会在SpingApplicatin启动前加入到它的上下文里去。

自定义引导配置来源：Bootstrap Property Sources
默认的property source添加额外的配置是通过配置服务（Config Server），你也可以自定义添加property source通过实现PropertySourceLocator接口来添加。你可以使用它加配置属性从不同的服务、数据库、或者其他。

下面是一个自定义的例子:

@Configuration
public class CustomPropertySourceLocator implements PropertySourceLocator {

    @Override
    public PropertySource<?> locate(Environment environment) {
        return new MapPropertySource("customProperty",
                Collections.<String, Object>singletonMap("property.from.sample.custom.source", "worked as intended"));
    }
}

Environment被ApplicationContext建立，并传入property sources（可能不同个profile有不同的属性），所以，你可以从Environment寻找找一些特别的属性。比如spring.application.name，它是默认的Config Server property source。

如果你建立了一个jar包，里面添加了一个META-INF/spring.factories文件：

org.springframework.cloud.bootstrap.BootstrapConfiguration=sample.custom.CustomPropertySourceLocator

那么，”customProperty“的PropertySource将会被包含到应用。

以上是SpringBoot application.yml和bootstrap.yml的差別是什麼的詳細內容。更多資訊請關注PHP中文網其他相關文章！