クラス AbstractEnvironment

メソッドの詳細

• createPropertyResolver

  protected ConfigurablePropertyResolver createPropertyResolver(MutablePropertySources propertySources)

  環境で使用される ConfigurablePropertyResolver インスタンスの作成に使用されるファクトリメソッド。

  導入:

  5.3.4

  関連事項:

  • getPropertyResolver()

• getPropertyResolver

  protected final ConfigurablePropertyResolver getPropertyResolver()

  Environment によって使用されている ConfigurablePropertyResolver を返します。

  導入:

  5.3.4

  関連事項:

  • createPropertyResolver(MutablePropertySources)

• customizePropertySources

  protected void customizePropertySources(MutablePropertySources propertySources)

  getProperty(String) および関連メソッドの呼び出し中にこの Environment によって検索される PropertySource オブジェクトのセットをカスタマイズします。

  このメソッドをオーバーライドするサブクラスは、MutablePropertySources.addLast(PropertySource) を使用してプロパティソースを追加することをお勧めします。これにより、さらにサブクラスが予測可能な結果で super.customizePropertySources() を呼び出すことができます。例：

   public class Level1Environment extends AbstractEnvironment {
       @Override
       protected void customizePropertySources(MutablePropertySources propertySources) {
           super.customizePropertySources(propertySources); // no-op from base class
           propertySources.addLast(new PropertySourceA(...));
           propertySources.addLast(new PropertySourceB(...));
       }
   }
  
   public class Level2Environment extends Level1Environment {
       @Override
       protected void customizePropertySources(MutablePropertySources propertySources) {
           super.customizePropertySources(propertySources); // add all from superclass
           propertySources.addLast(new PropertySourceC(...));
           propertySources.addLast(new PropertySourceD(...));
       }
   }
   

  この配置では、プロパティはソース A、B、C、D の順に解決されます。つまり、プロパティソース "A" はプロパティソース "D" よりも優先されます。Level2Environment サブクラスがプロパティソース C および D に A および B よりも高い優先順位を与えたい場合は、Level2Environment を独自に追加する前ではなく、後で super.customizePropertySources を呼び出すだけです。

   public class Level2Environment extends Level1Environment {
       @Override
       protected void customizePropertySources(MutablePropertySources propertySources) {
           propertySources.addLast(new PropertySourceC(...));
           propertySources.addLast(new PropertySourceD(...));
           super.customizePropertySources(propertySources); // add all from superclass
       }
   }
   

  検索順序は、必要に応じて C、D、A、B になりました。

  これらの推奨事項に加えて、サブクラスは、必要なプロパティソースの正確な配置を作成するために、MutablePropertySources によって公開される add*、remove、replace メソッドのいずれかを使用できます。

  基本実装はプロパティソースを登録しません。

  ConfigurableEnvironment のクライアントは、通常 ApplicationContextInitializer 内で、getPropertySources() アクセサーを介してプロパティソースをさらにカスタマイズできることに注意してください。例：

   ConfigurableEnvironment env = new StandardEnvironment();
   env.getPropertySources().addLast(new PropertySourceX(...));
   

  インスタンス変数へのアクセスに関する警告

  サブクラスで宣言され、デフォルトの初期値を持つインスタンス変数には、このメソッド内からアクセスしないでください。Java オブジェクトの作成ライフサイクルの制約により、このコールバックが AbstractEnvironment() コンストラクターによって呼び出されたときに初期値がまだ割り当てられていないため、NullPointerException またはその他の問題が発生する可能性があります。インスタンス変数のデフォルト値にアクセスする必要がある場合は、このメソッドを何もしないで、サブクラスコンストラクター内でプロパティソース操作とインスタンス変数アクセスを直接実行します。インスタンス変数に値を割り当てることには問題がないことに注意してください。避けなければならないデフォルト値を読み取ろうとしているだけです。

  関連事項:

  • MutablePropertySources
  • PropertySourcesPropertyResolver
  • ApplicationContextInitializer

• getReservedDefaultProfiles

  protected SetSE<StringSE> getReservedDefaultProfiles()

  予約済みのデフォルトのプロファイル名のセットを返します。この実装は "default" を返します。予約された名前のセットをカスタマイズするために、サブクラスがオーバーライドする場合があります。

  関連事項:

  • RESERVED_DEFAULT_PROFILE_NAME
  • doGetDefaultProfiles()

