SpringCloud入門之常用的配置檔案 application.yml和 bootstrap.yml區別

weixin_33981932發表於2018-04-13

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並且有屬性,則會新增到CompositePropertySourceSpirng 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 就是配置了profiledevelopment的配置檔案.

覆蓋遠端屬性

property sourcesbootstrap 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"));
    }
}

EnvironmentApplicationContext建立,並傳入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將會被包含到應用。

 

 
 

相關文章