ホームページ  >  記事  >  Java  >  SpringBoot application.yml と bootstrap.yml の違いは何ですか

SpringBoot application.yml と bootstrap.yml の違いは何ですか

王林
王林転載
2023-05-12 17:58:16773ブラウズ

SpringBoot は、デフォルトでプロパティと YAML の 2 つの形式の構成ファイルをサポートします。前者の形式は単純ですが、キーと値のペアのみをサポートします。リストを表現する必要がある場合は、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 によってロードされます。 application.yml の ApplicationContext がロードされる前に、親の Spring ApplicationContext が最初にロードされます。

なぜ構成サーバー情報を bootstrap.yml に入れる必要があるのですか?

Spring Cloud を使用する場合、通常、構成情報は構成サーバーから読み込まれますが、構成情報 (パスワードなど) を取得するには、初期のブート構成が必要です。したがって、この期間中に本当に必要な構成情報を読み込むために、構成サーバーの情報を bootstrap.yml に配置します。

3. 高度な使用シナリオ

コンテキストの開始

Spring Cloud は、Spring アプリケーションのアプリケーション コンテキストの親コンテキストとしてブートストラップ コンテキストを作成します。初期化中、ブートストラップ コンテキストは、外部ソースから構成プロパティを読み込み、構成を解析します。 2 つのコンテキストは外部から取得した環境を共有します。ブートストラップ プロパティは優先度が高く、デフォルトではローカル構成によって上書きされません。ブートストラップ コンテキストとアプリケーション コンテキストには異なる規則があるため、application.yml (または application.properties) の代わりに新しい bootstrap.yml ファイルが追加されます。ブートストラップ コンテキストとアプリケーション コンテキストの構成を確実に分離します。

bootstrap.yml

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

bootstrap.yml または application.yml に spring.application.name を設定することをお勧めします。ブートストラップを無効にする場合は、enabled= false。

アプリケーション コンテキストの階層

SpringApplication または SpringApplicationBuilder を通じてアプリケーション コンテキストを作成すると、親コンテキストのブートストラップ コンテキストが Spring アプリケーションのアプリケーション コンテキストに対して作成されます。 Spring には、子コンテキストが親クラスのプロパティ ソースとプロファイルを継承する機能があるため、Spring Cloud Config を使用しない場合と比較して、メイン アプリケーション コンテキストに追加のプロパティ ソースが追加されます。追加のプロパティ ソースは次のとおりです。

  • "bootstrap": PropertySourceLocator がブートストラップ コンテキストでスキャンされ、プロパティがある場合、それは CompositePropertySource に追加されます。 Spirng Cloud Config はこの方法でプロパティを追加します。詳細については、ソース コード ConfigServicePropertySourceLocator` を参照してください。以下にカスタマイズ例もあります。

  • "applicationConfig: [classpath:bootstrap.yml]" , (spring.profiles.active=production がある場合、たとえば applicationConfig: [classpath:/bootstrap.yml]# Production): bootstrap.yml を使用してブートストラップ コンテキストを構成する場合、その優先順位は application.yml よりも低くなります。これは、Spring Boot アプリケーションの一部として子コンテキストに追加されます。以下に紹介します。

優先ルールにより、ブートストラップ コンテキストには bootstrap.yml のデータは含まれませんが、デフォルト設定として使用できます。

提供するインターフェイスを使用するか、SpringApplicationBuilder に含まれるメソッド (parent()、child()、sibling()) を使用することで、作成したコンテキスト階層を簡単に拡張できます。 Bootstrap Context は最上位の親クラスになります。拡張された各コンテキストには、独自のブートストラップ プロパティ ソース (空の場合もあります) があります。拡張された各コンテキストには、異なる spring.application.name があります。原則として、同じレベルの親子コンテキストも異なる名前を持つため、Config Server の構成も異なります。子コンテキストのプロパティは、同じ名前を持つ場合、親コンテキストのプロパティをオーバーライドします。

SpringApplicationBuilder では環境をすべてのレベルで共有できますが、これはデフォルトではないことに注意してください。したがって、同じレベルの兄弟コンテキストは、親クラスと何かを共有していない場合、必ずしも同じプロファイルまたはプロパティ ソースを持つとは限りません。

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 中国語 Web サイトの他の関連記事を参照してください。

声明:
この記事はyisu.comで複製されています。侵害がある場合は、admin@php.cn までご連絡ください。