类 YamlMapFactoryBean
- java.lang.Object
- org.springframework.beans.factory.config.YamlProcessor
- org.springframework.beans.factory.config.YamlMapFactoryBean
- 所有已实现的接口:
FactoryBean<Map<String,Object>>
,InitializingBean
public class YamlMapFactoryBean extends YamlProcessor implements FactoryBean<Map<String,Object>>, InitializingBean
Factory for aMap
that reads from a YAML source, preserving the YAML-declared value types and their structure.YAML is a nice human-readable format for configuration, and it has some useful hierarchical properties. It's more or less a superset of JSON, so it has a lot of similar features.
If multiple resources are provided the later ones will override entries in the earlier ones hierarchically; that is, all entries with the same nested key of type
Map
at any depth are merged. For example:foo: bar: one: two three: four
plus (later in the list)foo: bar: one: 2 five: six
results in an effective input offoo: bar: one: 2 three: four five: six
Note that the value of "foo" in the first document is not simply replaced with the value in the second, but its nested values are merged.Requires SnakeYAML 1.18 or higher, as of Spring Framework 5.0.6.
- 从以下版本开始:
- 4.1
- 作者:
- Dave Syer, Juergen Hoeller
嵌套类概要
从类继承的嵌套类/接口 org.springframework.beans.factory.config.YamlProcessor
YamlProcessor.DocumentMatcher, YamlProcessor.MatchCallback, YamlProcessor.MatchStatus, YamlProcessor.ResolutionMethod
字段概要
从接口继承的字段 org.springframework.beans.factory.FactoryBean
OBJECT_TYPE_ATTRIBUTE
构造器概要
构造器 构造器 说明 YamlMapFactoryBean()
方法概要
所有方法 实例方法 具体方法 修饰符和类型 方法 说明 void
afterPropertiesSet()
Invoked by the containingBeanFactory
after it has set all bean properties and satisfiedBeanFactoryAware
,ApplicationContextAware
etc.protected Map<String,Object>
createMap()
Template method that subclasses may override to construct the object returned by this factory.Map<String,Object>
getObject()
Return an instance (possibly shared or independent) of the object managed by this factory.Class<?>
getObjectType()
Return the type of object that this FactoryBean creates, ornull
if not known in advance.boolean
isSingleton()
Is the object managed by this factory a singleton?void
setSingleton(boolean singleton)
Set if a singleton should be created, or a new object on each request otherwise.从类继承的方法 org.springframework.beans.factory.config.YamlProcessor
createYaml, getFlattenedMap, process, setDocumentMatchers, setMatchDefault, setResolutionMethod, setResources, setSupportedTypes
构造器详细资料
YamlMapFactoryBean
public YamlMapFactoryBean()
方法详细资料
setSingleton
public void setSingleton(boolean singleton)
Set if a singleton should be created, or a new object on each request otherwise. Default istrue
(a singleton).
isSingleton
public boolean isSingleton()
从接口复制的说明:FactoryBean
Is the object managed by this factory a singleton? That is, willFactoryBean.getObject()
always return the same object (a reference that can be cached)?NOTE: If a FactoryBean indicates to hold a singleton object, the object returned from
getObject()
might get cached by the owning BeanFactory. Hence, do not returntrue
unless the FactoryBean always exposes the same reference.The singleton status of the FactoryBean itself will generally be provided by the owning BeanFactory; usually, it has to be defined as singleton there.
NOTE: This method returning
false
does not necessarily indicate that returned objects are independent instances. An implementation of the extendedSmartFactoryBean
interface may explicitly indicate independent instances through itsSmartFactoryBean.isPrototype()
method. PlainFactoryBean
implementations which do not implement this extended interface are simply assumed to always return independent instances if theisSingleton()
implementation returnsfalse
.The default implementation returns
true
, since aFactoryBean
typically manages a singleton instance.- 指定者:
isSingleton
在接口中FactoryBean<Map<String,Object>>
- 返回:
- whether the exposed object is a singleton
- 另请参阅:
FactoryBean.getObject()
,SmartFactoryBean.isPrototype()
afterPropertiesSet
public void afterPropertiesSet()
从接口复制的说明:InitializingBean
Invoked by the containingBeanFactory
after it has set all bean properties and satisfiedBeanFactoryAware
,ApplicationContextAware
etc.This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set.
- 指定者:
afterPropertiesSet
在接口中InitializingBean
getObject
@Nullable public Map<String,Object> getObject()
从接口复制的说明:FactoryBean
Return an instance (possibly shared or independent) of the object managed by this factory.As with a
BeanFactory
, this allows support for both the Singleton and Prototype design pattern.If this FactoryBean is not fully initialized yet at the time of the call (for example because it is involved in a circular reference), throw a corresponding
FactoryBeanNotInitializedException
.As of Spring 2.0, FactoryBeans are allowed to return
null
objects. The factory will consider this as normal value to be used; it will not throw a FactoryBeanNotInitializedException in this case anymore. FactoryBean implementations are encouraged to throw FactoryBeanNotInitializedException themselves now, as appropriate.- 指定者:
getObject
在接口中FactoryBean<Map<String,Object>>
- 返回:
- an instance of the bean (can be
null
) - 另请参阅:
FactoryBeanNotInitializedException
getObjectType
public Class<?> getObjectType()
从接口复制的说明:FactoryBean
Return the type of object that this FactoryBean creates, ornull
if not known in advance.This allows one to check for specific types of beans without instantiating objects, for example on autowiring.
In the case of implementations that are creating a singleton object, this method should try to avoid singleton creation as far as possible; it should rather estimate the type in advance. For prototypes, returning a meaningful type here is advisable too.
This method can be called before this FactoryBean has been fully initialized. It must not rely on state created during initialization; of course, it can still use such state if available.
NOTE: Autowiring will simply ignore FactoryBeans that return
null
here. Therefore it is highly recommended to implement this method properly, using the current state of the FactoryBean.- 指定者:
getObjectType
在接口中FactoryBean<Map<String,Object>>
- 返回:
- the type of object that this FactoryBean creates, or
null
if not known at the time of the call - 另请参阅:
ListableBeanFactory.getBeansOfType(java.lang.Class<T>)
createMap
protected Map<String,Object> createMap()
Template method that subclasses may override to construct the object returned by this factory.Invoked lazily the first time
getObject()
is invoked in case of a shared singleton; else, on eachgetObject()
call.The default implementation returns the merged
Map
instance.- 返回:
- the object returned by this factory
- 另请参阅:
YamlProcessor.process(MatchCallback)