• getActiveProfiles

  public StringSE[] getActiveProfiles()

  インターフェースからコピーされた説明: Environment

  この環境で明示的にアクティブにされたプロファイルのセットを返します。プロファイルは、デプロイ環境などに基づいて、条件付きで登録される Bean 定義の論理グループを作成するために使用されます。プロファイルをアクティブにするには、"spring.profiles.active" をシステムプロパティとして設定するか、ConfigurableEnvironment.setActiveProfiles(String...) を呼び出します。

  アクティブとして明示的に指定されたプロファイルがない場合は、デフォルトのプロファイルが自動的にアクティブになります。

  次で指定:

  インターフェース Environment の getActiveProfiles 

  関連事項:

  • Environment.getDefaultProfiles()
  • ConfigurableEnvironment.setActiveProfiles(java.lang.String...)
  • ACTIVE_PROFILES_PROPERTY_NAME

• doGetActiveProfiles

  protected SetSE<StringSE> doGetActiveProfiles()

  setActiveProfiles(java.lang.String...) を介して明示的に設定されたアクティブなプロファイルのセットを返すか、現在のアクティブなプロファイルのセットが空の場合は、doGetActiveProfilesProperty() の存在を確認し、その値をアクティブなプロファイルのセットに割り当てます。

  関連事項:

  • getActiveProfiles()
  • doGetActiveProfilesProperty()

• doGetActiveProfilesProperty

  @Nullable protected StringSE doGetActiveProfilesProperty()

  アクティブなプロファイルのプロパティ値を返します。

  導入:

  5.3.4

  関連事項:

  • ACTIVE_PROFILES_PROPERTY_NAME

• setActiveProfiles

  public void setActiveProfiles(StringSE... profiles)

  インターフェースからコピーされた説明: ConfigurableEnvironment

  この Environment に対してアクティブなプロファイルのセットを指定します。コンテナーのブートストラップ中にプロファイルが評価され、Bean 定義をコンテナーに登録する必要があるかどうかが判別されます。

  既存のアクティブなプロファイルは、指定された引数で置き換えられます。引数なしで呼び出し、現在のアクティブなプロファイルのセットをクリアします。ConfigurableEnvironment.addActiveProfile(java.lang.String) を使用して、既存のセットを保持しながらプロファイルを追加します。

  次で指定:

  インターフェース ConfigurableEnvironment の setActiveProfiles 

  関連事項:

  • ConfigurableEnvironment.addActiveProfile(java.lang.String)
  • ConfigurableEnvironment.setDefaultProfiles(java.lang.String...)
  • Profile
  • ACTIVE_PROFILES_PROPERTY_NAME

• addActiveProfile

  public void addActiveProfile(StringSE profile)

  インターフェースからコピーされた説明: ConfigurableEnvironment

  現在のアクティブなプロファイルのセットにプロファイルを追加します。

  次で指定:

  インターフェース ConfigurableEnvironment の addActiveProfile 

  関連事項:

  • ConfigurableEnvironment.setActiveProfiles(java.lang.String...)

• getDefaultProfiles

  public StringSE[] getDefaultProfiles()

  インターフェースからコピーされた説明: Environment

  アクティブなプロファイルが明示的に設定されていない場合、デフォルトでアクティブになるプロファイルのセットを返します。

  次で指定:

  インターフェース Environment の getDefaultProfiles 

  関連事項:

  • Environment.getActiveProfiles()
  • ConfigurableEnvironment.setDefaultProfiles(java.lang.String...)
  • DEFAULT_PROFILES_PROPERTY_NAME

• doGetDefaultProfiles

  protected SetSE<StringSE> doGetDefaultProfiles()

  setDefaultProfiles(String...) を介して明示的に設定されたデフォルトプロファイルのセットを返すか、現在のデフォルトプロファイルのセットが予約済みのデフォルトプロファイルのみで構成されている場合は、doGetActiveProfilesProperty() の存在を確認し、その値（存在する場合）をデフォルトプロファイルのセットに割り当てます。

  関連事項:

  • AbstractEnvironment()
  • getDefaultProfiles()
  • getReservedDefaultProfiles()
  • doGetDefaultProfilesProperty()

