共有ライブラリのスプリングクラウドブートストラップのプロパティを管理する方法は？

Question

私は、Spring Cloud Config/Eurekaセットアップを使用するアプリケーションのための慎重な設定を提供するライブラリを構築中です。個々のマイクロサービスアプリにスプリングクラウド関連の定型文をほとんど、またはまったく持たないカスタムスターターとしてこの設定を提供することです。

この時点で、私がこのライブラリに入れたい共有構成の大部分は、bootstrap.ymlというもので構成されています。カスタムスタータにbootstrap.ymlを提供したいと思いますが、ライブラリを使用しているアプリケーションでも、spring.application.nameを適切に設定できる場合でも、独自のbootstrap.ymlを提供する必要があります。

bootstrap.ymlがクラスパスからロードされているため、アプリケーションに独自のbootstrap.ymlがある場合、Springは共有ライブラリのものを無視するようです。私はApplicationContextInitializerを使用しても、ブートストラップコンテキストが特別な方法で処理するため、環境をカスタマイズすることはできませんApplicationContextInitializers。

ここではどのようなアプローチが推奨されますか？私は、私たちのプロジェクトのすべてで定型文bootstrap.ymlを複製することなく、われわれの有名なブートストラップ設定を動作させるドロップインライブラリを提供したいと考えています。

Answer 1

私はこれに対する解決策を見つけることができました。このソリューションの目的は次のとおりです。

• 共有ライブラリのyamlファイルから値をロードします。
• ライブラリを使用しているアプリケーションが、環境にも読み込まれる独自のbootstrap.ymlを導入できるようにします。
• bootstrap.ymlの値は共有yamlの値を上書きする必要があります。

主な課題は、アプリケーションライフサイクルの適切な時点でコードを注入することです。具体的には、bootstrap.yml PropertySourceが環境に追加された後（カスタムPropertySourceを相対的に正しい順序で注入できるように）、アプリケーションがBeanの設定を開始する前に行う必要があります（設定値の制御動作）。

私が見つけた解決策は、カスタムEnvironmentPostProcessor

public class CloudyConfigEnvironmentPostProcessor implements EnvironmentPostProcessor, Ordered { 

    private YamlPropertySourceLoader loader; 

    public CloudyConfigEnvironmentPostProcessor() { 
     loader = new YamlPropertySourceLoader(); 
    } 

    @Override 
    public void postProcessEnvironment(ConfigurableEnvironment env, SpringApplication application) { 
     //ensure that the bootstrap file is only loaded in the bootstrap context 
     if (env.getPropertySources().contains("bootstrap")) { 
      //Each document in the multi-document yaml must be loaded separately. 
      //Start by loading the no-profile configs... 
      loadProfile("cloudy-bootstrap", env, null); 
      //Then loop through the active profiles and load them. 
      for (String profile: env.getActiveProfiles()) { 
       loadProfile("cloudy-bootstrap", env, profile); 
      } 
     } 
    } 

    private void loadProfile(String prefix, ConfigurableEnvironment env, String profile) { 
     try { 
      PropertySource<?> propertySource = loader.load(prefix + (profile != null ? "-" + profile: ""), new ClassPathResource(prefix + ".yml"), profile); 
      //propertySource will be null if the profile isn't represented in the yml, so skip it if this is the case. 
      if (propertySource != null) { 
       //add PropertySource after the "applicationConfigurationProperties" source to allow the default yml to override these. 
       env.getPropertySources().addAfter("applicationConfigurationProperties", propertySource); 
      } 
     } catch (IOException e) { 
      throw new RuntimeException(e); 
     } 
    } 

    @Override 
    public int getOrder() { 
     //must go after ConfigFileApplicationListener 
     return Ordered.HIGHEST_PRECEDENCE + 11; 
    } 

} 

を使用していたこのカスタムEnvironmentPostProcessorは、META-INF/spring.factoriesを介して注入することができます。

#Environment PostProcessors 
org.springframework.boot.env.EnvironmentPostProcessor=\ 
com.mycompany.cloudy.bootstrap.autoconfig.CloudyConfigEnvironmentPostProcessor 

カップルの事に注意する：

• YamlPropertySourceLoaderはyamlプロパティをプロファイルで読み込むため、 document yamlファイルを作成する必要があります。これは、プロファイルなしの設定を含め、実際に別のプロファイルを個別にロードする必要があります。
• ConfigFileApplicationListenerは、環境にbootstrap.yml（または通常のコンテキストではapplication.yml）を読み込むEnvironmentPostProcessorです。したがって、bootstrap.ymlプロパティに優先してカスタムyamlプロパティを優先的に配置するには、 ConfigFileApplicationListenerの後にカスタムのEnvironmentPostProcessorを注文します。

編集：初期の回答が機能しませんでした。私はこれをこのものに置き換えています。

Answer 2

META-INF/spring.factoriesファイルのorg.springframework.cloud.bootstrap.BootstrapConfigurationキーを使用すると、共有ライブラリのPropertySourceをブートストラッププロパティに追加できます。例えば

、あなたは以下を含むライブラリを作成することができます。

のsrc /メイン/ javaの/ COM /例/ MYLIB/MyLibConfig.java

package com.example.mylib; 

import org.springframework.context.annotation.Configuration; 
import org.springframework.context.annotation.PropertySource; 

@Configuration 
@PropertySource("classpath:mylib-config.properties") 
public class MyLibConfig { 
} 

のsrc /メイン/リソース/mylib-config.properties

eureka.instance.public=true 
# or whatever... 

のsrc /メイン/ resour CES/META-INF/spring.factories

org.springframework.cloud.bootstrap.BootstrapConfiguration=com.example.mylib.MyLibConfig 

---

詳細：http://projects.spring.io/spring-cloud/spring-cloud.html#_customizing_the_bootstrap_configuration