接口 BeanFactory
- 所有已知子接口:
ApplicationContext
,AutowireCapableBeanFactory
,ConfigurableApplicationContext
,ConfigurableBeanFactory
,ConfigurableListableBeanFactory
,ConfigurablePortletApplicationContext
,ConfigurableWebApplicationContext
,HierarchicalBeanFactory
,ListableBeanFactory
,WebApplicationContext
- 所有已知实现类:
AbstractApplicationContext
,AbstractAutowireCapableBeanFactory
,AbstractBeanFactory
,AbstractRefreshableApplicationContext
,AbstractRefreshableConfigApplicationContext
,AbstractRefreshablePortletApplicationContext
,AbstractRefreshableWebApplicationContext
,AbstractXmlApplicationContext
,AnnotationConfigApplicationContext
,AnnotationConfigWebApplicationContext
,ClassPathXmlApplicationContext
,DefaultListableBeanFactory
,FileSystemXmlApplicationContext
,GenericApplicationContext
,GenericGroovyApplicationContext
,GenericWebApplicationContext
,GenericXmlApplicationContext
,GroovyWebApplicationContext
,ResourceAdapterApplicationContext
,SimpleJndiBeanFactory
,StaticApplicationContext
,StaticListableBeanFactory
,StaticPortletApplicationContext
,StaticWebApplicationContext
,XmlBeanFactory
,XmlPortletApplicationContext
,XmlWebApplicationContext
public interface BeanFactory
The root interface for accessing a Spring bean container. This is the basic client view of a bean container; further interfaces such asListableBeanFactory
andConfigurableBeanFactory
are available for specific purposes.This interface is implemented by objects that hold a number of bean definitions, each uniquely identified by a String name. Depending on the bean definition, the factory will return either an independent instance of a contained object (the Prototype design pattern), or a single shared instance (a superior alternative to the Singleton design pattern, in which the instance is a singleton in the scope of the factory). Which type of instance will be returned depends on the bean factory configuration: the API is the same. Since Spring 2.0, further scopes are available depending on the concrete application context (e.g. "request" and "session" scopes in a web environment).
The point of this approach is that the BeanFactory is a central registry of application components, and centralizes configuration of application components (no more do individual objects need to read properties files, for example). See chapters 4 and 11 of "Expert One-on-One J2EE Design and Development" for a discussion of the benefits of this approach.
Note that it is generally better to rely on Dependency Injection ("push" configuration) to configure application objects through setters or constructors, rather than use any form of "pull" configuration like a BeanFactory lookup. Spring's Dependency Injection functionality is implemented using this BeanFactory interface and its subinterfaces.
Normally a BeanFactory will load bean definitions stored in a configuration source (such as an XML document), and use the
org.springframework.beans
package to configure the beans. However, an implementation could simply return Java objects it creates as necessary directly in Java code. There are no constraints on how the definitions could be stored: LDAP, RDBMS, XML, properties file, etc. Implementations are encouraged to support references amongst beans (Dependency Injection).In contrast to the methods in
ListableBeanFactory
, all of the operations in this interface will also check parent factories if this is aHierarchicalBeanFactory
. If a bean is not found in this factory instance, the immediate parent factory will be asked. Beans in this factory instance are supposed to override beans of the same name in any parent factory.Bean factory implementations should support the standard bean lifecycle interfaces as far as possible. The full set of initialization methods and their standard order is:
- BeanNameAware's
setBeanName
- BeanClassLoaderAware's
setBeanClassLoader
- BeanFactoryAware's
setBeanFactory
- EnvironmentAware's
setEnvironment
- EmbeddedValueResolverAware's
setEmbeddedValueResolver
- ResourceLoaderAware's
setResourceLoader
(only applicable when running in an application context) - ApplicationEventPublisherAware's
setApplicationEventPublisher
(only applicable when running in an application context) - MessageSourceAware's
setMessageSource
(only applicable when running in an application context) - ApplicationContextAware's
setApplicationContext
(only applicable when running in an application context) - ServletContextAware's
setServletContext
(only applicable when running in a web application context) postProcessBeforeInitialization
methods of BeanPostProcessors- InitializingBean's
afterPropertiesSet
- a custom init-method definition
postProcessAfterInitialization
methods of BeanPostProcessors
On shutdown of a bean factory, the following lifecycle methods apply:
postProcessBeforeDestruction
methods of DestructionAwareBeanPostProcessors- DisposableBean's
destroy
- a custom destroy-method definition
- 从以下版本开始:
- 13 April 2001
- 作者:
- Rod Johnson, Juergen Hoeller, Chris Beams
- 另请参阅:
BeanNameAware.setBeanName(java.lang.String)
,BeanClassLoaderAware.setBeanClassLoader(java.lang.ClassLoader)
,BeanFactoryAware.setBeanFactory(org.springframework.beans.factory.BeanFactory)
,ResourceLoaderAware.setResourceLoader(org.springframework.core.io.ResourceLoader)
,ApplicationEventPublisherAware.setApplicationEventPublisher(org.springframework.context.ApplicationEventPublisher)
,MessageSourceAware.setMessageSource(org.springframework.context.MessageSource)
,ApplicationContextAware.setApplicationContext(org.springframework.context.ApplicationContext)
,ServletContextAware.setServletContext(javax.servlet.ServletContext)
,BeanPostProcessor.postProcessBeforeInitialization(java.lang.Object, java.lang.String)
,InitializingBean.afterPropertiesSet()
,AbstractBeanDefinition.getInitMethodName()
,BeanPostProcessor.postProcessAfterInitialization(java.lang.Object, java.lang.String)
,DisposableBean.destroy()
,AbstractBeanDefinition.getDestroyMethodName()
字段概要
字段 修饰符和类型 字段 说明 static String
FACTORY_BEAN_PREFIX
Used to dereference aFactoryBean
instance and distinguish it from beans created by the FactoryBean.
方法概要
所有方法 实例方法 抽象方法 修饰符和类型 方法 说明 boolean
containsBean(String name)
Does this bean factory contain a bean definition or externally registered singleton instance with the given name?String[]
getAliases(String name)
Return the aliases for the given bean name, if any.<T> T
getBean(Class<T> requiredType)
Return the bean instance that uniquely matches the given object type, if any.<T> T
getBean(Class<T> requiredType, Object... args)
Return an instance, which may be shared or independent, of the specified bean.Object
getBean(String name)
Return an instance, which may be shared or independent, of the specified bean.<T> T
getBean(String name, Class<T> requiredType)
Return an instance, which may be shared or independent, of the specified bean.Object
getBean(String name, Object... args)
Return an instance, which may be shared or independent, of the specified bean.Class<?>
getType(String name)
Determine the type of the bean with the given name.boolean
isPrototype(String name)
Is this bean a prototype?boolean
isSingleton(String name)
Is this bean a shared singleton?boolean
isTypeMatch(String name, Class<?> typeToMatch)
Check whether the bean with the given name matches the specified type.boolean
isTypeMatch(String name, ResolvableType typeToMatch)
Check whether the bean with the given name matches the specified type.
字段详细资料
FACTORY_BEAN_PREFIX
static final String FACTORY_BEAN_PREFIX
Used to dereference aFactoryBean
instance and distinguish it from beans created by the FactoryBean. For example, if the bean namedmyJndiObject
is a FactoryBean, getting&myJndiObject
will return the factory, not the instance returned by the factory.- 另请参阅:
- 常量字段值
方法详细资料
getBean
Object getBean(String name) throws BeansException
Return an instance, which may be shared or independent, of the specified bean.This method allows a Spring BeanFactory to be used as a replacement for the Singleton or Prototype design pattern. Callers may retain references to returned objects in the case of Singleton beans.
Translates aliases back to the corresponding canonical bean name. Will ask the parent factory if the bean cannot be found in this factory instance.
- 参数:
name
- the name of the bean to retrieve- 返回:
- an instance of the bean
- 抛出:
NoSuchBeanDefinitionException
- if there is no bean with the specified nameBeansException
- if the bean could not be obtained
getBean
<T> T getBean(String name, Class<T> requiredType) throws BeansException
Return an instance, which may be shared or independent, of the specified bean.Behaves the same as
getBean(String)
, but provides a measure of type safety by throwing a BeanNotOfRequiredTypeException if the bean is not of the required type. This means that ClassCastException can't be thrown on casting the result correctly, as can happen withgetBean(String)
.Translates aliases back to the corresponding canonical bean name. Will ask the parent factory if the bean cannot be found in this factory instance.
- 参数:
name
- the name of the bean to retrieverequiredType
- type the bean must match. Can be an interface or superclass of the actual class, ornull
for any match. For example, if the value isObject.class
, this method will succeed whatever the class of the returned instance.- 返回:
- an instance of the bean
- 抛出:
NoSuchBeanDefinitionException
- if there is no such bean definitionBeanNotOfRequiredTypeException
- if the bean is not of the required typeBeansException
- if the bean could not be created
getBean
Object getBean(String name, Object... args) throws BeansException
Return an instance, which may be shared or independent, of the specified bean.Allows for specifying explicit constructor arguments / factory method arguments, overriding the specified default arguments (if any) in the bean definition.
- 参数:
name
- the name of the bean to retrieveargs
- arguments to use when creating a bean instance using explicit arguments (only applied when creating a new instance as opposed to retrieving an existing one)- 返回:
- an instance of the bean
- 抛出:
NoSuchBeanDefinitionException
- if there is no such bean definitionBeanDefinitionStoreException
- if arguments have been given but the affected bean isn't a prototypeBeansException
- if the bean could not be created- 从以下版本开始:
- 2.5
getBean
<T> T getBean(Class<T> requiredType) throws BeansException
Return the bean instance that uniquely matches the given object type, if any.This method goes into
ListableBeanFactory
by-type lookup territory but may also be translated into a conventional by-name lookup based on the name of the given type. For more extensive retrieval operations across sets of beans, useListableBeanFactory
and/orBeanFactoryUtils
.- 参数:
requiredType
- type the bean must match; can be an interface or superclass- 返回:
- an instance of the single bean matching the required type
- 抛出:
NoSuchBeanDefinitionException
- if no bean of the given type was foundNoUniqueBeanDefinitionException
- if more than one bean of the given type was foundBeansException
- if the bean could not be created- 从以下版本开始:
- 3.0
- 另请参阅:
ListableBeanFactory
getBean
<T> T getBean(Class<T> requiredType, Object... args) throws BeansException
Return an instance, which may be shared or independent, of the specified bean.Allows for specifying explicit constructor arguments / factory method arguments, overriding the specified default arguments (if any) in the bean definition.
This method goes into
ListableBeanFactory
by-type lookup territory but may also be translated into a conventional by-name lookup based on the name of the given type. For more extensive retrieval operations across sets of beans, useListableBeanFactory
and/orBeanFactoryUtils
.- 参数:
requiredType
- type the bean must match; can be an interface or superclassargs
- arguments to use when creating a bean instance using explicit arguments (only applied when creating a new instance as opposed to retrieving an existing one)- 返回:
- an instance of the bean
- 抛出:
NoSuchBeanDefinitionException
- if there is no such bean definitionBeanDefinitionStoreException
- if arguments have been given but the affected bean isn't a prototypeBeansException
- if the bean could not be created- 从以下版本开始:
- 4.1
containsBean
boolean containsBean(String name)
Does this bean factory contain a bean definition or externally registered singleton instance with the given name?If the given name is an alias, it will be translated back to the corresponding canonical bean name.
If this factory is hierarchical, will ask any parent factory if the bean cannot be found in this factory instance.
If a bean definition or singleton instance matching the given name is found, this method will return
true
whether the named bean definition is concrete or abstract, lazy or eager, in scope or not. Therefore, note that atrue
return value from this method does not necessarily indicate thatgetBean(java.lang.String)
will be able to obtain an instance for the same name.- 参数:
name
- the name of the bean to query- 返回:
- whether a bean with the given name is present
isSingleton
boolean isSingleton(String name) throws NoSuchBeanDefinitionException
Is this bean a shared singleton? That is, willgetBean(java.lang.String)
always return the same instance?Note: This method returning
false
does not clearly indicate independent instances. It indicates non-singleton instances, which may correspond to a scoped bean as well. Use theisPrototype(java.lang.String)
operation to explicitly check for independent instances.Translates aliases back to the corresponding canonical bean name. Will ask the parent factory if the bean cannot be found in this factory instance.
- 参数:
name
- the name of the bean to query- 返回:
- whether this bean corresponds to a singleton instance
- 抛出:
NoSuchBeanDefinitionException
- if there is no bean with the given name- 另请参阅:
getBean(java.lang.String)
,isPrototype(java.lang.String)
isPrototype
boolean isPrototype(String name) throws NoSuchBeanDefinitionException
Is this bean a prototype? That is, willgetBean(java.lang.String)
always return independent instances?Note: This method returning
false
does not clearly indicate a singleton object. It indicates non-independent instances, which may correspond to a scoped bean as well. Use theisSingleton(java.lang.String)
operation to explicitly check for a shared singleton instance.Translates aliases back to the corresponding canonical bean name. Will ask the parent factory if the bean cannot be found in this factory instance.
- 参数:
name
- the name of the bean to query- 返回:
- whether this bean will always deliver independent instances
- 抛出:
NoSuchBeanDefinitionException
- if there is no bean with the given name- 从以下版本开始:
- 2.0.3
- 另请参阅:
getBean(java.lang.String)
,isSingleton(java.lang.String)
isTypeMatch
boolean isTypeMatch(String name, ResolvableType typeToMatch) throws NoSuchBeanDefinitionException
Check whether the bean with the given name matches the specified type. More specifically, check whether agetBean(java.lang.String)
call for the given name would return an object that is assignable to the specified target type.Translates aliases back to the corresponding canonical bean name. Will ask the parent factory if the bean cannot be found in this factory instance.
- 参数:
name
- the name of the bean to querytypeToMatch
- the type to match against (as aResolvableType
)- 返回:
true
if the bean type matches,false
if it doesn't match or cannot be determined yet- 抛出:
NoSuchBeanDefinitionException
- if there is no bean with the given name- 从以下版本开始:
- 4.2
- 另请参阅:
getBean(java.lang.String)
,getType(java.lang.String)
isTypeMatch
boolean isTypeMatch(String name, Class<?> typeToMatch) throws NoSuchBeanDefinitionException
Check whether the bean with the given name matches the specified type. More specifically, check whether agetBean(java.lang.String)
call for the given name would return an object that is assignable to the specified target type.Translates aliases back to the corresponding canonical bean name. Will ask the parent factory if the bean cannot be found in this factory instance.
- 参数:
name
- the name of the bean to querytypeToMatch
- the type to match against (as aClass
)- 返回:
true
if the bean type matches,false
if it doesn't match or cannot be determined yet- 抛出:
NoSuchBeanDefinitionException
- if there is no bean with the given name- 从以下版本开始:
- 2.0.1
- 另请参阅:
getBean(java.lang.String)
,getType(java.lang.String)
getType
Class<?> getType(String name) throws NoSuchBeanDefinitionException
Determine the type of the bean with the given name. More specifically, determine the type of object thatgetBean(java.lang.String)
would return for the given name.For a
FactoryBean
, return the type of object that the FactoryBean creates, as exposed byFactoryBean.getObjectType()
.Translates aliases back to the corresponding canonical bean name. Will ask the parent factory if the bean cannot be found in this factory instance.
- 参数:
name
- the name of the bean to query- 返回:
- the type of the bean, or
null
if not determinable - 抛出:
NoSuchBeanDefinitionException
- if there is no bean with the given name- 从以下版本开始:
- 1.1.2
- 另请参阅:
getBean(java.lang.String)
,isTypeMatch(java.lang.String, org.springframework.core.ResolvableType)
getAliases
String[] getAliases(String name)
Return the aliases for the given bean name, if any. All of those aliases point to the same bean when used in agetBean(java.lang.String)
call.If the given name is an alias, the corresponding original bean name and other aliases (if any) will be returned, with the original bean name being the first element in the array.
Will ask the parent factory if the bean cannot be found in this factory instance.
- 参数:
name
- the bean name to check for aliases- 返回:
- the aliases, or an empty array if none
- 另请参阅:
getBean(java.lang.String)