• doGetDefaultProfilesProperty

  @Nullable protected StringSE doGetDefaultProfilesProperty()

  デフォルトプロファイルのプロパティ値を返します。

  導入:

  5.3.4

  関連事項:

  • DEFAULT_PROFILES_PROPERTY_NAME

• setDefaultProfiles

  public void setDefaultProfiles(StringSE... profiles)

  他のプロファイルが setActiveProfiles(java.lang.String...) を介して明示的にアクティブにされない場合、デフォルトでアクティブになるプロファイルのセットを指定します。

  このメソッドを呼び出すと、環境の構築中に追加された可能性がある予約済みのデフォルトプロファイルがすべて削除されます。

  次で指定:

  インターフェース ConfigurableEnvironment の setDefaultProfiles 

  関連事項:

  • AbstractEnvironment()
  • getReservedDefaultProfiles()

• acceptsProfiles

  @DeprecatedSE public boolean acceptsProfiles(StringSE... profiles)

  使用すべきではありません。

  インターフェースからコピーされた説明: Environment

  指定されたプロファイルの 1 つ以上がアクティブかどうか、明示的にアクティブなプロファイルがない場合は、指定されたプロファイルの 1 つ以上がデフォルトプロファイルのセットに含まれているかどうかを判断します。

  プロフィールが "!" で始まる場合ロジックは反転します。つまり、指定されたプロファイルがアクティブでない場合、このメソッドは true を返します。例: プロファイル "p1" がアクティブであるか、"p2" がアクティブでない場合、env.acceptsProfiles("p1", "!p2") は true を返します。

  次で指定:

  インターフェース Environment の acceptsProfiles 

  関連事項:

  • Environment.getActiveProfiles()
  • Environment.getDefaultProfiles()
  • Environment.matchesProfiles(String...)
  • Environment.acceptsProfiles(Profiles)

• acceptsProfiles

  public boolean acceptsProfiles(Profiles profiles)

  インターフェースからコピーされた説明: Environment

  指定された Profiles 述語がアクティブプロファイルと一致するかどうかを判断します。または、明示的なアクティブプロファイルがない場合は、指定された Profiles 述語がデフォルトプロファイルと一致するかどうかを判断します。

  プロファイル式を文字列として直接指定したい場合は、代わりに Environment.matchesProfiles(String...) を使用してください。

  次で指定:

  インターフェース Environment の acceptsProfiles 

  関連事項:

  • Environment.matchesProfiles(String...)
  • Profiles.of(String...)

• isProfileActive

  protected boolean isProfileActive(StringSE profile)

  指定されたプロファイルがアクティブかどうか、アクティブなプロファイルが空の場合、デフォルトでプロファイルをアクティブにするかどうかを返します。

  例外:

  IllegalArgumentExceptionSE - validateProfile(String) あたり

• validateProfile

  protected void validateProfile(StringSE profile)

  アクティブまたはデフォルトのプロファイルのセットに追加する前に内部的に呼び出される、指定されたプロファイルを検証します。

  サブクラスは、プロファイル構文にさらに制限を課すためにオーバーライドできます。

  例外:

  IllegalArgumentExceptionSE - プロファイルが null、空、空白のみ、またはプロファイル NOT 演算子（!）で始まる場合。

  関連事項:

  • acceptsProfiles(java.lang.String...)
  • addActiveProfile(java.lang.String)
  • setDefaultProfiles(java.lang.String...)

• getPropertySources

  public MutablePropertySources getPropertySources()

  インターフェースからコピーされた説明: ConfigurableEnvironment

  この Environment の PropertySources を変更可能な形式で返し、この Environment オブジェクトに対するプロパティを解決するときに検索する必要がある PropertySource オブジェクトのセットを操作できるようにします。addFirst、addLast、addBefore、addAfter などのさまざまな MutablePropertySources メソッドにより、プロパティソースの順序をきめ細かく制御できます。これは、たとえば、特定のユーザー定義のプロパティソースが、システムプロパティのセットやシステム環境変数のセットなどのデフォルトのプロパティソースよりも優先して検索されるようにする場合に役立ちます。

  次で指定:

  インターフェース ConfigurableEnvironment の getPropertySources 

  関連事項:

  • customizePropertySources(org.springframework.core.env.MutablePropertySources)

