SpringBoot?application.yml和bootstrap.yml的區別是什么

本篇內容介紹了“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的區別是什么”的內容就介紹到這里了，感謝大家的閱讀。如果想了解更多行業相關的知識可以關注億速云網站，小編將為大家輸出更多高質量的實用文章！