クラス PropertyPlaceholderConfigurer

java.lang.ObjectSE
org.springframework.core.io.support.PropertiesLoaderSupport
org.springframework.beans.factory.config.PropertyResourceConfigurer
org.springframework.beans.factory.config.PlaceholderConfigurerSupport
org.springframework.beans.factory.config.PropertyPlaceholderConfigurer
実装されているすべてのインターフェース:
Aware, BeanFactoryAware, BeanNameAware, BeanFactoryPostProcessor, Ordered, PriorityOrdered
既知の直属サブクラス
PreferencesPlaceholderConfigurer
@DeprecatedSE(since="5.2", forRemoval=true) public class PropertyPlaceholderConfigurer extends PlaceholderConfigurerSupport
非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
5.2 は 8.0 で削除される予定です。代わりに、Environment および PropertySource メカニズムを活用してより柔軟な org.springframework.context.support.PropertySourcesPlaceholderConfigurer を使用してください。
${...} プレースホルダーを local properties および / またはシステムプロパティと環境変数に対して解決する PlaceholderConfigurerSupport サブクラス。

PropertyPlaceholderConfigurer は、次の場合に使用するのに適切です。

  • spring-context モジュールは使用できません（つまり、ApplicationContext ではなく Spring の BeanFactory API を使用しています）。
  • 既存の構成では、"systemPropertiesMode" および / または "systemPropertiesModeName" プロパティを使用します。ユーザーは、これらの設定の使用をやめて、コンテナーの Environment を介してプロパティソースの検索順序を設定することをお勧めします。ただし、PropertyPlaceholderConfigurer を引き続き使用することにより、機能の正確な保存を維持できます。
導入:
02.10.2003
作成者:
Juergen Hoeller, Chris Beams, Sam Brannen
関連事項:

  • フィールドの詳細

    • SYSTEM_PROPERTIES_MODE_NEVER

      public static final int SYSTEM_PROPERTIES_MODE_NEVER
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      システムプロパティを確認しないでください。
      関連事項:

    • SYSTEM_PROPERTIES_MODE_FALLBACK

      public static final int SYSTEM_PROPERTIES_MODE_FALLBACK
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      指定されたプロパティで解決できない場合は、システムプロパティを確認します。これがデフォルトです。
      関連事項:

    • SYSTEM_PROPERTIES_MODE_OVERRIDE

      public static final int SYSTEM_PROPERTIES_MODE_OVERRIDE
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      指定されたプロパティを試す前に、まずシステムプロパティを確認してください。これにより、システムプロパティが他のプロパティソースをオーバーライドできます。
      関連事項:

  • コンストラクターの詳細

    • PropertyPlaceholderConfigurer

      public PropertyPlaceholderConfigurer()
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  • メソッドの詳細

    • setSystemPropertiesModeName

      public void setSystemPropertiesModeName(StringSE constantName) throws IllegalArgumentExceptionSE
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      対応する定数の名前 (例: "SYSTEM_PROPERTIES_MODE_OVERRIDE" ) でシステムプロパティモードを設定します。
      パラメーター:
      constantName - 定数の名前
      例外:
      IllegalArgumentExceptionSE
      関連事項:

    • setSystemPropertiesMode

      public void setSystemPropertiesMode(int systemPropertiesMode)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      システムプロパティをフォールバック、オーバーライド、チェックしない方法を設定します。例:${user.dir} は "user.dir" システムプロパティに解決されます。

      デフォルトは「フォールバック」です: 指定されたプロパティでプレースホルダーを解決できない場合、システムプロパティが試行されます。「オーバーライド」は、指定されたプロパティを試す前に、最初にシステムプロパティをチェックします。「決して」は、システムプロパティをまったくチェックしません。

      関連事項:

    • setSearchSystemEnvironment

      public void setSearchSystemEnvironment(boolean searchSystemEnvironment)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      一致するシステムプロパティが見つからない場合に、一致するシステム環境変数を検索するかどうかを設定します。JVM システムプロパティをチェックした直後に、"systemPropertyMode" がアクティブ (つまり、「フォールバック」または「オーバーライド」) の場合にのみ適用されます。

      デフォルトは "true" です。この設定をオフにして、システム環境変数に対してプレースホルダーを解決しないようにします。一般に、JVM システムプロパティとして外部値を渡すことをお勧めします。これは、既存の環境変数であっても、起動スクリプトで簡単に実現できます。

      関連事項:

    • resolvePlaceholder

      protected @Nullable StringSE resolvePlaceholder(StringSE placeholder, PropertiesSE props, int systemPropertiesMode)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      特定のプロパティを使用して特定のプレースホルダーを解決し、特定のモードに従ってシステムプロパティチェックを実行します。

      デフォルトの実装は、システムプロパティチェックの前後に resolvePlaceholder (placeholder, props) に委譲します。

      サブクラスは、システムプロパティチェックのカスタマイズされたポイントを含む、カスタムの解決戦略に対してこれをオーバーライドできます。

      パラメーター:
      placeholder - 解決するプレースホルダー
      props - この設定のマージされたプロパティ
      systemPropertiesMode - このクラスの定数に応じたシステムプロパティモード
      戻り値:
      解決された値。ない場合は null
      関連事項:

    • resolvePlaceholder

      protected @Nullable StringSE resolvePlaceholder(StringSE placeholder, PropertiesSE props)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      指定されたプロパティを使用して、指定されたプレースホルダーを解決します。デフォルトの実装では、対応するプロパティキーをチェックするだけです。

      サブクラスは、カスタマイズされたプレースホルダーからキーへのマッピングまたはカスタム解決戦略に対して、これをオーバーライドできます。おそらく、フォールバックとして指定されたプロパティを使用するだけです。

      システムプロパティモードに従って、このメソッドが呼び出される前に、システムプロパティがそれぞれチェックされることに注意してください。

      パラメーター:
      placeholder - 解決するプレースホルダー
      props - この設定のマージされたプロパティ
      戻り値:
      null の解決された値（ない場合）
      関連事項:

    • resolveSystemProperty

      protected @Nullable StringSE resolveSystemProperty(StringSE key)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      指定されたキーを JVM システムプロパティとして解決します。また、一致するシステムプロパティが見つからない場合は、オプションでシステム環境変数としても解決します。
      パラメーター:
      key - システムプロパティキーとして解決するプレースホルダー
      戻り値:
      システムプロパティ値、または見つからない場合は null 
      関連事項:

    • processProperties

      protected void processProperties(ConfigurableListableBeanFactory beanFactoryToProcess, PropertiesSE props) throws BeansException
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      指定された Bean ファクトリの各 Bean 定義にアクセスし、${...} プロパティのプレースホルダーを指定されたプロパティの値で置き換えようとします。
      次で指定:
      クラス PropertyResourceConfigurer の processProperties 
      パラメーター:
      beanFactoryToProcess - アプリケーションコンテキストで使用される BeanFactory
      props - 適用するプロパティ
      例外:
      BeansException - エラーの場合