• getSystemProperties

  public MapSE<StringSE,ObjectSE> getSystemProperties()

  インターフェースからコピーされた説明: ConfigurableEnvironment

  System.getProperties() の値を返します。

  ほとんどの Environment 実装には、このシステムプロパティマップがデフォルトの PropertySource として含まれることに注意してください。他のプロパティソースをバイパスすることが明確に意図されていない限り、このメソッドを直接使用しないことをお勧めします。

  次で指定:

  インターフェース ConfigurableEnvironment の getSystemProperties 

• getSystemEnvironment

  public MapSE<StringSE,ObjectSE> getSystemEnvironment()

  インターフェースからコピーされた説明: ConfigurableEnvironment

  System.getenv() の値を返します。

  ほとんどの Environment 実装には、このシステム環境マップが検索されるデフォルトの PropertySource として含まれることに注意してください。他のプロパティソースをバイパスすることが明確に意図されていない限り、このメソッドを直接使用しないことをお勧めします。

  次で指定:

  インターフェース ConfigurableEnvironment の getSystemEnvironment 

• suppressGetenvAccess

  protected boolean suppressGetenvAccess()

  getSystemEnvironment() の目的で System.getenv()/System.getenv(String)SE アクセスを抑制するかどうかを決定します。

  このメソッドが true を返す場合、通常のシステム環境マップの代わりに空のダミーマップが使用され、getenv を呼び出そうとしないため、セキュリティマネージャーの警告（存在する場合）が回避されます。

  デフォルトの実装では、"spring.getenv.ignore" システムプロパティがチェックされ、値が "true" の場合は true が返されます。

  関連事項:

  • IGNORE_GETENV_PROPERTY_NAME
  • SpringProperties.getFlag(java.lang.String)

• merge

  public void merge(ConfigurableEnvironment parent)

  インターフェースからコピーされた説明: ConfigurableEnvironment

  指定された親環境のアクティブプロファイル、デフォルトプロファイル、プロパティソースを、この（子）環境のそれぞれのコレクションに追加します。

  親と子の両方に存在する同じ名前の PropertySource インスタンスの場合、子インスタンスは保持され、親インスタンスは破棄されます。これには、子によるプロパティソースのオーバーライドを許可するだけでなく、一般的なプロパティソース型を介した冗長な検索を回避する効果があります。システム環境とシステムプロパティ。

  混乱や冗長なストレージを回避するために、アクティブなプロファイル名とデフォルトのプロファイル名も重複がないようにフィルタリングされます。

  いずれの場合も、親環境は変更されません。merge の呼び出し後に発生した親環境への変更は、子には反映されないことに注意してください。merge を呼び出す前に、親プロパティソースとプロファイル情報を構成するように注意する必要があります。

  次で指定:

  インターフェース ConfigurableEnvironment の merge 

  パラメーター:

  parent - マージする環境

  関連事項:

  • AbstractApplicationContext.setParent(org.springframework.context.ApplicationContext)

• getConversionService

  public ConfigurableConversionService getConversionService()

  インターフェースからコピーされた説明: ConfigurablePropertyResolver

  プロパティの型変換を実行するときに使用される ConfigurableConversionService を返します。

  返される変換サービスの構成可能な性質により、個々の Converter インスタンスを簡単に追加および削除できます。

   ConfigurableConversionService cs = env.getConversionService();
   cs.addConverter(new FooConverter());
   

  次で指定:

  インターフェース ConfigurablePropertyResolver の getConversionService 

  関連事項:

  • PropertyResolver.getProperty(String, Class)
  • ConverterRegistry.addConverter(org.springframework.core.convert.converter.Converter<?, ?>)

