Class GenericApplicationContext
- All Implemented Interfaces:
Closeable
,AutoCloseable
,BeanFactory
,HierarchicalBeanFactory
,ListableBeanFactory
,BeanDefinitionRegistry
,ApplicationContext
,ApplicationEventPublisher
,ConfigurableApplicationContext
,Lifecycle
,MessageSource
,AliasRegistry
,EnvironmentCapable
,ResourceLoader
,ResourcePatternResolver
- Direct Known Subclasses:
AnnotationConfigApplicationContext
,GenericGroovyApplicationContext
,GenericWebApplicationContext
,GenericXmlApplicationContext
,StaticApplicationContext
DefaultListableBeanFactory
instance and does not assume a specific bean definition format. Implements
the BeanDefinitionRegistry
interface in order to allow for applying any bean definition readers to it.
Typical usage is to register a variety of bean definitions via the
BeanDefinitionRegistry
interface and then call AbstractApplicationContext.refresh()
to initialize those beans
with application context semantics (handling
ApplicationContextAware
, auto-detecting
BeanFactoryPostProcessors
,
etc).
In contrast to other ApplicationContext implementations that create a new
internal BeanFactory instance for each refresh, the internal BeanFactory of
this context is available right from the start, to be able to register bean
definitions on it. AbstractApplicationContext.refresh()
may only be called once.
This ApplicationContext implementation is suitable for Ahead of Time
processing, using refreshForAotProcessing(org.springframework.aot.hint.RuntimeHints)
as an alternative to the
regular AbstractApplicationContext.refresh()
.
Usage example:
GenericApplicationContext ctx = new GenericApplicationContext(); XmlBeanDefinitionReader xmlReader = new XmlBeanDefinitionReader(ctx); xmlReader.loadBeanDefinitions(new ClassPathResource("applicationContext.xml")); PropertiesBeanDefinitionReader propReader = new PropertiesBeanDefinitionReader(ctx); propReader.loadBeanDefinitions(new ClassPathResource("otherBeans.properties")); ctx.refresh(); MyBean myBean = (MyBean) ctx.getBean("myBean"); ...For the typical case of XML bean definitions, you may also use
ClassPathXmlApplicationContext
or FileSystemXmlApplicationContext
,
which are easier to set up - but less flexible, since you can just use standard
resource locations for XML bean definitions, rather than mixing arbitrary bean
definition formats. For a custom application context implementation supposed to
read a specific bean definition format in a refreshable manner, consider
deriving from the AbstractRefreshableApplicationContext
base class.- Since:
- 1.1.2
- Author:
- Juergen Hoeller, Chris Beams, Stephane Nicoll, Sam Brannen
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.springframework.core.io.DefaultResourceLoader
DefaultResourceLoader.ClassPathContextResource
-
Field Summary
Fields inherited from class org.springframework.context.support.AbstractApplicationContext
APPLICATION_EVENT_MULTICASTER_BEAN_NAME, LIFECYCLE_PROCESSOR_BEAN_NAME, logger, MESSAGE_SOURCE_BEAN_NAME
Fields inherited from interface org.springframework.beans.factory.BeanFactory
FACTORY_BEAN_PREFIX
Fields inherited from interface org.springframework.context.ConfigurableApplicationContext
APPLICATION_STARTUP_BEAN_NAME, BOOTSTRAP_EXECUTOR_BEAN_NAME, 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
Fields inherited from interface org.springframework.core.io.ResourceLoader
CLASSPATH_URL_PREFIX
Fields inherited from interface org.springframework.core.io.support.ResourcePatternResolver
CLASSPATH_ALL_URL_PREFIX
-
Constructor Summary
ConstructorDescriptionCreate a new GenericApplicationContext.Create a new GenericApplicationContext with the given parent.GenericApplicationContext
(DefaultListableBeanFactory beanFactory) Create a new GenericApplicationContext with the given DefaultListableBeanFactory.GenericApplicationContext
(DefaultListableBeanFactory beanFactory, ApplicationContext parent) Create a new GenericApplicationContext with the given DefaultListableBeanFactory. -
Method Summary
Modifier and TypeMethodDescriptionprotected void
Cancel this context's refresh attempt, resetting theactive
flag after an exception got thrown.protected final void
Not much to do: We hold a single internal BeanFactory that will never get released.Return this context's internal bean factory as AutowireCapableBeanFactory, if already available.getBeanDefinition
(String beanName) Return the BeanDefinition for the given bean name.Return the single internal BeanFactory held by this context (as ConfigurableListableBeanFactory).Return the ClassLoader to load class path resources with.Return the underlying bean factory of this context, available for registering bean definitions.getResource
(String location) This implementation delegates to this context'sResourceLoader
if set, falling back to the default superclass behavior otherwise.Resource[]
getResources
(String locationPattern) This implementation delegates to this context's ResourceLoader if it implements the ResourcePatternResolver interface, falling back to the default superclass behavior otherwise.boolean
Determine whether the given name is defined as an alias (as opposed to the name of an actually registered component).boolean
isBeanDefinitionOverridable
(String beanName) Determine whether the bean definition for the given name is overridable, i.e.boolean
isBeanNameInUse
(String beanName) Determine whether the given bean name is already in use within this registry, i.e.protected final void
Do nothing: We hold a single internal BeanFactory and rely on callers to register beans through our public methods (or the BeanFactory's).void
refreshForAotProcessing
(RuntimeHints runtimeHints) Load or refresh the persistent representation of the configuration up to a point where the underlying bean factory is ready to create bean instances.void
registerAlias
(String beanName, String alias) Given a name, register an alias for it.<T> void
registerBean
(@Nullable String beanName, Class<T> beanClass, @Nullable Supplier<T> supplier, BeanDefinitionCustomizer... customizers) Register a bean from the given bean class, using the given supplier for obtaining a new instance (typically declared as a lambda expression or method reference), optionally customizing its bean definition metadata (again typically declared as a lambda expression).<T> void
registerBean
(@Nullable String beanName, Class<T> beanClass, Object... constructorArgs) Register a bean from the given bean class, optionally providing explicit constructor arguments for consideration in the autowiring process.final <T> void
registerBean
(@Nullable String beanName, Class<T> beanClass, BeanDefinitionCustomizer... customizers) Register a bean from the given bean class, optionally customizing its bean definition metadata (typically declared as a lambda expression).<T> void
registerBean
(Class<T> beanClass, Object... constructorArgs) Register a bean from the given bean class, optionally providing explicit constructor arguments for consideration in the autowiring process.final <T> void
registerBean
(Class<T> beanClass, Supplier<T> supplier, BeanDefinitionCustomizer... customizers) Register a bean from the given bean class, using the given supplier for obtaining a new instance (typically declared as a lambda expression or method reference), optionally customizing its bean definition metadata (again typically declared as a lambda expression).final <T> void
registerBean
(Class<T> beanClass, BeanDefinitionCustomizer... customizers) Register a bean from the given bean class, optionally customizing its bean definition metadata (typically declared as a lambda expression).void
registerBeanDefinition
(String beanName, BeanDefinition beanDefinition) Register a new bean definition with this registry.void
removeAlias
(String alias) Remove the specified alias from this registry.void
removeBeanDefinition
(String beanName) Remove the BeanDefinition for the given name.void
setAllowBeanDefinitionOverriding
(boolean allowBeanDefinitionOverriding) Set whether it should be allowed to override bean definitions by registering a different definition with the same name, automatically replacing the former.void
setAllowCircularReferences
(boolean allowCircularReferences) Set whether to allow circular references between beans - and automatically try to resolve them.void
setApplicationStartup
(ApplicationStartup applicationStartup) Set theApplicationStartup
for this application context.void
setClassLoader
(@Nullable ClassLoader classLoader) Specify the ClassLoader to load class path resources with, ornull
for using the thread context class loader at the time of actual resource access.void
setParent
(@Nullable ApplicationContext parent) Set the parent of this application context, also setting the parent of the internal BeanFactory accordingly.void
setResourceLoader
(ResourceLoader resourceLoader) Set a ResourceLoader to use for this context.Methods inherited from class org.springframework.context.support.AbstractApplicationContext
addApplicationListener, addBeanFactoryPostProcessor, assertBeanFactoryActive, clearResourceCaches, close, containsBean, containsBeanDefinition, containsLocalBean, createEnvironment, destroyBeans, doClose, findAllAnnotationsOnBean, findAnnotationOnBean, findAnnotationOnBean, finishBeanFactoryInitialization, finishRefresh, getAliases, getApplicationListeners, getApplicationName, getApplicationStartup, getBean, getBean, getBean, getBean, getBean, getBeanDefinitionCount, getBeanDefinitionNames, getBeanFactoryPostProcessors, getBeanNamesForAnnotation, getBeanNamesForType, getBeanNamesForType, getBeanNamesForType, getBeanNamesForType, getBeanProvider, getBeanProvider, getBeanProvider, getBeanProvider, getBeansOfType, getBeansOfType, getBeansWithAnnotation, getDisplayName, getEnvironment, getId, getInternalParentBeanFactory, getInternalParentMessageSource, getMessage, getMessage, getMessage, getParent, getParentBeanFactory, getResourcePatternResolver, getStartupDate, getType, getType, initApplicationEventMulticaster, initLifecycleProcessor, initMessageSource, initPropertySources, invokeBeanFactoryPostProcessors, isActive, isClosed, isPrototype, isRunning, isSingleton, isTypeMatch, isTypeMatch, obtainFreshBeanFactory, onClose, onRefresh, postProcessBeanFactory, prepareBeanFactory, prepareRefresh, publishEvent, publishEvent, publishEvent, refresh, registerBeanPostProcessors, registerListeners, registerShutdownHook, removeApplicationListener, resetCommonCaches, setDisplayName, setEnvironment, setId, start, stop, toString
Methods inherited from class org.springframework.core.io.DefaultResourceLoader
addProtocolResolver, getProtocolResolvers, getResourceByPath, getResourceCache
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.springframework.core.AliasRegistry
getAliases
Methods inherited from interface org.springframework.beans.factory.support.BeanDefinitionRegistry
containsBeanDefinition, getBeanDefinitionCount, getBeanDefinitionNames
Methods inherited from interface org.springframework.context.ConfigurableApplicationContext
addProtocolResolver
-
Constructor Details
-
GenericApplicationContext
public GenericApplicationContext()Create a new GenericApplicationContext. -
GenericApplicationContext
Create a new GenericApplicationContext with the given DefaultListableBeanFactory.- Parameters:
beanFactory
- the DefaultListableBeanFactory instance to use for this context- See Also:
-
GenericApplicationContext
Create a new GenericApplicationContext with the given parent.- Parameters:
parent
- the parent application context- See Also:
-
GenericApplicationContext
Create a new GenericApplicationContext with the given DefaultListableBeanFactory.- Parameters:
beanFactory
- the DefaultListableBeanFactory instance to use for this contextparent
- the parent application context- See Also:
-
-
Method Details
-
setParent
Set the parent of this application context, also setting the parent of the internal BeanFactory accordingly.- Specified by:
setParent
in interfaceConfigurableApplicationContext
- Overrides:
setParent
in classAbstractApplicationContext
- Parameters:
parent
- the parent context- See Also:
-
setApplicationStartup
Description copied from interface:ConfigurableApplicationContext
Set theApplicationStartup
for this application context.This allows the application context to record metrics during startup.
- Specified by:
setApplicationStartup
in interfaceConfigurableApplicationContext
- Overrides:
setApplicationStartup
in classAbstractApplicationContext
- Parameters:
applicationStartup
- the new context event factory
-
setAllowBeanDefinitionOverriding
public void setAllowBeanDefinitionOverriding(boolean allowBeanDefinitionOverriding) Set whether it should be allowed to override bean definitions by registering a different definition with the same name, automatically replacing the former. If not, an exception will be thrown. Default is "true".- Since:
- 3.0
- See Also:
-
setAllowCircularReferences
public void setAllowCircularReferences(boolean allowCircularReferences) Set whether to allow circular references between beans - and automatically try to resolve them.Default is "true". Turn this off to throw an exception when encountering a circular reference, disallowing them completely.
- Since:
- 3.0
- See Also:
-
setResourceLoader
Set a ResourceLoader to use for this context. If set, the context will delegate allgetResource
calls to the given ResourceLoader. If not set, default resource loading will apply.The main reason to specify a custom ResourceLoader is to resolve resource paths (without URL prefix) in a specific fashion. The default behavior is to resolve such paths as class path locations. To resolve resource paths as file system locations, specify a FileSystemResourceLoader here.
You can also pass in a full ResourcePatternResolver, which will be autodetected by the context and used for
getResources
calls as well. Else, default resource pattern matching will apply. -
getResource
This implementation delegates to this context'sResourceLoader
if set, falling back to the default superclass behavior otherwise.As of Spring Framework 5.3.22, this method also honors registered protocol resolvers when a custom
ResourceLoader
has been set.- Specified by:
getResource
in interfaceResourceLoader
- Overrides:
getResource
in classDefaultResourceLoader
- Parameters:
location
- the resource location- Returns:
- a corresponding
Resource
handle (nevernull
) - See Also:
-
getResources
This implementation delegates to this context's ResourceLoader if it implements the ResourcePatternResolver interface, falling back to the default superclass behavior otherwise.- Specified by:
getResources
in interfaceResourcePatternResolver
- Overrides:
getResources
in classAbstractApplicationContext
- Parameters:
locationPattern
- the location pattern to resolve- Returns:
- the corresponding
Resource
objects - Throws:
IOException
- in case of I/O errors- See Also:
-
setClassLoader
Description copied from class:DefaultResourceLoader
Specify the ClassLoader to load class path resources with, ornull
for using the thread context class loader at the time of actual resource access.The default is that ClassLoader access will happen using the thread context class loader at the time of actual resource access (since 5.3).
- Specified by:
setClassLoader
in interfaceConfigurableApplicationContext
- Overrides:
setClassLoader
in classDefaultResourceLoader
- See Also:
-
getClassLoader
Description copied from class:DefaultResourceLoader
Return the ClassLoader to load class path resources with.Will get passed to ClassPathResource's constructor for all ClassPathResource objects created by this resource loader.
- Specified by:
getClassLoader
in interfaceResourceLoader
- Overrides:
getClassLoader
in classDefaultResourceLoader
- Returns:
- the
ClassLoader
(onlynull
if even the systemClassLoader
isn't accessible) - See Also:
-
refreshBeanFactory
Do nothing: We hold a single internal BeanFactory and rely on callers to register beans through our public methods (or the BeanFactory's).- Specified by:
refreshBeanFactory
in classAbstractApplicationContext
- Throws:
IllegalStateException
- if already initialized and multiple refresh attempts are not supported- See Also:
-
cancelRefresh
Description copied from class:AbstractApplicationContext
Cancel this context's refresh attempt, resetting theactive
flag after an exception got thrown.- Overrides:
cancelRefresh
in classAbstractApplicationContext
- Parameters:
ex
- the exception that led to the cancellation
-
closeBeanFactory
protected final void closeBeanFactory()Not much to do: We hold a single internal BeanFactory that will never get released.- Specified by:
closeBeanFactory
in classAbstractApplicationContext
-
getBeanFactory
Return the single internal BeanFactory held by this context (as ConfigurableListableBeanFactory).- Specified by:
getBeanFactory
in interfaceConfigurableApplicationContext
- Specified by:
getBeanFactory
in classAbstractApplicationContext
- Returns:
- this application context's internal bean factory (never
null
) - See Also:
-
getDefaultListableBeanFactory
Return the underlying bean factory of this context, available for registering bean definitions.NOTE: You need to call
AbstractApplicationContext.refresh()
to initialize the bean factory and its contained beans with application context semantics (autodetecting BeanFactoryPostProcessors, etc).- Returns:
- the internal bean factory (as DefaultListableBeanFactory)
-
getAutowireCapableBeanFactory
Description copied from class:AbstractApplicationContext
Return this context's internal bean factory as AutowireCapableBeanFactory, if already available.- Specified by:
getAutowireCapableBeanFactory
in interfaceApplicationContext
- Overrides:
getAutowireCapableBeanFactory
in classAbstractApplicationContext
- Returns:
- the AutowireCapableBeanFactory for this context
- Throws:
IllegalStateException
- if the context does not support theAutowireCapableBeanFactory
interface, or does not hold an autowire-capable bean factory yet (for example, ifrefresh()
has never been called), or if the context has been closed already- See Also:
-
registerBeanDefinition
public void registerBeanDefinition(String beanName, BeanDefinition beanDefinition) throws BeanDefinitionStoreException Description copied from interface:BeanDefinitionRegistry
Register a new bean definition with this registry. Must support RootBeanDefinition and ChildBeanDefinition.- Specified by:
registerBeanDefinition
in interfaceBeanDefinitionRegistry
- Parameters:
beanName
- the name of the bean instance to registerbeanDefinition
- definition of the bean instance to register- Throws:
BeanDefinitionStoreException
- if the BeanDefinition is invalidBeanDefinitionOverrideException
- if there is already a BeanDefinition for the specified bean name and we are not allowed to override it- See Also:
-
removeBeanDefinition
Description copied from interface:BeanDefinitionRegistry
Remove the BeanDefinition for the given name.- Specified by:
removeBeanDefinition
in interfaceBeanDefinitionRegistry
- Parameters:
beanName
- the name of the bean instance to register- Throws:
NoSuchBeanDefinitionException
- if there is no such bean definition
-
getBeanDefinition
Description copied from interface:BeanDefinitionRegistry
Return the BeanDefinition for the given bean name.- Specified by:
getBeanDefinition
in interfaceBeanDefinitionRegistry
- Parameters:
beanName
- name of the bean to find a definition for- Returns:
- the BeanDefinition for the given name (never
null
) - Throws:
NoSuchBeanDefinitionException
- if there is no such bean definition
-
isBeanDefinitionOverridable
Description copied from interface:BeanDefinitionRegistry
Determine whether the bean definition for the given name is overridable, i.e. whetherBeanDefinitionRegistry.registerBeanDefinition(java.lang.String, org.springframework.beans.factory.config.BeanDefinition)
would successfully return against an existing definition of the same name.The default implementation returns
true
.- Specified by:
isBeanDefinitionOverridable
in interfaceBeanDefinitionRegistry
- Parameters:
beanName
- the name to check- Returns:
- whether the definition for the given bean name is overridable
-
isBeanNameInUse
Description copied from interface:BeanDefinitionRegistry
Determine whether the given bean name is already in use within this registry, i.e. whether there is a local bean or alias registered under this name.- Specified by:
isBeanNameInUse
in interfaceBeanDefinitionRegistry
- Parameters:
beanName
- the name to check- Returns:
- whether the given bean name is already in use
-
registerAlias
Description copied from interface:AliasRegistry
Given a name, register an alias for it.- Specified by:
registerAlias
in interfaceAliasRegistry
- Parameters:
beanName
- the canonical namealias
- the alias to be registered
-
removeAlias
Description copied from interface:AliasRegistry
Remove the specified alias from this registry.- Specified by:
removeAlias
in interfaceAliasRegistry
- Parameters:
alias
- the alias to remove
-
isAlias
Description copied from interface:AliasRegistry
Determine whether the given name is defined as an alias (as opposed to the name of an actually registered component).- Specified by:
isAlias
in interfaceAliasRegistry
- Parameters:
beanName
- the name to check- Returns:
- whether the given name is an alias
-
refreshForAotProcessing
Load or refresh the persistent representation of the configuration up to a point where the underlying bean factory is ready to create bean instances.This variant of
AbstractApplicationContext.refresh()
is used by Ahead of Time (AOT) processing that optimizes the application context, typically at build time.In this mode, only
BeanDefinitionRegistryPostProcessor
andMergedBeanDefinitionPostProcessor
are invoked.- Parameters:
runtimeHints
- the runtime hints- Throws:
BeansException
- if the bean factory could not be initializedIllegalStateException
- if already initialized and multiple refresh attempts are not supported- Since:
- 6.0
-
registerBean
Register a bean from the given bean class, optionally providing explicit constructor arguments for consideration in the autowiring process.- Parameters:
beanClass
- the class of the beanconstructorArgs
- custom argument values to be fed into Spring's constructor resolution algorithm, resolving either all arguments or just specific ones, with the rest to be resolved through regular autowiring (may benull
or empty)- Since:
- 5.2 (since 5.0 on the AnnotationConfigApplicationContext subclass)
-
registerBean
public <T> void registerBean(@Nullable String beanName, Class<T> beanClass, Object... constructorArgs) Register a bean from the given bean class, optionally providing explicit constructor arguments for consideration in the autowiring process.- Parameters:
beanName
- the name of the bean (may benull
)beanClass
- the class of the beanconstructorArgs
- custom argument values to be fed into Spring's constructor resolution algorithm, resolving either all arguments or just specific ones, with the rest to be resolved through regular autowiring (may benull
or empty)- Since:
- 5.2 (since 5.0 on the AnnotationConfigApplicationContext subclass)
-
registerBean
Register a bean from the given bean class, optionally customizing its bean definition metadata (typically declared as a lambda expression).- Parameters:
beanClass
- the class of the bean (resolving a public constructor to be autowired, possibly simply the default constructor)customizers
- one or more callbacks for customizing the factory'sBeanDefinition
, for example, setting a lazy-init or primary flag- Since:
- 5.0
- See Also:
-
registerBean
public final <T> void registerBean(@Nullable String beanName, Class<T> beanClass, BeanDefinitionCustomizer... customizers) Register a bean from the given bean class, optionally customizing its bean definition metadata (typically declared as a lambda expression).- Parameters:
beanName
- the name of the bean (may benull
)beanClass
- the class of the bean (resolving a public constructor to be autowired, possibly simply the default constructor)customizers
- one or more callbacks for customizing the factory'sBeanDefinition
, for example, setting a lazy-init or primary flag- Since:
- 5.0
- See Also:
-
registerBean
public final <T> void registerBean(Class<T> beanClass, Supplier<T> supplier, BeanDefinitionCustomizer... customizers) Register a bean from the given bean class, using the given supplier for obtaining a new instance (typically declared as a lambda expression or method reference), optionally customizing its bean definition metadata (again typically declared as a lambda expression).- Parameters:
beanClass
- the class of the beansupplier
- a callback for creating an instance of the beancustomizers
- one or more callbacks for customizing the factory'sBeanDefinition
, for example, setting a lazy-init or primary flag- Since:
- 5.0
- See Also:
-
registerBean
public <T> void registerBean(@Nullable String beanName, Class<T> beanClass, @Nullable Supplier<T> supplier, BeanDefinitionCustomizer... customizers) Register a bean from the given bean class, using the given supplier for obtaining a new instance (typically declared as a lambda expression or method reference), optionally customizing its bean definition metadata (again typically declared as a lambda expression).This method can be overridden to adapt the registration mechanism for all
registerBean
methods (since they all delegate to this one).- Parameters:
beanName
- the name of the bean (may benull
)beanClass
- the class of the beansupplier
- a callback for creating an instance of the bean (in case ofnull
, resolving a public constructor to be autowired instead)customizers
- one or more callbacks for customizing the factory'sBeanDefinition
, for example, setting a lazy-init or primary flag- Since:
- 5.0
-