SpringCloud入門之經常使用的配置文件 application.yml和 bootstrap.yml區別

做者其餘技術文章

1) Spring Boot 簡介

2）SpringCloud入門之YAML格式文件規範學習

3）SpringCloud入門之Spring Boot多環境配置切換指南

4) Elasticsearch從入門到精通

5) Kibana從入門到精通

6) logstash快速入門實戰指南

7）Oracle性能優化之查詢語句通用原則  

8）Redis經常使用命令

9) 詳解Maven用戶的配置settings.xml

10）#ifndef、#def、#endif說明

 

SpringBoot默認支持properties和YAML兩種格式的配置文件。前者格式簡單，可是隻支持鍵值對。若是須要表達列表，最好使用YAML格式。SpringBoot支持自動加載約定名稱的配置文件，例如application.yml。若是是自定義名稱的配置文件，就要另找方法了。惋惜的是，不像前者有@PropertySource這樣方便的加載方式，後者的加載必須藉助編碼邏輯來實現。

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

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

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

bootstrap.yml 先於 application.yml 加載

2、典型的應用場景以下：

• 當使用 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，用來加載在這個時期真正須要的配置信息。

3、高級使用場景

啓動上下文

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將會被包含到應用。