• setConversionService

  public void setConversionService(ConfigurableConversionService conversionService)

  インターフェースからコピーされた説明: ConfigurablePropertyResolver

  プロパティで型変換を実行するときに使用する ConfigurableConversionService を設定します。

  注意 : ConversionService を完全に置き換える代わりに、ConfigurablePropertyResolver.getConversionService() にドリルして #addConverter などのメソッドを呼び出すことにより、個々の Converter インスタンスを追加または削除することを検討してください。

  次で指定:

  インターフェース ConfigurablePropertyResolver の setConversionService 

  関連事項:

  • PropertyResolver.getProperty(String, Class)
  • ConfigurablePropertyResolver.getConversionService()
  • ConverterRegistry.addConverter(org.springframework.core.convert.converter.Converter<?, ?>)

• setPlaceholderPrefix

  public void setPlaceholderPrefix(StringSE placeholderPrefix)

  インターフェースからコピーされた説明: ConfigurablePropertyResolver

  このリゾルバーで置き換えられたプレースホルダーが開始する必要がある接頭辞を設定します。

  次で指定:

  インターフェース ConfigurablePropertyResolver の setPlaceholderPrefix 

• setPlaceholderSuffix

  public void setPlaceholderSuffix(StringSE placeholderSuffix)

  インターフェースからコピーされた説明: ConfigurablePropertyResolver

  このリゾルバーで置き換えられたプレースホルダーが終了する必要があるサフィックスを設定します。

  次で指定:

  インターフェース ConfigurablePropertyResolver の setPlaceholderSuffix 

• setValueSeparator

  public void setValueSeparator(@Nullable StringSE valueSeparator)

  インターフェースからコピーされた説明: ConfigurablePropertyResolver

  このリゾルバーによって置き換えられたプレースホルダーとそれに関連付けられたデフォルト値の間の区切り文字を指定します。そのような特殊文字を値のセパレーターとして処理する必要がない場合は、null を指定します。

  次で指定:

  インターフェース ConfigurablePropertyResolver の setValueSeparator 

• setIgnoreUnresolvableNestedPlaceholders

  public void setIgnoreUnresolvableNestedPlaceholders(boolean ignoreUnresolvableNestedPlaceholders)

  インターフェースからコピーされた説明: ConfigurablePropertyResolver

  特定のプロパティの値内にネストされた解決できないプレースホルダーに遭遇したときに例外をスローするかどうかを設定します。false 値は、厳密な解決、つまり例外がスローされることを示します。true 値は、解決できないネストされたプレースホルダーが、解決されていない ${...} 形式で渡されることを示します。

  PropertyResolver.getProperty(String) とそのバリアントの実装は、プロパティ値に解決できないプレースホルダーが含まれている場合、ここで設定された値をインスペクションして正しい動作を決定する必要があります。

  次で指定:

  インターフェース ConfigurablePropertyResolver の setIgnoreUnresolvableNestedPlaceholders 

• setRequiredProperties

  public void setRequiredProperties(StringSE... requiredProperties)

  インターフェースからコピーされた説明: ConfigurablePropertyResolver

  ConfigurablePropertyResolver.validateRequiredProperties() によって検証される、存在する必要があるプロパティを指定します。

  次で指定:

  インターフェース ConfigurablePropertyResolver の setRequiredProperties 

• validateRequiredProperties

  public void validateRequiredProperties() throws MissingRequiredPropertiesException

  インターフェースからコピーされた説明: ConfigurablePropertyResolver

  ConfigurablePropertyResolver.setRequiredProperties(java.lang.String...) で指定された各プロパティが存在し、null 以外の値に解決されることを確認します。

  次で指定:

  インターフェース ConfigurablePropertyResolver の validateRequiredProperties 

  例外:

  MissingRequiredPropertiesException - 必要なプロパティのいずれかが解決できない場合。

• containsProperty

  public boolean containsProperty(StringSE key)

  インターフェースからコピーされた説明: PropertyResolver

  指定されたプロパティキーが解決に使用できるかどうか、つまり指定されたキーの値が null でないかどうかを返します。

  次で指定:

  インターフェース PropertyResolver の containsProperty 

• getProperty

  @Nullable public StringSE getProperty(StringSE key)

  インターフェースからコピーされた説明: PropertyResolver

  指定されたキーに関連付けられているプロパティ値を返します。キーを解決できない場合は null を返します。

  次で指定:

  インターフェース PropertyResolver の getProperty 

  パラメーター:

  key - 解決するプロパティ名

  関連事項:

  • PropertyResolver.getProperty(String, String)
  • PropertyResolver.getProperty(String, Class)
  • PropertyResolver.getRequiredProperty(String)

