类 AbstractApplicationContext

字段详细资料

• 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.

  另请参阅:

  LifecycleProcessor, DefaultLifecycleProcessor, 常量字段值

• 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.

  另请参阅:

  ApplicationEventMulticaster, SimpleApplicationEventMulticaster, 常量字段值

• logger

  protected final Log logger

  Logger used by this class. Available to subclasses.

构造器详细资料

• AbstractApplicationContext

  public AbstractApplicationContext()

  Create a new AbstractApplicationContext with no parent.

• AbstractApplicationContext

  public AbstractApplicationContext​(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

  public ApplicationContext getParent()

  Return the parent context, or null 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 the Environment for this application context.

  Default value is determined by createEnvironment(). Replacing the default with this method is one option but configuration through getEnvironment() 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 the Environment 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 new StandardEnvironment.

  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 the AutowireCapableBeanFactory interface, or does not hold an autowire-capable bean factory yet (e.g. if refresh() 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)

  另请参阅:

  RequestHandledEvent

• 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 an ApplicationEvent or a payload object to be turned into a PayloadApplicationEvent)

  另请参阅:

  PayloadApplicationEvent

• publishEvent

  protected void publishEvent​(Object event,
                              ResolvableType eventType)

  Publish the given event to all listeners.

  参数:

  event - the event to publish (may be an ApplicationEvent or a payload object to be turned into a PayloadApplicationEvent)

  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 a PathMatchingResourcePatternResolver, 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​(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 of ConfigurableEnvironment.

  指定者:

  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 initialized

  IllegalStateException - 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.

  另请参阅:

  PropertySource.StubPropertySource, WebApplicationContextUtils.initServletPropertySources(org.springframework.core.env.MutablePropertySources, javax.servlet.ServletContext)

• 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.

  另请参阅:

  SimpleApplicationEventMulticaster

• initLifecycleProcessor

  protected void initLifecycleProcessor()

  Initialize the LifecycleProcessor. Uses DefaultLifecycleProcessor if none defined in the context.

  另请参阅:

  DefaultLifecycleProcessor

• 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 the ContextRefreshedEvent.

• cancelRefresh

  protected void cancelRefresh​(BeansException ex)

  Cancel this context's refresh attempt, resetting the active flag after an exception got thrown.

  参数:

  ex - the exception that led to the cancellation

• resetCommonCaches

  protected void resetCommonCaches()

  Reset Spring's common core caches, in particular the ReflectionUtils, ResolvableType and CachedIntrospectionResults caches.

  从以下版本开始:

  4.2

  另请参阅:

  ReflectionUtils.clearCache(), ResolvableType.clearCache(), CachedIntrospectionResults.clearClassLoader(ClassLoader)

• registerShutdownHook

  public void registerShutdownHook()

  Register a shutdown hook 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.

  指定者:

  registerShutdownHook 在接口中 ConfigurableApplicationContext

  另请参阅:

  Runtime.addShutdownHook(java.lang.Thread), close(), doClose()

• destroy

  public void destroy()

  DisposableBean callback for destruction of this instance.

  The close() method is the native way to shut down an ApplicationContext, which this method simply delegates to.

  指定者:

  destroy 在接口中 DisposableBean

  另请参阅:

  close()

• 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.

  另请参阅:

  ContextClosedEvent, destroyBeans(), close(), registerShutdownHook()

• destroyBeans

  protected void destroyBeans()

  Template method for destroying all beans that this context manages. The default implementation destroy all cached singletons in this context, invoking DisposableBean.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.

  另请参阅:

  getBeanFactory(), ConfigurableBeanFactory.destroySingletons()

• 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 the destroyBeans() 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 an IllegalStateException 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 if getBeanFactory() 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 name

  BeansException - 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 with BeanFactory.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 retrieve

  requiredType - type the bean must match. Can be an interface or superclass of the actual class, or null for any match. For example, if the value is Object.class, this method will succeed whatever the class of the returned instance.

  返回:

  an instance of the bean

  抛出:

  NoSuchBeanDefinitionException - if there is no such bean definition

  BeanNotOfRequiredTypeException - if the bean is not of the required type

  BeansException - 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, use ListableBeanFactory and/or BeanFactoryUtils.

  指定者:

  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 found

  NoUniqueBeanDefinitionException - if more than one bean of the given type was found

  BeansException - if the bean could not be created

  另请参阅:

  ListableBeanFactory

• 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 retrieve

  args - 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 definition

  BeanDefinitionStoreException - if arguments have been given but the affected bean isn't a prototype

  BeansException - if the bean could not be created

• 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, use ListableBeanFactory and/or BeanFactoryUtils.

  指定者:

  getBean 在接口中 BeanFactory

  参数:

  requiredType - type the bean must match; can be an interface or superclass

  args - 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 definition

  BeanDefinitionStoreException - if arguments have been given but the affected bean isn't a prototype

  BeansException - if the bean could not be created

• 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 a true return value from this method does not necessarily indicate that BeanFactory.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, will BeanFactory.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 the BeanFactory.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, will BeanFactory.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 the BeanFactory.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 a BeanFactory.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 query

  typeToMatch - the type to match against (as a ResolvableType)

  返回:

  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 a BeanFactory.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 query

  typeToMatch - the type to match against (as a Class)

  返回:

  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

  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 that BeanFactory.getBean(java.lang.String) would return for the given name.

  For a FactoryBean, return the type of object that the FactoryBean creates, as exposed by FactoryBean.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.

  指定者:

  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)

