类 AbstractApplicationContext
- java.lang.Object
- org.springframework.core.io.DefaultResourceLoader
- org.springframework.context.support.AbstractApplicationContext
- 所有已实现的接口:
Closeable
,AutoCloseable
,BeanFactory
,HierarchicalBeanFactory
,ListableBeanFactory
,ApplicationContext
,ApplicationEventPublisher
,ConfigurableApplicationContext
,Lifecycle
,MessageSource
,EnvironmentCapable
,ResourceLoader
,ResourcePatternResolver
public abstract class AbstractApplicationContext extends DefaultResourceLoader implements ConfigurableApplicationContext
Abstract implementation of theApplicationContext
interface. Doesn't mandate the type of storage used for configuration; simply implements common context functionality. Uses the Template Method design pattern, requiring concrete subclasses to implement abstract methods.In contrast to a plain BeanFactory, an ApplicationContext is supposed to detect special beans defined in its internal bean factory: Therefore, this class automatically registers
BeanFactoryPostProcessors
,BeanPostProcessors
, andApplicationListeners
which are defined as beans in the context.A
MessageSource
may also be supplied as a bean in the context, with the name "messageSource"; otherwise, message resolution is delegated to the parent context. Furthermore, a multicaster for application events can be supplied as an "applicationEventMulticaster" bean of typeApplicationEventMulticaster
in the context; otherwise, a default multicaster of typeSimpleApplicationEventMulticaster
will be used.Implements resource loading by extending
DefaultResourceLoader
. Consequently treats non-URL resource paths as class path resources (supporting full class path resource names that include the package path, e.g. "mypackage/myresource.dat"), unless theDefaultResourceLoader.getResourceByPath(java.lang.String)
method is overridden in a subclass.- 从以下版本开始:
- January 21, 2001
- 作者:
- Rod Johnson, Juergen Hoeller, Mark Fisher, Stephane Nicoll, Sam Brannen
- 另请参阅:
refreshBeanFactory()
,getBeanFactory()
,BeanFactoryPostProcessor
,BeanPostProcessor
,ApplicationEventMulticaster
,ApplicationListener
,MessageSource
嵌套类概要
从类继承的嵌套类/接口 org.springframework.core.io.DefaultResourceLoader
DefaultResourceLoader.ClassPathContextResource
字段概要
字段 修饰符和类型 字段 说明 static String
APPLICATION_EVENT_MULTICASTER_BEAN_NAME
Name of the ApplicationEventMulticaster bean in the factory.static String
LIFECYCLE_PROCESSOR_BEAN_NAME
Name of the LifecycleProcessor bean in the factory.protected Log
logger
Logger used by this class.static String
MESSAGE_SOURCE_BEAN_NAME
Name of the MessageSource bean in the factory.从接口继承的字段 org.springframework.beans.factory.BeanFactory
FACTORY_BEAN_PREFIX
从接口继承的字段 org.springframework.context.ConfigurableApplicationContext
CONFIG_LOCATION_DELIMITERS, CONVERSION_SERVICE_BEAN_NAME, ENVIRONMENT_BEAN_NAME, LOAD_TIME_WEAVER_BEAN_NAME, SHUTDOWN_HOOK_THREAD_NAME, SYSTEM_ENVIRONMENT_BEAN_NAME, SYSTEM_PROPERTIES_BEAN_NAME
从接口继承的字段 org.springframework.core.io.ResourceLoader
CLASSPATH_URL_PREFIX
从接口继承的字段 org.springframework.core.io.support.ResourcePatternResolver
CLASSPATH_ALL_URL_PREFIX
构造器概要
构造器 构造器 说明 AbstractApplicationContext()
Create a new AbstractApplicationContext with no parent.AbstractApplicationContext(ApplicationContext parent)
Create a new AbstractApplicationContext with the given parent context.
方法概要
所有方法 实例方法 抽象方法 具体方法 已过时的方法 修饰符和类型 方法 说明 void
addApplicationListener(ApplicationListener<?> listener)
Add a new ApplicationListener that will be notified on context events such as context refresh and context shutdown.void
addBeanFactoryPostProcessor(BeanFactoryPostProcessor postProcessor)
Add a new BeanFactoryPostProcessor that will get applied to the internal bean factory of this application context on refresh, before any of the bean definitions get evaluated.protected void
assertBeanFactoryActive()
Assert that this context's BeanFactory is currently active, throwing anIllegalStateException
if it isn't.protected void
cancelRefresh(BeansException ex)
Cancel this context's refresh attempt, resetting theactive
flag after an exception got thrown.void
close()
Close this application context, destroying all beans in its bean factory.protected abstract void
closeBeanFactory()
Subclasses must implement this method to release their internal bean factory.boolean
containsBean(String name)
Does this bean factory contain a bean definition or externally registered singleton instance with the given name?boolean
containsBeanDefinition(String beanName)
Check if this bean factory contains a bean definition with the given name.boolean
containsLocalBean(String name)
Return whether the local bean factory contains a bean of the given name, ignoring beans defined in ancestor contexts.protected ConfigurableEnvironment
createEnvironment()
Create and return a newStandardEnvironment
.void
destroy()
已过时。as of Spring Framework 5.0, in favor ofclose()
protected void
destroyBeans()
Template method for destroying all beans that this context manages.protected void
doClose()
Actually performs context closing: publishes a ContextClosedEvent and destroys the singletons in the bean factory of this application context.<A extends Annotation>
AfindAnnotationOnBean(String beanName, Class<A> annotationType)
Find anAnnotation
ofannotationType
on the specified bean, traversing its interfaces and super classes if no annotation can be found on the given class itself, as well as checking the bean's factory method (if any).protected void
finishBeanFactoryInitialization(ConfigurableListableBeanFactory beanFactory)
Finish the initialization of this context's bean factory, initializing all remaining singleton beans.protected void
finishRefresh()
Finish the refresh of this context, invoking the LifecycleProcessor's onRefresh() method and publishing theContextRefreshedEvent
.String[]
getAliases(String name)
Return the aliases for the given bean name, if any.Collection<ApplicationListener<?>>
getApplicationListeners()
Return the list of statically specified ApplicationListeners.String
getApplicationName()
Return a name for the deployed application that this context belongs to.AutowireCapableBeanFactory
getAutowireCapableBeanFactory()
Return this context's internal bean factory as AutowireCapableBeanFactory, if already available.<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.int
getBeanDefinitionCount()
Return the number of beans defined in the factory.String[]
getBeanDefinitionNames()
Return the names of all beans defined in this factory.abstract ConfigurableListableBeanFactory
getBeanFactory()
Subclasses must return their internal bean factory here.List<BeanFactoryPostProcessor>
getBeanFactoryPostProcessors()
Return the list of BeanFactoryPostProcessors that will get applied to the internal BeanFactory.String[]
getBeanNamesForAnnotation(Class<? extends Annotation> annotationType)
Find all names of beans which are annotated with the suppliedAnnotation
type, without creating corresponding bean instances yet.String[]
getBeanNamesForType(Class<?> type)
Return the names of beans matching the given type (including subclasses), judging from either bean definitions or the value ofgetObjectType
in the case of FactoryBeans.String[]
getBeanNamesForType(Class<?> type, boolean includeNonSingletons, boolean allowEagerInit)
Return the names of beans matching the given type (including subclasses), judging from either bean definitions or the value ofgetObjectType
in the case of FactoryBeans.String[]
getBeanNamesForType(ResolvableType type)
Return the names of beans matching the given type (including subclasses), judging from either bean definitions or the value ofgetObjectType
in the case of FactoryBeans.String[]
getBeanNamesForType(ResolvableType type, boolean includeNonSingletons, boolean allowEagerInit)
Return the names of beans matching the given type (including subclasses), judging from either bean definitions or the value ofgetObjectType
in the case of FactoryBeans.<T> ObjectProvider<T>
getBeanProvider(Class<T> requiredType)
Return a provider for the specified bean, allowing for lazy on-demand retrieval of instances, including availability and uniqueness options.<T> ObjectProvider<T>
getBeanProvider(ResolvableType requiredType)
Return a provider for the specified bean, allowing for lazy on-demand retrieval of instances, including availability and uniqueness options.<T> Map<String,T>
getBeansOfType(Class<T> type)
Return the bean instances that match the given object type (including subclasses), judging from either bean definitions or the value ofgetObjectType
in the case of FactoryBeans.<T> Map<String,T>
getBeansOfType(Class<T> type, boolean includeNonSingletons, boolean allowEagerInit)
Return the bean instances that match the given object type (including subclasses), judging from either bean definitions or the value ofgetObjectType
in the case of FactoryBeans.Map<String,Object>
getBeansWithAnnotation(Class<? extends Annotation> annotationType)
Find all beans which are annotated with the suppliedAnnotation
type, returning a Map of bean names with corresponding bean instances.String
getDisplayName()
Return a friendly name for this context.ConfigurableEnvironment
getEnvironment()
Return theEnvironment
for this application context in configurable form, allowing for further customization.String
getId()
Return the unique id of this application context.protected BeanFactory
getInternalParentBeanFactory()
Return the internal bean factory of the parent context if it implements ConfigurableApplicationContext; else, return the parent context itself.protected MessageSource
getInternalParentMessageSource()
Return the internal message source of the parent context if it is an AbstractApplicationContext too; else, return the parent context itself.String
getMessage(String code, Object[] args, String defaultMessage, Locale locale)
Try to resolve the message.String
getMessage(String code, Object[] args, Locale locale)
Try to resolve the message.String
getMessage(MessageSourceResolvable resolvable, Locale locale)
Try to resolve the message using all the attributes contained within theMessageSourceResolvable
argument that was passed in.ApplicationContext
getParent()
Return the parent context, ornull
if there is no parent (that is, this context is the root of the context hierarchy).BeanFactory
getParentBeanFactory()
Return the parent bean factory, ornull
if there is none.protected ResourcePatternResolver
getResourcePatternResolver()
Return the ResourcePatternResolver to use for resolving location patterns into Resource instances.Resource[]
getResources(String locationPattern)
Resolve the given location pattern into Resource objects.long
getStartupDate()
Return the timestamp (ms) when this context was first loaded.Class<?>
getType(String name)
Determine the type of the bean with the given name.Class<?>
getType(String name, boolean allowFactoryBeanInit)
Determine the type of the bean with the given name.protected void
initApplicationEventMulticaster()
Initialize the ApplicationEventMulticaster.protected void
initLifecycleProcessor()
Initialize the LifecycleProcessor.protected void
initMessageSource()
Initialize the MessageSource.protected void
initPropertySources()
Replace any stub property sources with actual instances.protected void
invokeBeanFactoryPostProcessors(ConfigurableListableBeanFactory beanFactory)
Instantiate and invoke all registered BeanFactoryPostProcessor beans, respecting explicit order if given.boolean
isActive()
Determine whether this application context is active, that is, whether it has been refreshed at least once and has not been closed yet.boolean
isPrototype(String name)
Is this bean a prototype?boolean
isRunning()
Check whether this component is currently running.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.protected ConfigurableListableBeanFactory
obtainFreshBeanFactory()
Tell the subclass to refresh the internal bean factory.protected void
onClose()
Template method which can be overridden to add context-specific shutdown work.protected void
onRefresh()
Template method which can be overridden to add context-specific refresh work.protected void
postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory)
Modify the application context's internal bean factory after its standard initialization.protected void
prepareBeanFactory(ConfigurableListableBeanFactory beanFactory)
Configure the factory's standard context characteristics, such as the context's ClassLoader and post-processors.protected void
prepareRefresh()
Prepare this context for refreshing, setting its startup date and active flag as well as performing any initialization of property sources.void
publishEvent(Object event)
Publish the given event to all listeners.protected void
publishEvent(Object event, ResolvableType eventType)
Publish the given event to all listeners.void
publishEvent(ApplicationEvent event)
Publish the given event to all listeners.void
refresh()
Load or refresh the persistent representation of the configuration, which might be from Java-based configuration, an XML file, a properties file, a relational database schema, or some other format.protected abstract void
refreshBeanFactory()
Subclasses must implement this method to perform the actual configuration load.protected void
registerBeanPostProcessors(ConfigurableListableBeanFactory beanFactory)
Instantiate and register all BeanPostProcessor beans, respecting explicit order if given.protected void
registerListeners()
Add beans that implement ApplicationListener as listeners.void
registerShutdownHook()
Register a shutdown hook namedSpringContextShutdownHook
with the JVM runtime, closing this context on JVM shutdown unless it has already been closed at that time.protected void
resetCommonCaches()
Reset Spring's common reflection metadata caches, in particular theReflectionUtils
,AnnotationUtils
,ResolvableType
andCachedIntrospectionResults
caches.void
setDisplayName(String displayName)
Set a friendly name for this context.void
setEnvironment(ConfigurableEnvironment environment)
Set theEnvironment
for this application context.void
setId(String id)
Set the unique id of this application context.void
setParent(ApplicationContext parent)
Set the parent of this application context.void
start()
Start this component.void
stop()
Stop this component, typically in a synchronous fashion, such that the component is fully stopped upon return of this method.String
toString()
Return information about this context.从类继承的方法 org.springframework.core.io.DefaultResourceLoader
addProtocolResolver, clearResourceCaches, getClassLoader, getProtocolResolvers, getResource, getResourceByPath, getResourceCache, setClassLoader
从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
从接口继承的方法 org.springframework.context.ConfigurableApplicationContext
addProtocolResolver, setClassLoader
从接口继承的方法 org.springframework.core.io.ResourceLoader
getClassLoader, getResource
字段详细资料
MESSAGE_SOURCE_BEAN_NAME
public static final String MESSAGE_SOURCE_BEAN_NAME
Name of the MessageSource bean in the factory. If none is supplied, message resolution is delegated to the parent.- 另请参阅:
MessageSource
, 常量字段值
LIFECYCLE_PROCESSOR_BEAN_NAME
public static final String LIFECYCLE_PROCESSOR_BEAN_NAME
Name of the LifecycleProcessor bean in the factory. If none is supplied, a DefaultLifecycleProcessor is used.
APPLICATION_EVENT_MULTICASTER_BEAN_NAME
public static final String APPLICATION_EVENT_MULTICASTER_BEAN_NAME
Name of the ApplicationEventMulticaster bean in the factory. If none is supplied, a default SimpleApplicationEventMulticaster is used.
构造器详细资料
AbstractApplicationContext
public AbstractApplicationContext()
Create a new AbstractApplicationContext with no parent.
AbstractApplicationContext
public AbstractApplicationContext(@Nullable ApplicationContext parent)
Create a new AbstractApplicationContext with the given parent context.- 参数:
parent
- the parent context
方法详细资料
setId
public void setId(String id)
Set the unique id of this application context.Default is the object id of the context instance, or the name of the context bean if the context is itself defined as a bean.
- 指定者:
setId
在接口中ConfigurableApplicationContext
- 参数:
id
- the unique id of the context
getId
public String getId()
从接口复制的说明:ApplicationContext
Return the unique id of this application context.- 指定者:
getId
在接口中ApplicationContext
- 返回:
- the unique id of the context, or
null
if none
getApplicationName
public String getApplicationName()
从接口复制的说明:ApplicationContext
Return a name for the deployed application that this context belongs to.- 指定者:
getApplicationName
在接口中ApplicationContext
- 返回:
- a name for the deployed application, or the empty String by default
setDisplayName
public void setDisplayName(String displayName)
Set a friendly name for this context. Typically done during initialization of concrete context implementations.Default is the object id of the context instance.
getDisplayName
public String getDisplayName()
Return a friendly name for this context.- 指定者:
getDisplayName
在接口中ApplicationContext
- 返回:
- a display name for this context (never
null
)
getParent
@Nullable public ApplicationContext getParent()
Return the parent context, ornull
if there is no parent (that is, this context is the root of the context hierarchy).- 指定者:
getParent
在接口中ApplicationContext
- 返回:
- the parent context, or
null
if there is no parent
setEnvironment
public void setEnvironment(ConfigurableEnvironment environment)
Set theEnvironment
for this application context.Default value is determined by
createEnvironment()
. Replacing the default with this method is one option but configuration throughgetEnvironment()
should also be considered. In either case, such modifications should be performed beforerefresh()
.- 指定者:
setEnvironment
在接口中ConfigurableApplicationContext
- 参数:
environment
- the new environment- 另请参阅:
createEnvironment()
getEnvironment
public ConfigurableEnvironment getEnvironment()
Return theEnvironment
for this application context in configurable form, allowing for further customization.If none specified, a default environment will be initialized via
createEnvironment()
.- 指定者:
getEnvironment
在接口中ConfigurableApplicationContext
- 指定者:
getEnvironment
在接口中EnvironmentCapable
createEnvironment
protected ConfigurableEnvironment createEnvironment()
Create and return a newStandardEnvironment
.Subclasses may override this method in order to supply a custom
ConfigurableEnvironment
implementation.
getAutowireCapableBeanFactory
public AutowireCapableBeanFactory getAutowireCapableBeanFactory() throws IllegalStateException
Return this context's internal bean factory as AutowireCapableBeanFactory, if already available.- 指定者:
getAutowireCapableBeanFactory
在接口中ApplicationContext
- 返回:
- the AutowireCapableBeanFactory for this context
- 抛出:
IllegalStateException
- if the context does not support theAutowireCapableBeanFactory
interface, or does not hold an autowire-capable bean factory yet (e.g. ifrefresh()
has never been called), or if the context has been closed already- 另请参阅:
getBeanFactory()
getStartupDate
public long getStartupDate()
Return the timestamp (ms) when this context was first loaded.- 指定者:
getStartupDate
在接口中ApplicationContext
- 返回:
- the timestamp (ms) when this context was first loaded
publishEvent
public void publishEvent(ApplicationEvent event)
Publish the given event to all listeners.Note: Listeners get initialized after the MessageSource, to be able to access it within listener implementations. Thus, MessageSource implementations cannot publish events.
- 指定者:
publishEvent
在接口中ApplicationEventPublisher
- 参数:
event
- the event to publish (may be application-specific or a standard framework event)- 另请参阅:
ApplicationEventPublisher.publishEvent(Object)
,ContextRefreshedEvent
,ContextClosedEvent
publishEvent
public void publishEvent(Object event)
Publish the given event to all listeners.Note: Listeners get initialized after the MessageSource, to be able to access it within listener implementations. Thus, MessageSource implementations cannot publish events.
- 指定者:
publishEvent
在接口中ApplicationEventPublisher
- 参数:
event
- the event to publish (may be anApplicationEvent
or a payload object to be turned into aPayloadApplicationEvent
)- 另请参阅:
ApplicationEventPublisher.publishEvent(ApplicationEvent)
,PayloadApplicationEvent
publishEvent
protected void publishEvent(Object event, @Nullable ResolvableType eventType)
Publish the given event to all listeners.- 参数:
event
- the event to publish (may be anApplicationEvent
or a payload object to be turned into aPayloadApplicationEvent
)eventType
- the resolved event type, if known- 从以下版本开始:
- 4.2
getResourcePatternResolver
protected ResourcePatternResolver getResourcePatternResolver()
Return the ResourcePatternResolver to use for resolving location patterns into Resource instances. Default is aPathMatchingResourcePatternResolver
, supporting Ant-style location patterns.Can be overridden in subclasses, for extended resolution strategies, for example in a web environment.
Do not call this when needing to resolve a location pattern. Call the context's
getResources
method instead, which will delegate to the ResourcePatternResolver.- 返回:
- the ResourcePatternResolver for this context
- 另请参阅:
getResources(java.lang.String)
,PathMatchingResourcePatternResolver
setParent
public void setParent(@Nullable ApplicationContext parent)
Set the parent of this application context.The parent environment is merged with this (child) application context environment if the parent is non-
null
and its environment is an instance ofConfigurableEnvironment
.- 指定者:
setParent
在接口中ConfigurableApplicationContext
- 参数:
parent
- the parent context- 另请参阅:
ConfigurableEnvironment.merge(ConfigurableEnvironment)
addBeanFactoryPostProcessor
public void addBeanFactoryPostProcessor(BeanFactoryPostProcessor postProcessor)
从接口复制的说明:ConfigurableApplicationContext
Add a new BeanFactoryPostProcessor that will get applied to the internal bean factory of this application context on refresh, before any of the bean definitions get evaluated. To be invoked during context configuration.- 指定者:
addBeanFactoryPostProcessor
在接口中ConfigurableApplicationContext
- 参数:
postProcessor
- the factory processor to register
getBeanFactoryPostProcessors
public List<BeanFactoryPostProcessor> getBeanFactoryPostProcessors()
Return the list of BeanFactoryPostProcessors that will get applied to the internal BeanFactory.
addApplicationListener
public void addApplicationListener(ApplicationListener<?> listener)
从接口复制的说明:ConfigurableApplicationContext
Add a new ApplicationListener that will be notified on context events such as context refresh and context shutdown.Note that any ApplicationListener registered here will be applied on refresh if the context is not active yet, or on the fly with the current event multicaster in case of a context that is already active.
- 指定者:
addApplicationListener
在接口中ConfigurableApplicationContext
- 参数:
listener
- the ApplicationListener to register- 另请参阅:
ContextRefreshedEvent
,ContextClosedEvent
getApplicationListeners
public Collection<ApplicationListener<?>> getApplicationListeners()
Return the list of statically specified ApplicationListeners.
refresh
public void refresh() throws BeansException, IllegalStateException
从接口复制的说明:ConfigurableApplicationContext
Load or refresh the persistent representation of the configuration, which might be from Java-based configuration, an XML file, a properties file, a relational database schema, or some other format.As this is a startup method, it should destroy already created singletons if it fails, to avoid dangling resources. In other words, after invocation of this method, either all or no singletons at all should be instantiated.
- 指定者:
refresh
在接口中ConfigurableApplicationContext
- 抛出:
BeansException
- if the bean factory could not be initializedIllegalStateException
- if already initialized and multiple refresh attempts are not supported
prepareRefresh
protected void prepareRefresh()
Prepare this context for refreshing, setting its startup date and active flag as well as performing any initialization of property sources.
initPropertySources
protected void initPropertySources()
Replace any stub property sources with actual instances.
obtainFreshBeanFactory
protected ConfigurableListableBeanFactory obtainFreshBeanFactory()
Tell the subclass to refresh the internal bean factory.- 返回:
- the fresh BeanFactory instance
- 另请参阅:
refreshBeanFactory()
,getBeanFactory()
prepareBeanFactory
protected void prepareBeanFactory(ConfigurableListableBeanFactory beanFactory)
Configure the factory's standard context characteristics, such as the context's ClassLoader and post-processors.- 参数:
beanFactory
- the BeanFactory to configure
postProcessBeanFactory
protected void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory)
Modify the application context's internal bean factory after its standard initialization. All bean definitions will have been loaded, but no beans will have been instantiated yet. This allows for registering special BeanPostProcessors etc in certain ApplicationContext implementations.- 参数:
beanFactory
- the bean factory used by the application context
invokeBeanFactoryPostProcessors
protected void invokeBeanFactoryPostProcessors(ConfigurableListableBeanFactory beanFactory)
Instantiate and invoke all registered BeanFactoryPostProcessor beans, respecting explicit order if given.Must be called before singleton instantiation.
registerBeanPostProcessors
protected void registerBeanPostProcessors(ConfigurableListableBeanFactory beanFactory)
Instantiate and register all BeanPostProcessor beans, respecting explicit order if given.Must be called before any instantiation of application beans.
initMessageSource
protected void initMessageSource()
Initialize the MessageSource. Use parent's if none defined in this context.
initApplicationEventMulticaster
protected void initApplicationEventMulticaster()
Initialize the ApplicationEventMulticaster. Uses SimpleApplicationEventMulticaster if none defined in the context.
initLifecycleProcessor
protected void initLifecycleProcessor()
Initialize the LifecycleProcessor. Uses DefaultLifecycleProcessor if none defined in the context.
onRefresh
protected void onRefresh() throws BeansException
Template method which can be overridden to add context-specific refresh work. Called on initialization of special beans, before instantiation of singletons.This implementation is empty.
- 抛出:
BeansException
- in case of errors- 另请参阅:
refresh()
registerListeners
protected void registerListeners()
Add beans that implement ApplicationListener as listeners. Doesn't affect other listeners, which can be added without being beans.
finishBeanFactoryInitialization
protected void finishBeanFactoryInitialization(ConfigurableListableBeanFactory beanFactory)
Finish the initialization of this context's bean factory, initializing all remaining singleton beans.
finishRefresh
protected void finishRefresh()
Finish the refresh of this context, invoking the LifecycleProcessor's onRefresh() method and publishing theContextRefreshedEvent
.
cancelRefresh
protected void cancelRefresh(BeansException ex)
Cancel this context's refresh attempt, resetting theactive
flag after an exception got thrown.- 参数:
ex
- the exception that led to the cancellation
resetCommonCaches
protected void resetCommonCaches()
Reset Spring's common reflection metadata caches, in particular theReflectionUtils
,AnnotationUtils
,ResolvableType
andCachedIntrospectionResults
caches.
registerShutdownHook
public void registerShutdownHook()
Register a shutdown hook namedSpringContextShutdownHook
with the JVM runtime, closing this context on JVM shutdown unless it has already been closed at that time.Delegates to
doClose()
for the actual closing procedure.
destroy
@Deprecated public void destroy()
已过时。as of Spring Framework 5.0, in favor ofclose()
Callback for destruction of this instance, originally attached to aDisposableBean
implementation (not anymore in 5.0).The
close()
method is the native way to shut down an ApplicationContext, which this method simply delegates to.
close
public void close()
Close this application context, destroying all beans in its bean factory.Delegates to
doClose()
for the actual closing procedure. Also removes a JVM shutdown hook, if registered, as it's not needed anymore.- 指定者:
close
在接口中AutoCloseable
- 指定者:
close
在接口中Closeable
- 指定者:
close
在接口中ConfigurableApplicationContext
- 另请参阅:
doClose()
,registerShutdownHook()
doClose
protected void doClose()
Actually performs context closing: publishes a ContextClosedEvent and destroys the singletons in the bean factory of this application context.Called by both
close()
and a JVM shutdown hook, if any.
destroyBeans
protected void destroyBeans()
Template method for destroying all beans that this context manages. The default implementation destroy all cached singletons in this context, invokingDisposableBean.destroy()
and/or the specified "destroy-method".Can be overridden to add context-specific bean destruction steps right before or right after standard singleton destruction, while the context's BeanFactory is still active.
onClose
protected void onClose()
Template method which can be overridden to add context-specific shutdown work. The default implementation is empty.Called at the end of
doClose()
's shutdown procedure, after this context's BeanFactory has been closed. If custom shutdown logic needs to execute while the BeanFactory is still active, override thedestroyBeans()
method instead.
isActive
public boolean isActive()
从接口复制的说明:ConfigurableApplicationContext
Determine whether this application context is active, that is, whether it has been refreshed at least once and has not been closed yet.- 指定者:
isActive
在接口中ConfigurableApplicationContext
- 返回:
- whether the context is still active
- 另请参阅:
ConfigurableApplicationContext.refresh()
,ConfigurableApplicationContext.close()
,ConfigurableApplicationContext.getBeanFactory()
assertBeanFactoryActive
protected void assertBeanFactoryActive()
Assert that this context's BeanFactory is currently active, throwing anIllegalStateException
if it isn't.Invoked by all
BeanFactory
delegation methods that depend on an active context, i.e. in particular all bean accessor methods.The default implementation checks the
'active'
status of this context overall. May be overridden for more specific checks, or for a no-op ifgetBeanFactory()
itself throws an exception in such a case.
getBean
public Object getBean(String name) throws BeansException
从接口复制的说明:BeanFactory
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.
- 指定者:
getBean
在接口中BeanFactory
- 参数:
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
public <T> T getBean(String name, Class<T> requiredType) throws BeansException
从接口复制的说明:BeanFactory
Return an instance, which may be shared or independent, of the specified bean.Behaves the same as
BeanFactory.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 withBeanFactory.getBean(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.
- 指定者:
getBean
在接口中BeanFactory
- 参数:
name
- the name of the bean to retrieverequiredType
- type the bean must match; can be an interface or superclass- 返回:
- 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
public Object getBean(String name, Object... args) throws BeansException
从接口复制的说明:BeanFactory
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.
- 指定者:
getBean
在接口中BeanFactory
- 参数:
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
getBean
public <T> T getBean(Class<T> requiredType) throws BeansException
从接口复制的说明:BeanFactory
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
.- 指定者:
getBean
在接口中BeanFactory
- 参数:
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- 另请参阅:
ListableBeanFactory
getBean
public <T> T getBean(Class<T> requiredType, Object... args) throws BeansException
从接口复制的说明:BeanFactory
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
.- 指定者:
getBean
在接口中BeanFactory
- 参数:
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
getBeanProvider
public <T> ObjectProvider<T> getBeanProvider(Class<T> requiredType)
从接口复制的说明:BeanFactory
Return a provider for the specified bean, allowing for lazy on-demand retrieval of instances, including availability and uniqueness options.- 指定者:
getBeanProvider
在接口中BeanFactory
- 参数:
requiredType
- type the bean must match; can be an interface or superclass- 返回:
- a corresponding provider handle
- 另请参阅:
BeanFactory.getBeanProvider(ResolvableType)
getBeanProvider
public <T> ObjectProvider<T> getBeanProvider(ResolvableType requiredType)
从接口复制的说明:BeanFactory
Return a provider for the specified bean, allowing for lazy on-demand retrieval of instances, including availability and uniqueness options.- 指定者:
getBeanProvider
在接口中BeanFactory
- 参数:
requiredType
- type the bean must match; can be a generic type declaration. Note that collection types are not supported here, in contrast to reflective injection points. For programmatically retrieving a list of beans matching a specific type, specify the actual bean type as an argument here and subsequently useObjectProvider.orderedStream()
or its lazy streaming/iteration options.- 返回:
- a corresponding provider handle
- 另请参阅:
ObjectProvider.iterator()
,ObjectProvider.stream()
,ObjectProvider.orderedStream()
containsBean
public boolean containsBean(String name)
从接口复制的说明:BeanFactory
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 thatBeanFactory.getBean(java.lang.String)
will be able to obtain an instance for the same name.- 指定者:
containsBean
在接口中BeanFactory
- 参数:
name
- the name of the bean to query- 返回:
- whether a bean with the given name is present
isSingleton
public boolean isSingleton(String name) throws NoSuchBeanDefinitionException
从接口复制的说明:BeanFactory
Is this bean a shared singleton? That is, willBeanFactory.getBean(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 theBeanFactory.isPrototype(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.
- 指定者:
isSingleton
在接口中BeanFactory
- 参数:
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- 另请参阅:
BeanFactory.getBean(java.lang.String)
,BeanFactory.isPrototype(java.lang.String)
isPrototype
public boolean isPrototype(String name) throws NoSuchBeanDefinitionException
从接口复制的说明:BeanFactory
Is this bean a prototype? That is, willBeanFactory.getBean(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 theBeanFactory.isSingleton(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.
- 指定者:
isPrototype
在接口中BeanFactory
- 参数:
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- 另请参阅:
BeanFactory.getBean(java.lang.String)
,BeanFactory.isSingleton(java.lang.String)
isTypeMatch
public boolean isTypeMatch(String name, ResolvableType typeToMatch) throws NoSuchBeanDefinitionException
从接口复制的说明:BeanFactory
Check whether the bean with the given name matches the specified type. More specifically, check whether aBeanFactory.getBean(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.
- 指定者:
isTypeMatch
在接口中BeanFactory
- 参数:
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- 另请参阅:
BeanFactory.getBean(java.lang.String)
,BeanFactory.getType(java.lang.String)
isTypeMatch
public boolean isTypeMatch(String name, Class<?> typeToMatch) throws NoSuchBeanDefinitionException
从接口复制的说明:BeanFactory
Check whether the bean with the given name matches the specified type. More specifically, check whether aBeanFactory.getBean(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.
- 指定者:
isTypeMatch
在接口中BeanFactory
- 参数:
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- 另请参阅:
BeanFactory.getBean(java.lang.String)
,BeanFactory.getType(java.lang.String)
getType
@Nullable public Class<?> getType(String name) throws NoSuchBeanDefinitionException
从接口复制的说明:BeanFactory
Determine the type of the bean with the given name. More specifically, determine the type of object thatBeanFactory.getBean(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()
. This may lead to the initialization of a previously uninitializedFactoryBean
(seeBeanFactory.getType(String, boolean)
).Translates aliases back to the corresponding canonical bean name.
Will ask the parent factory if the bean cannot be found in this factory instance.
- 指定者:
getType
在接口中BeanFactory
- 参数:
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- 另请参阅:
BeanFactory.getBean(java.lang.String)
,BeanFactory.isTypeMatch(java.lang.String, org.springframework.core.ResolvableType)
getType
@Nullable public Class<?> getType(String name, boolean allowFactoryBeanInit) throws NoSuchBeanDefinitionException
从接口复制的说明:BeanFactory
Determine the type of the bean with the given name. More specifically, determine the type of object thatBeanFactory.getBean(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()
. Depending on theallowFactoryBeanInit
flag, this may lead to the initialization of a previously uninitializedFactoryBean
if no early type information is available.Translates aliases back to the corresponding canonical bean name.
Will ask the parent factory if the bean cannot be found in this factory instance.
- 指定者:
getType
在接口中BeanFactory
- 参数:
name
- the name of the bean to queryallowFactoryBeanInit
- whether aFactoryBean
may get initialized just for the purpose of determining its object type- 返回:
- the type of the bean, or
null
if not determinable - 抛出:
NoSuchBeanDefinitionException
- if there is no bean with the given name- 另请参阅:
BeanFactory.getBean(java.lang.String)
,BeanFactory.isTypeMatch(java.lang.String, org.springframework.core.ResolvableType)
getAliases
public String[] getAliases(String name)
从接口复制的说明:BeanFactory
Return the aliases for the given bean name, if any.All of those aliases point to the same bean when used in a
BeanFactory.getBean(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.
- 指定者:
getAliases
在接口中BeanFactory
- 参数:
name
- the bean name to check for aliases- 返回:
- the aliases, or an empty array if none
- 另请参阅:
BeanFactory.getBean(java.lang.String)
containsBeanDefinition
public boolean containsBeanDefinition(String beanName)
从接口复制的说明:ListableBeanFactory
Check if this bean factory contains a bean definition with the given name.Does not consider any hierarchy this factory may participate in, and ignores any singleton beans that have been registered by other means than bean definitions.
- 指定者:
containsBeanDefinition
在接口中ListableBeanFactory
- 参数:
beanName
- the name of the bean to look for- 返回:
- if this bean factory contains a bean definition with the given name
- 另请参阅:
BeanFactory.containsBean(java.lang.String)
getBeanDefinitionCount
public int getBeanDefinitionCount()
从接口复制的说明:ListableBeanFactory
Return the number of beans defined in the factory.Does not consider any hierarchy this factory may participate in, and ignores any singleton beans that have been registered by other means than bean definitions.
- 指定者:
getBeanDefinitionCount
在接口中ListableBeanFactory
- 返回:
- the number of beans defined in the factory
getBeanDefinitionNames
public String[] getBeanDefinitionNames()
从接口复制的说明:ListableBeanFactory
Return the names of all beans defined in this factory.Does not consider any hierarchy this factory may participate in, and ignores any singleton beans that have been registered by other means than bean definitions.
- 指定者:
getBeanDefinitionNames
在接口中ListableBeanFactory
- 返回:
- the names of all beans defined in this factory, or an empty array if none defined
getBeanNamesForType
public String[] getBeanNamesForType(ResolvableType type)
从接口复制的说明:ListableBeanFactory
Return the names of beans matching the given type (including subclasses), judging from either bean definitions or the value ofgetObjectType
in the case of FactoryBeans.NOTE: This method introspects top-level beans only. It does not check nested beans which might match the specified type as well.
Does consider objects created by FactoryBeans, which means that FactoryBeans will get initialized. If the object created by the FactoryBean doesn't match, the raw FactoryBean itself will be matched against the type.
Does not consider any hierarchy this factory may participate in. Use BeanFactoryUtils'
beanNamesForTypeIncludingAncestors
to include beans in ancestor factories too.Note: Does not ignore singleton beans that have been registered by other means than bean definitions.
This version of
getBeanNamesForType
matches all kinds of beans, be it singletons, prototypes, or FactoryBeans. In most implementations, the result will be the same as forgetBeanNamesForType(type, true, true)
.Bean names returned by this method should always return bean names in the order of definition in the backend configuration, as far as possible.
- 指定者:
getBeanNamesForType
在接口中ListableBeanFactory
- 参数:
type
- the generically typed class or interface to match- 返回:
- the names of beans (or objects created by FactoryBeans) matching the given object type (including subclasses), or an empty array if none
- 另请参阅:
BeanFactory.isTypeMatch(String, ResolvableType)
,FactoryBean.getObjectType()
,BeanFactoryUtils.beanNamesForTypeIncludingAncestors(ListableBeanFactory, ResolvableType)
getBeanNamesForType
public String[] getBeanNamesForType(ResolvableType type, boolean includeNonSingletons, boolean allowEagerInit)
从接口复制的说明:ListableBeanFactory
Return the names of beans matching the given type (including subclasses), judging from either bean definitions or the value ofgetObjectType
in the case of FactoryBeans.NOTE: This method introspects top-level beans only. It does not check nested beans which might match the specified type as well.
Does consider objects created by FactoryBeans if the "allowEagerInit" flag is set, which means that FactoryBeans will get initialized. If the object created by the FactoryBean doesn't match, the raw FactoryBean itself will be matched against the type. If "allowEagerInit" is not set, only raw FactoryBeans will be checked (which doesn't require initialization of each FactoryBean).
Does not consider any hierarchy this factory may participate in. Use BeanFactoryUtils'
beanNamesForTypeIncludingAncestors
to include beans in ancestor factories too.Note: Does not ignore singleton beans that have been registered by other means than bean definitions.
Bean names returned by this method should always return bean names in the order of definition in the backend configuration, as far as possible.
- 指定者:
getBeanNamesForType
在接口中ListableBeanFactory
- 参数:
type
- the generically typed class or interface to matchincludeNonSingletons
- whether to include prototype or scoped beans too or just singletons (also applies to FactoryBeans)allowEagerInit
- whether to initialize lazy-init singletons and objects created by FactoryBeans (or by factory methods with a "factory-bean" reference) for the type check. Note that FactoryBeans need to be eagerly initialized to determine their type: So be aware that passing in "true" for this flag will initialize FactoryBeans and "factory-bean" references.- 返回:
- the names of beans (or objects created by FactoryBeans) matching the given object type (including subclasses), or an empty array if none
- 另请参阅:
FactoryBean.getObjectType()
,BeanFactoryUtils.beanNamesForTypeIncludingAncestors(ListableBeanFactory, ResolvableType, boolean, boolean)
getBeanNamesForType
public String[] getBeanNamesForType(@Nullable Class<?> type)
从接口复制的说明:ListableBeanFactory
Return the names of beans matching the given type (including subclasses), judging from either bean definitions or the value ofgetObjectType
in the case of FactoryBeans.NOTE: This method introspects top-level beans only. It does not check nested beans which might match the specified type as well.
Does consider objects created by FactoryBeans, which means that FactoryBeans will get initialized. If the object created by the FactoryBean doesn't match, the raw FactoryBean itself will be matched against the type.
Does not consider any hierarchy this factory may participate in. Use BeanFactoryUtils'
beanNamesForTypeIncludingAncestors
to include beans in ancestor factories too.Note: Does not ignore singleton beans that have been registered by other means than bean definitions.
This version of
getBeanNamesForType
matches all kinds of beans, be it singletons, prototypes, or FactoryBeans. In most implementations, the result will be the same as forgetBeanNamesForType(type, true, true)
.Bean names returned by this method should always return bean names in the order of definition in the backend configuration, as far as possible.
- 指定者:
getBeanNamesForType
在接口中ListableBeanFactory
- 参数:
type
- the class or interface to match, ornull
for all bean names- 返回:
- the names of beans (or objects created by FactoryBeans) matching the given object type (including subclasses), or an empty array if none
- 另请参阅:
FactoryBean.getObjectType()
,BeanFactoryUtils.beanNamesForTypeIncludingAncestors(ListableBeanFactory, Class)
getBeanNamesForType
public String[] getBeanNamesForType(@Nullable Class<?> type, boolean includeNonSingletons, boolean allowEagerInit)
从接口复制的说明:ListableBeanFactory
Return the names of beans matching the given type (including subclasses), judging from either bean definitions or the value ofgetObjectType
in the case of FactoryBeans.NOTE: This method introspects top-level beans only. It does not check nested beans which might match the specified type as well.
Does consider objects created by FactoryBeans if the "allowEagerInit" flag is set, which means that FactoryBeans will get initialized. If the object created by the FactoryBean doesn't match, the raw FactoryBean itself will be matched against the type. If "allowEagerInit" is not set, only raw FactoryBeans will be checked (which doesn't require initialization of each FactoryBean).
Does not consider any hierarchy this factory may participate in. Use BeanFactoryUtils'
beanNamesForTypeIncludingAncestors
to include beans in ancestor factories too.Note: Does not ignore singleton beans that have been registered by other means than bean definitions.
Bean names returned by this method should always return bean names in the order of definition in the backend configuration, as far as possible.
- 指定者:
getBeanNamesForType
在接口中ListableBeanFactory
- 参数:
type
- the class or interface to match, ornull
for all bean namesincludeNonSingletons
- whether to include prototype or scoped beans too or just singletons (also applies to FactoryBeans)allowEagerInit
- whether to initialize lazy-init singletons and objects created by FactoryBeans (or by factory methods with a "factory-bean" reference) for the type check. Note that FactoryBeans need to be eagerly initialized to determine their type: So be aware that passing in "true" for this flag will initialize FactoryBeans and "factory-bean" references.- 返回:
- the names of beans (or objects created by FactoryBeans) matching the given object type (including subclasses), or an empty array if none
- 另请参阅:
FactoryBean.getObjectType()
,BeanFactoryUtils.beanNamesForTypeIncludingAncestors(ListableBeanFactory, Class, boolean, boolean)
getBeansOfType
public <T> Map<String,T> getBeansOfType(@Nullable Class<T> type) throws BeansException
从接口复制的说明:ListableBeanFactory
Return the bean instances that match the given object type (including subclasses), judging from either bean definitions or the value ofgetObjectType
in the case of FactoryBeans.NOTE: This method introspects top-level beans only. It does not check nested beans which might match the specified type as well.
Does consider objects created by FactoryBeans, which means that FactoryBeans will get initialized. If the object created by the FactoryBean doesn't match, the raw FactoryBean itself will be matched against the type.
Does not consider any hierarchy this factory may participate in. Use BeanFactoryUtils'
beansOfTypeIncludingAncestors
to include beans in ancestor factories too.Note: Does not ignore singleton beans that have been registered by other means than bean definitions.
This version of getBeansOfType matches all kinds of beans, be it singletons, prototypes, or FactoryBeans. In most implementations, the result will be the same as for
getBeansOfType(type, true, true)
.The Map returned by this method should always return bean names and corresponding bean instances in the order of definition in the backend configuration, as far as possible.
- 指定者:
getBeansOfType
在接口中ListableBeanFactory
- 参数:
type
- the class or interface to match, ornull
for all concrete beans- 返回:
- a Map with the matching beans, containing the bean names as keys and the corresponding bean instances as values
- 抛出:
BeansException
- if a bean could not be created- 另请参阅:
FactoryBean.getObjectType()
,BeanFactoryUtils.beansOfTypeIncludingAncestors(ListableBeanFactory, Class)
getBeansOfType
public <T> Map<String,T> getBeansOfType(@Nullable Class<T> type, boolean includeNonSingletons, boolean allowEagerInit) throws BeansException
从接口复制的说明:ListableBeanFactory
Return the bean instances that match the given object type (including subclasses), judging from either bean definitions or the value ofgetObjectType
in the case of FactoryBeans.NOTE: This method introspects top-level beans only. It does not check nested beans which might match the specified type as well.
Does consider objects created by FactoryBeans if the "allowEagerInit" flag is set, which means that FactoryBeans will get initialized. If the object created by the FactoryBean doesn't match, the raw FactoryBean itself will be matched against the type. If "allowEagerInit" is not set, only raw FactoryBeans will be checked (which doesn't require initialization of each FactoryBean).
Does not consider any hierarchy this factory may participate in. Use BeanFactoryUtils'
beansOfTypeIncludingAncestors
to include beans in ancestor factories too.Note: Does not ignore singleton beans that have been registered by other means than bean definitions.
The Map returned by this method should always return bean names and corresponding bean instances in the order of definition in the backend configuration, as far as possible.
- 指定者:
getBeansOfType
在接口中ListableBeanFactory
- 参数:
type
- the class or interface to match, ornull
for all concrete beansincludeNonSingletons
- whether to include prototype or scoped beans too or just singletons (also applies to FactoryBeans)allowEagerInit
- whether to initialize lazy-init singletons and objects created by FactoryBeans (or by factory methods with a "factory-bean" reference) for the type check. Note that FactoryBeans need to be eagerly initialized to determine their type: So be aware that passing in "true" for this flag will initialize FactoryBeans and "factory-bean" references.- 返回:
- a Map with the matching beans, containing the bean names as keys and the corresponding bean instances as values
- 抛出:
BeansException
- if a bean could not be created- 另请参阅:
FactoryBean.getObjectType()
,BeanFactoryUtils.beansOfTypeIncludingAncestors(ListableBeanFactory, Class, boolean, boolean)
getBeanNamesForAnnotation
public String[] getBeanNamesForAnnotation(Class<? extends Annotation> annotationType)
从接口复制的说明:ListableBeanFactory
Find all names of beans which are annotated with the suppliedAnnotation
type, without creating corresponding bean instances yet.Note that this method considers objects created by FactoryBeans, which means that FactoryBeans will get initialized in order to determine their object type.
- 指定者:
getBeanNamesForAnnotation
在接口中ListableBeanFactory
- 参数:
annotationType
- the type of annotation to look for (at class, interface or factory method level of the specified bean)- 返回:
- the names of all matching beans
- 另请参阅:
ListableBeanFactory.findAnnotationOnBean(java.lang.String, java.lang.Class<A>)
getBeansWithAnnotation
public Map<String,Object> getBeansWithAnnotation(Class<? extends Annotation> annotationType) throws BeansException
从接口复制的说明:ListableBeanFactory
Find all beans which are annotated with the suppliedAnnotation
type, returning a Map of bean names with corresponding bean instances.Note that this method considers objects created by FactoryBeans, which means that FactoryBeans will get initialized in order to determine their object type.
- 指定者:
getBeansWithAnnotation
在接口中ListableBeanFactory
- 参数:
annotationType
- the type of annotation to look for (at class, interface or factory method level of the specified bean)- 返回:
- a Map with the matching beans, containing the bean names as keys and the corresponding bean instances as values
- 抛出:
BeansException
- if a bean could not be created- 另请参阅:
ListableBeanFactory.findAnnotationOnBean(java.lang.String, java.lang.Class<A>)
findAnnotationOnBean
@Nullable public <A extends Annotation> A findAnnotationOnBean(String beanName, Class<A> annotationType) throws NoSuchBeanDefinitionException
从接口复制的说明:ListableBeanFactory
Find anAnnotation
ofannotationType
on the specified bean, traversing its interfaces and super classes if no annotation can be found on the given class itself, as well as checking the bean's factory method (if any).- 指定者:
findAnnotationOnBean
在接口中ListableBeanFactory
- 参数:
beanName
- the name of the bean to look for annotations onannotationType
- the type of annotation to look for (at class, interface or factory method level of the specified bean)- 返回:
- the annotation of the given type if found, or
null
otherwise - 抛出:
NoSuchBeanDefinitionException
- if there is no bean with the given name- 另请参阅:
ListableBeanFactory.getBeanNamesForAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation>)
,ListableBeanFactory.getBeansWithAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation>)
getParentBeanFactory
@Nullable public BeanFactory getParentBeanFactory()
从接口复制的说明:HierarchicalBeanFactory
Return the parent bean factory, ornull
if there is none.
containsLocalBean
public boolean containsLocalBean(String name)
从接口复制的说明:HierarchicalBeanFactory
Return whether the local bean factory contains a bean of the given name, ignoring beans defined in ancestor contexts.This is an alternative to
containsBean
, ignoring a bean of the given name from an ancestor bean factory.- 指定者:
containsLocalBean
在接口中HierarchicalBeanFactory
- 参数:
name
- the name of the bean to query- 返回:
- whether a bean with the given name is defined in the local factory
- 另请参阅:
BeanFactory.containsBean(java.lang.String)
getInternalParentBeanFactory
@Nullable protected BeanFactory getInternalParentBeanFactory()
Return the internal bean factory of the parent context if it implements ConfigurableApplicationContext; else, return the parent context itself.
getMessage
public String getMessage(String code, @Nullable Object[] args, @Nullable String defaultMessage, Locale locale)
从接口复制的说明:MessageSource
Try to resolve the message. Return default message if no message was found.- 指定者:
getMessage
在接口中MessageSource
- 参数:
code
- the message code to look up, e.g. 'calculator.noRateSet'. MessageSource users are encouraged to base message names on qualified class or package names, avoiding potential conflicts and ensuring maximum clarity.args
- an array of arguments that will be filled in for params within the message (params look like "{0}", "{1,date}", "{2,time}" within a message), ornull
if nonedefaultMessage
- a default message to return if the lookup failslocale
- the locale in which to do the lookup- 返回:
- the resolved message if the lookup was successful, otherwise the default message passed as a parameter (which may be
null
) - 另请参阅:
MessageSource.getMessage(MessageSourceResolvable, Locale)
,MessageFormat
getMessage
public String getMessage(String code, @Nullable Object[] args, Locale locale) throws NoSuchMessageException
从接口复制的说明:MessageSource
Try to resolve the message. Treat as an error if the message can't be found.- 指定者:
getMessage
在接口中MessageSource
- 参数:
code
- the message code to look up, e.g. 'calculator.noRateSet'. MessageSource users are encouraged to base message names on qualified class or package names, avoiding potential conflicts and ensuring maximum clarity.args
- an array of arguments that will be filled in for params within the message (params look like "{0}", "{1,date}", "{2,time}" within a message), ornull
if nonelocale
- the locale in which to do the lookup- 返回:
- the resolved message (never
null
) - 抛出:
NoSuchMessageException
- if no corresponding message was found- 另请参阅:
MessageSource.getMessage(MessageSourceResolvable, Locale)
,MessageFormat
getMessage
public String getMessage(MessageSourceResolvable resolvable, Locale locale) throws NoSuchMessageException
从接口复制的说明:MessageSource
Try to resolve the message using all the attributes contained within theMessageSourceResolvable
argument that was passed in.NOTE: We must throw a
NoSuchMessageException
on this method since at the time of calling this method we aren't able to determine if thedefaultMessage
property of the resolvable isnull
or not.- 指定者:
getMessage
在接口中MessageSource
- 参数:
resolvable
- the value object storing attributes required to resolve a message (may include a default message)locale
- the locale in which to do the lookup- 返回:
- the resolved message (never
null
since even aMessageSourceResolvable
-provided default message needs to be non-null) - 抛出:
NoSuchMessageException
- if no corresponding message was found (and no default message was provided by theMessageSourceResolvable
)- 另请参阅:
MessageSourceResolvable.getCodes()
,MessageSourceResolvable.getArguments()
,MessageSourceResolvable.getDefaultMessage()
,MessageFormat
getInternalParentMessageSource
@Nullable protected MessageSource getInternalParentMessageSource()
Return the internal message source of the parent context if it is an AbstractApplicationContext too; else, return the parent context itself.
getResources
public Resource[] getResources(String locationPattern) throws IOException
从接口复制的说明:ResourcePatternResolver
Resolve the given location pattern into Resource objects.Overlapping resource entries that point to the same physical resource should be avoided, as far as possible. The result should have set semantics.
- 指定者:
getResources
在接口中ResourcePatternResolver
- 参数:
locationPattern
- the location pattern to resolve- 返回:
- the corresponding Resource objects
- 抛出:
IOException
- in case of I/O errors
start
public void start()
从接口复制的说明:Lifecycle
Start this component.Should not throw an exception if the component is already running.
In the case of a container, this will propagate the start signal to all components that apply.
- 指定者:
start
在接口中Lifecycle
- 另请参阅:
SmartLifecycle.isAutoStartup()
stop
public void stop()
从接口复制的说明:Lifecycle
Stop this component, typically in a synchronous fashion, such that the component is fully stopped upon return of this method. Consider implementingSmartLifecycle
and itsstop(Runnable)
variant when asynchronous stop behavior is necessary.Note that this stop notification is not guaranteed to come before destruction: On regular shutdown,
Lifecycle
beans will first receive a stop notification before the general destruction callbacks are being propagated; however, on hot refresh during a context's lifetime or on aborted refresh attempts, a given bean's destroy method will be called without any consideration of stop signals upfront.Should not throw an exception if the component is not running (not started yet).
In the case of a container, this will propagate the stop signal to all components that apply.
- 指定者:
stop
在接口中Lifecycle
- 另请参阅:
SmartLifecycle.stop(Runnable)
,DisposableBean.destroy()
isRunning
public boolean isRunning()
从接口复制的说明:Lifecycle
Check whether this component is currently running.In the case of a container, this will return
true
only if all components that apply are currently running.
refreshBeanFactory
protected abstract void refreshBeanFactory() throws BeansException, IllegalStateException
Subclasses must implement this method to perform the actual configuration load. The method is invoked byrefresh()
before any other initialization work.A subclass will either create a new bean factory and hold a reference to it, or return a single BeanFactory instance that it holds. In the latter case, it will usually throw an IllegalStateException if refreshing the context more than once.
- 抛出:
BeansException
- if initialization of the bean factory failedIllegalStateException
- if already initialized and multiple refresh attempts are not supported
closeBeanFactory
protected abstract void closeBeanFactory()
Subclasses must implement this method to release their internal bean factory. This method gets invoked byclose()
after all other shutdown work.Should never throw an exception but rather log shutdown failures.
getBeanFactory
public abstract ConfigurableListableBeanFactory getBeanFactory() throws IllegalStateException
Subclasses must return their internal bean factory here. They should implement the lookup efficiently, so that it can be called repeatedly without a performance penalty.Note: Subclasses should check whether the context is still active before returning the internal bean factory. The internal factory should generally be considered unavailable once the context has been closed.
- 指定者:
getBeanFactory
在接口中ConfigurableApplicationContext
- 返回:
- this application context's internal bean factory (never
null
) - 抛出:
IllegalStateException
- if the context does not hold an internal bean factory yet (usually ifrefresh()
has never been called) or if the context has been closed already- 另请参阅:
refreshBeanFactory()
,closeBeanFactory()