• getProperty

  public StringSE getProperty(StringSE key, StringSE defaultValue)

  インターフェースからコピーされた説明: PropertyResolver

  指定されたキーに関連付けられているプロパティ値を返します。キーを解決できない場合は defaultValue を返します。

  次で指定:

  インターフェース PropertyResolver の getProperty 

  パラメーター:

  key - 解決するプロパティ名

  defaultValue - 値が見つからない場合に返すデフォルト値

  関連事項:

  • PropertyResolver.getRequiredProperty(String)
  • PropertyResolver.getProperty(String, Class)

• getProperty

  @Nullable public <T> T getProperty(StringSE key, ClassSE<T> targetType)

  インターフェースからコピーされた説明: PropertyResolver

  指定されたキーに関連付けられているプロパティ値を返します。キーを解決できない場合は null を返します。

  次で指定:

  インターフェース PropertyResolver の getProperty 

  パラメーター:

  key - 解決するプロパティ名

  targetType - プロパティ値の予想される型

  関連事項:

  • PropertyResolver.getRequiredProperty(String, Class)

• getProperty

  public <T> T getProperty(StringSE key, ClassSE<T> targetType, T defaultValue)

  インターフェースからコピーされた説明: PropertyResolver

  指定されたキーに関連付けられているプロパティ値を返します。キーを解決できない場合は defaultValue を返します。

  次で指定:

  インターフェース PropertyResolver の getProperty 

  パラメーター:

  key - 解決するプロパティ名

  targetType - プロパティ値の予想される型

  defaultValue - 値が見つからない場合に返すデフォルト値

  関連事項:

  • PropertyResolver.getRequiredProperty(String, Class)

• getRequiredProperty

  public StringSE getRequiredProperty(StringSE key) throws IllegalStateExceptionSE

  インターフェースからコピーされた説明: PropertyResolver

  指定されたキーに関連付けられているプロパティ値を返します（決して null はありません）。

  次で指定:

  インターフェース PropertyResolver の getRequiredProperty 

  例外:

  IllegalStateExceptionSE - キーを解決できない場合

  関連事項:

  • PropertyResolver.getRequiredProperty(String, Class)

• getRequiredProperty

  public <T> T getRequiredProperty(StringSE key, ClassSE<T> targetType) throws IllegalStateExceptionSE

  インターフェースからコピーされた説明: PropertyResolver

  指定されたキーに関連付けられたプロパティ値を、指定された targetType (null ではない) に変換して返します。

  次で指定:

  インターフェース PropertyResolver の getRequiredProperty 

  例外:

  IllegalStateExceptionSE - 指定されたキーを解決できない場合

• resolvePlaceholders

  public StringSE resolvePlaceholders(StringSE text)

  インターフェースからコピーされた説明: PropertyResolver

  指定されたテキストの ${...} プレースホルダーを解決し、PropertyResolver.getProperty(java.lang.String) によって解決された対応するプロパティ値に置き換えます。デフォルト値のない解決できないプレースホルダーは無視され、変更されずに渡されます。

  次で指定:

  インターフェース PropertyResolver の resolvePlaceholders 

  パラメーター:

  text - 解決する文字列

  戻り値:

  解決された文字列 (非 null)

  関連事項:

  • PropertyResolver.resolveRequiredPlaceholders(java.lang.String)

• resolveRequiredPlaceholders

  public StringSE resolveRequiredPlaceholders(StringSE text) throws IllegalArgumentExceptionSE

  インターフェースからコピーされた説明: PropertyResolver

  指定されたテキストの ${...} プレースホルダーを解決し、PropertyResolver.getProperty(java.lang.String) によって解決された対応するプロパティ値に置き換えます。デフォルト値のない解決できないプレースホルダーは、IllegalArgumentException をスローします。

  次で指定:

  インターフェース PropertyResolver の resolveRequiredPlaceholders 

  戻り値:

  解決された文字列 (非 null)

  例外:

  IllegalArgumentExceptionSE - 指定されたテキストが null である場合、または解決できないプレースホルダーがある場合

• toString

  public StringSE toString()

  オーバーライド:

  クラス ObjectSE の toString