• 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 of getObjectType 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 for getBeanNamesForType(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, or null 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

  另请参阅:

  BeanFactory.isTypeMatch(String, ResolvableType), FactoryBean.getObjectType(), BeanFactoryUtils.beanNamesForTypeIncludingAncestors(ListableBeanFactory, ResolvableType)

• getBeanNamesForType

  public String[] getBeanNamesForType​(Class<?> type)

  从接口复制的说明: ListableBeanFactory
  Return the names of beans matching the given type (including subclasses), judging from either bean definitions or the value of getObjectType 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 for getBeanNamesForType(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, or null 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​(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 of getObjectType 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, or null for all bean names

  includeNonSingletons - 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​(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 of getObjectType 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, or null 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​(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 of getObjectType 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, or null for all concrete beans

  includeNonSingletons - 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 supplied Annotation 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

  返回:

  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 supplied Annotation 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

  返回:

  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

  public <A extends Annotation> A findAnnotationOnBean​(String beanName,
                                                       Class<A> annotationType)
                                                throws NoSuchBeanDefinitionException

  从接口复制的说明: ListableBeanFactory
  Find an Annotation of annotationType on the specified bean, traversing its interfaces and super classes if no annotation can be found on the given class itself.

  指定者:

  findAnnotationOnBean 在接口中 ListableBeanFactory

  参数:

  beanName - the name of the bean to look for annotations on

  annotationType - the type of annotation to look for

  返回:

  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

  public BeanFactory getParentBeanFactory()

  从接口复制的说明: HierarchicalBeanFactory
  Return the parent bean factory, or null if there is none.

  指定者:

  getParentBeanFactory 在接口中 HierarchicalBeanFactory

• 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

  protected BeanFactory getInternalParentBeanFactory()

  Return the internal bean factory of the parent context if it implements ConfigurableApplicationContext; else, return the parent context itself.

  另请参阅:

  ConfigurableApplicationContext.getBeanFactory()

• getMessage

  public String getMessage​(String code,
                           Object[] args,
                           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), or null if none

  defaultMessage - a default message to return if the lookup fails

  locale - 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,
                           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), or null if none

  locale - 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 the MessageSourceResolvable 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 the defaultMessage property of the resolvable is null 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 a MessageSourceResolvable-provided default message needs to be non-null)

  抛出:

  NoSuchMessageException - if no corresponding message was found (and no default message was provided by the MessageSourceResolvable)

  另请参阅:

  MessageSourceResolvable.getCodes(), MessageSourceResolvable.getArguments(), MessageSourceResolvable.getDefaultMessage(), MessageFormat

• getInternalParentMessageSource

  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 implementing SmartLifecycle and its stop(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.

  指定者:

  isRunning 在接口中 Lifecycle

  返回:

  whether the component is 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 by refresh() 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 failed

  IllegalStateException - 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 by close() 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 if refresh() has never been called) or if the context has been closed already

  另请参阅:

  refreshBeanFactory(), closeBeanFactory()

• toString

  public String toString()

  Return information about this context.

  覆盖:

  toString 在类中 Object