クラス PropertiesFactoryBean

java.lang.ObjectSE
org.springframework.core.io.support.PropertiesLoaderSupport
org.springframework.beans.factory.config.PropertiesFactoryBean
実装されたすべてのインターフェース:
FactoryBean<PropertiesSE>InitializingBean

public class PropertiesFactoryBean extends PropertiesLoaderSupport implements FactoryBean<PropertiesSE>, InitializingBean
Bean ファクトリの Properties インスタンスとして使用可能なクラスパスの場所からプロパティファイルを作成できます。Bean 参照を介して型 Properties の Bean プロパティを設定するために使用できます。

プロパティファイルからの読み込みや、この FactoryBean でのローカルプロパティの設定をサポートします。作成された Properties インスタンスは、ロードされた値とローカル値からマージされます。場所もローカルプロパティも設定されていない場合、初期化時に例外がスローされます。

各リクエストでシングルトンまたは新しいオブジェクトを作成できます。デフォルトはシングルトンです。

作成者:
Juergen Hoeller
関連事項:
  • コンストラクターの詳細

    • PropertiesFactoryBean

      public PropertiesFactoryBean()
  • メソッドの詳細

    • setSingleton

      public final void setSingleton(boolean singleton)
      共有の「シングルトン」プロパティインスタンスを作成するか、各リクエストで新しいプロパティインスタンスを作成するかを設定します。

      デフォルトは "true" (共有シングルトン)です。

    • isSingleton

      public final boolean isSingleton()
      インターフェースからコピーされた説明: FactoryBean
      このファクトリによって管理されるオブジェクトはシングルトンですか? つまり、FactoryBean.getObject() は常に同じオブジェクト(キャッシュ可能な参照)を返しますか?

      注意 : FactoryBean がシングルトンオブジェクトを保持することを示す場合、getObject() から返されたオブジェクトは所有 BeanFactory によってキャッシュされる可能性があります。FactoryBean が常に同じ参照を公開しない限り、true を返さないでください。

      FactoryBean 自体のシングルトンステータスは、通常、所有する BeanFactory によって提供されます。通常、そこではシングルトンとして定義する必要があります。

      注意 false を返すこのメソッドは、返されるオブジェクトが独立したインスタンスであることを必ずしも示しません。拡張 SmartFactoryBean インターフェースの実装は、SmartFactoryBean.isPrototype() メソッドを通じて独立したインスタンスを明示的に示す場合があります。この拡張インターフェースを実装しないプレーンな FactoryBean 実装は、isSingleton() 実装が false を返す場合、常に独立したインスタンスを返すと単純に想定されます。

      FactoryBean は通常シングルトンインスタンスを管理するため、デフォルトの実装は true を返します。

      次で指定:
      インターフェース FactoryBean<PropertiesSE>isSingleton 
      戻り値:
      公開されたオブジェクトがシングルトンかどうか
      関連事項:
    • afterPropertiesSet

      public final void afterPropertiesSet() throws IOExceptionSE
      インターフェースからコピーされた説明: InitializingBean
      すべての Bean プロパティを設定し、BeanFactoryAwareApplicationContextAware などを満たした後、包含 BeanFactory によって呼び出されます。

      このメソッドにより、Bean インスタンスは、すべての Bean プロパティが設定されたときに、その全体的な構成の検証と最終的な初期化を実行できます。

      次で指定:
      インターフェース InitializingBeanafterPropertiesSet 
      例外:
      IOExceptionSE
    • getObject

      @Nullable public final PropertiesSE getObject() throws IOExceptionSE
      インターフェースからコピーされた説明: FactoryBean
      このファクトリによって管理されるオブジェクトのインスタンス(おそらく共有または独立)を返します。

      BeanFactory と同様に、これにより、シングルトンとプロトタイプの両方のデザインパターンをサポートできます。

      この FactoryBean が呼び出し時にまだ完全に初期化されていない場合(たとえば、循環参照に関係しているため)、対応する FactoryBeanNotInitializedException をスローします。

      Spring 2.0 以降、FactoryBeans は null オブジェクトを返すことができます。ファクトリはこれを通常の値として使用します。この場合、FactoryBeanNotInitializedException はスローされません。FactoryBean の実装では、必要に応じて FactoryBeanNotInitializedException 自体をすぐにスローすることをお勧めします。

      次で指定:
      インターフェース FactoryBean<PropertiesSE>getObject 
      戻り値:
      Bean のインスタンス (null にすることができます)
      例外:
      IOExceptionSE
      関連事項:
    • getObjectType

      public ClassSE<PropertiesSE> getObjectType()
      インターフェースからコピーされた説明: FactoryBean
      この FactoryBean が作成するオブジェクトの型、または事前に不明な場合は null を返します。

      これにより、たとえばオートワイヤーなどで、オブジェクトをインスタンス化せずに特定の型の Bean を確認できます。

      シングルトンオブジェクトを作成している実装の場合、このメソッドはシングルトンの作成を可能な限り回避しようとします。むしろ、事前に型を推定する必要があります。プロトタイプの場合、ここで意味のある型を返すこともお勧めします。

      このメソッドは、この FactoryBean が完全に初期化される前に呼び出すことができます。初期化中に作成された状態に依存しないでください。もちろん、利用可能な場合はそのような状態を引き続き使用できます。

      注意 : オートワイヤーは、ここで null を返す FactoryBeans を単に無視します。FactoryBean の現在の状態を使用して、このメソッドを適切に実装することを強くお勧めします。

      次で指定:
      インターフェース FactoryBean<PropertiesSE>getObjectType 
      戻り値:
      この FactoryBean が作成するオブジェクトの型、または呼び出し時に不明な場合は null 
      関連事項:
    • createProperties

      protected PropertiesSE createProperties() throws IOExceptionSE
      このファクトリによって返されるオブジェクトを構築するためにサブクラスがオーバーライドできるテンプレートメソッド。デフォルトの実装は、プレーンなマージされた Properties インスタンスを返します。

      共有シングルトンの場合、この FactoryBean の初期化時に呼び出されます。それ以外の場合は、getObject() 呼び出しごとに実行されます。

      戻り値:
      このファクトリによって返されたオブジェクト
      例外:
      IOExceptionSE - プロパティのロード中に例外が発生した場合
      関連事項: