パッケージ org.springframework.beans.factory.config

クラス YamlMapFactoryBean

java.lang.ObjectSE
org.springframework.beans.factory.config.YamlProcessor
org.springframework.beans.factory.config.YamlMapFactoryBean
実装されたすべてのインターフェース:
FactoryBean<MapSE<StringSE,ObjectSE>>, InitializingBean
public class YamlMapFactoryBean extends YamlProcessor implements FactoryBean<MapSE<StringSE,ObjectSE>>, InitializingBean
YAML で宣言された値の型とその構造を保持しながら、YAML ソースから読み取る Map のファクトリ。

YAML は、人間が読める形式の優れた構成形式であり、いくつかの有用な階層プロパティがあります。それは多かれ少なかれ JSON のスーパーセットなので、多くの類似した機能を備えています。

複数のリソースが提供されている場合、後のリソースは前のリソースのエントリを階層的にオーバーライドします。つまり、任意の深さで型 Map の同じネストされたキーを持つすべてのエントリがマージされます。例：

 foo:
   bar:
    one: two
 three: four
プラス (リストの後半)
 foo:
   bar:
    one: 2
 five: six
結果 
 foo:
   bar:
    one: 2
 three: four
 five: six
最初のドキュメントの "foo" の値は、2 番目のドキュメントの値で単純に置き換えられるのではなく、そのネストされた値がマージされることに注意してください。

Spring Framework 6.1 以降、SnakeYAML 2.0 以降が必要です。

導入:
4.1
作成者:
Dave Syer, Juergen Hoeller

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

    • YamlMapFactoryBean

      public YamlMapFactoryBean()

  • メソッドの詳細

    • setSingleton

      public void setSingleton(boolean singleton)
      シングルトンを作成するかどうかを設定します。それ以外の場合は、リクエストごとに新しいオブジェクトを作成します。デフォルトは true （シングルトン）です。

    • isSingleton

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

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

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

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

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

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

    • afterPropertiesSet

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

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

      次で指定:
      インターフェース InitializingBean の afterPropertiesSet 

    • getObject

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

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

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

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

      次で指定:
      インターフェース FactoryBean<MapSE<StringSE,ObjectSE>> の getObject 
      戻り値:
      Bean のインスタンス (null にすることができます)
      関連事項:

    • getObjectType

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

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

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

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

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

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

    • createMap

      protected MapSE<StringSE,ObjectSE> createMap()
      このファクトリによって返されるオブジェクトを構築するためにサブクラスがオーバーライドできるテンプレートメソッド。

      共有シングルトンの場合、最初に getObject() が呼び出されるときに遅延して起動され、それ以外の場合は getObject() の呼び出しごとに起動されます。

      デフォルトの実装は、マージされた Map インスタンスを返します。

      戻り値:
      このファクトリによって返されたオブジェクト
      関連事項: