public class YamlPropertiesFactoryBean extends YamlProcessor implements FactoryBean<PropertiesSE>, InitializingBean
Properties
SE のファクトリ。YAML は、人間が読める形式の優れた構成形式であり、いくつかの有用な階層プロパティがあります。それは多かれ少なかれ JSON のスーパーセットなので、多くの類似した機能を備えています。
注: すべての公開された値は、一般的な Properties.getProperty(java.lang.String)
SE メソッドを介してアクセスするための型 String
です(たとえば、PropertiesLoaderSupport.setProperties(Properties)
による構成プロパティの解決)。これが望ましくない場合は、代わりに YamlMapFactoryBean
を使用してください。
このファクトリによって作成されたプロパティには、階層オブジェクトのネストされたパスがあるため、たとえばこの YAML
environments: dev: url: https://dev.bar.com name: Developer Setup prod: url: https://foo.bar.com name: My Cool Appこれらのプロパティに変換されます:
environments.dev.url=https://dev.bar.com environments.dev.name=Developer Setup environments.prod.url=https://foo.bar.com environments.prod.name=My Cool Appリストは、
[]
デリファレンスを使用してプロパティキーとして分割されます。たとえば、次の YAML です。servers: - dev.bar.com - foo.bar.comこのようなプロパティになります:
servers[0]=dev.bar.com servers[1]=foo.bar.com
Spring Framework 5.0.6 以降、SnakeYAML 1.18 以降が必要です。
YamlProcessor.DocumentMatcher, YamlProcessor.MatchCallback, YamlProcessor.MatchStatus, YamlProcessor.ResolutionMethod
OBJECT_TYPE_ATTRIBUTE
コンストラクターと説明 |
---|
YamlPropertiesFactoryBean() |
修飾子と型 | メソッドと説明 |
---|---|
void | afterPropertiesSet() |
protected PropertiesSE | createProperties() このファクトリによって返されるオブジェクトを構築するためにサブクラスがオーバーライドできるテンプレートメソッド。 |
PropertiesSE | getObject() このファクトリによって管理されるオブジェクトのインスタンス(おそらく共有または独立)を返します。 |
ClassSE<?> | getObjectType() この FactoryBean が作成するオブジェクトの型、または事前に不明な場合は null を返します。 |
boolean | isSingleton() このファクトリによって管理されるオブジェクトはシングルトンですか? つまり、 FactoryBean.getObject() は常に同じオブジェクト(キャッシュ可能な参照)を返しますか? |
void | setSingleton(boolean singleton) シングルトンを作成するかどうかを設定します。それ以外の場合は、リクエストごとに新しいオブジェクトを作成します。 |
createYaml, getFlattenedMap, process, setDocumentMatchers, setMatchDefault, setResolutionMethod, setResources, setSupportedTypes
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE
public void setSingleton(boolean singleton)
true
(シングルトン)です。public boolean isSingleton()
FactoryBean
FactoryBean.getObject()
は常に同じオブジェクト(キャッシュ可能な参照)を返しますか? 注意 : FactoryBean がシングルトンオブジェクトを保持することを示す場合、getObject()
から返されたオブジェクトは所有 BeanFactory によってキャッシュされる可能性があります。FactoryBean が常に同じ参照を公開しない限り、true
を返さないでください。
FactoryBean 自体のシングルトンステータスは、通常、所有する BeanFactory によって提供されます。通常、そこではシングルトンとして定義する必要があります。
注意 : false
を返すこのメソッドは、返されるオブジェクトが独立したインスタンスであることを必ずしも示しません。拡張 SmartFactoryBean
インターフェースの実装は、SmartFactoryBean.isPrototype()
メソッドを通じて独立したインスタンスを明示的に示す場合があります。この拡張インターフェースを実装しないプレーンな FactoryBean
実装は、isSingleton()
実装が false
を返す場合、常に独立したインスタンスを返すと単純に想定されます。
FactoryBean
は通常シングルトンインスタンスを管理するため、デフォルトの実装は true
を返します。
FactoryBean<PropertiesSE>
の isSingleton
FactoryBean.getObject()
, SmartFactoryBean.isPrototype()
public void afterPropertiesSet()
InitializingBean
BeanFactoryAware
、ApplicationContextAware
などを満たした後、包含 BeanFactory
によって呼び出されます。このメソッドにより、Bean インスタンスは、すべての Bean プロパティが設定されたときに、その全体的な構成の検証と最終的な初期化を実行できます。
InitializingBean
の afterPropertiesSet
@Nullable public PropertiesSE getObject()
FactoryBean
BeanFactory
と同様に、これにより、シングルトンとプロトタイプの両方のデザインパターンをサポートできます。
この FactoryBean が呼び出し時にまだ完全に初期化されていない場合(たとえば、循環参照に関係しているため)、対応する FactoryBeanNotInitializedException
をスローします。
Spring 2.0 以降、FactoryBeans は null
オブジェクトを返すことができます。ファクトリはこれを通常の値として使用します。この場合、FactoryBeanNotInitializedException はスローされません。FactoryBean の実装では、必要に応じて FactoryBeanNotInitializedException 自体をすぐにスローすることをお勧めします。
FactoryBean<PropertiesSE>
の getObject
null
にすることができます)FactoryBeanNotInitializedException
public ClassSE<?> getObjectType()
FactoryBean
null
を返します。これにより、たとえばオートワイヤーなどで、オブジェクトをインスタンス化せずに特定の型の Bean を確認できます。
シングルトンオブジェクトを作成している実装の場合、このメソッドはシングルトンの作成を可能な限り回避しようとします。むしろ、事前に型を推定する必要があります。プロトタイプの場合、ここで意味のある型を返すこともお勧めします。
このメソッドは、この FactoryBean が完全に初期化される前に呼び出すことができます。初期化中に作成された状態に依存しないでください。もちろん、利用可能な場合はそのような状態を引き続き使用できます。
注意 : オートワイヤーは、ここで null
を返す FactoryBeans を単に無視します。FactoryBean の現在の状態を使用して、このメソッドを適切に実装することを強くお勧めします。
FactoryBean<PropertiesSE>
の getObjectType
null
ListableBeanFactory.getBeansOfType(java.lang.Class<T>)
protected PropertiesSE createProperties()
共有シングルトンの場合、最初に getObject()
が呼び出されるときに遅延して起動され、それ以外の場合は getObject()
の呼び出しごとに起動されます。
YamlProcessor.process(MatchCallback)