public class AnnotationConfigWebApplicationContext extends AbstractRefreshableWebApplicationContext implements AnnotationConfigRegistry
WebApplicationContext
implementation which accepts annotated classes as input - in particular
@Configuration-annotated
classes, but also plain @Component
classes and JSR-330 compliant classes using javax.inject annotations. Allows
for registering classes one by one (specifying class names as config location) as well
as for classpath scanning (specifying base packages as config location).
This is essentially the equivalent of
AnnotationConfigApplicationContext for a web environment.
To make use of this application context, the "contextClass" context-param for ContextLoader and/or "contextClass" init-param for FrameworkServlet must be set to the fully-qualified name of this class.
As of Spring 3.1, this class may also be directly instantiated and injected into
Spring's DispatcherServlet or ContextLoaderListener when using the
new WebApplicationInitializer
code-based alternative to web.xml. See its Javadoc for details and usage examples.
Unlike XmlWebApplicationContext, no default configuration class locations
are assumed. Rather, it is a requirement to set the
"contextConfigLocation"
context-param for ContextLoader and/or "contextConfigLocation" init-param for
FrameworkServlet. The param-value may contain both fully-qualified
class names and base packages to scan for components. See loadBeanDefinitions(org.springframework.beans.factory.support.DefaultListableBeanFactory)
for exact details on how these locations are processed.
As an alternative to setting the "contextConfigLocation" parameter, users may
implement an ApplicationContextInitializer and set the
"contextInitializerClasses"
context-param / init-param. In such cases, users should favor the AbstractApplicationContext.refresh()
and scan(String...) methods over the AbstractRefreshableConfigApplicationContext.setConfigLocation(String)
method, which is primarily for use by ContextLoader.
Note: In case of multiple @Configuration classes, later @Bean
definitions will override ones defined in earlier loaded files. This can be leveraged
to deliberately override certain bean definitions via an extra Configuration class.
AnnotationConfigApplicationContextDefaultResourceLoader.ClassPathContextResourceAPPLICATION_EVENT_MULTICASTER_BEAN_NAME, LIFECYCLE_PROCESSOR_BEAN_NAME, logger, MESSAGE_SOURCE_BEAN_NAMEAPPLICATION_CONTEXT_ID_PREFIX, SERVLET_CONFIG_BEAN_NAMECONTEXT_ATTRIBUTES_BEAN_NAME, CONTEXT_PARAMETERS_BEAN_NAME, ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, SCOPE_APPLICATION, SCOPE_REQUEST, SCOPE_SESSION, SERVLET_CONTEXT_BEAN_NAMECONFIG_LOCATION_DELIMITERS, CONVERSION_SERVICE_BEAN_NAME, ENVIRONMENT_BEAN_NAME, LOAD_TIME_WEAVER_BEAN_NAME, SYSTEM_ENVIRONMENT_BEAN_NAME, SYSTEM_PROPERTIES_BEAN_NAMEFACTORY_BEAN_PREFIXCLASSPATH_ALL_URL_PREFIXCLASSPATH_URL_PREFIX| Constructor and Description |
|---|
AnnotationConfigWebApplicationContext() |
createEnvironment, getApplicationName, getConfigLocations, getNamespace, getResourceByPath, getResourcePatternResolver, getServletConfig, getServletContext, getTheme, initPropertySources, onRefresh, postProcessBeanFactory, setNamespace, setServletConfig, setServletContextafterPropertiesSet, getDefaultConfigLocations, resolvePath, setBeanName, setConfigLocation, setConfigLocations, setIdassertBeanFactoryActive, cancelRefresh, closeBeanFactory, createBeanFactory, customizeBeanFactory, getBeanFactory, hasBeanFactory, refreshBeanFactory, setAllowBeanDefinitionOverriding, setAllowCircularReferencesaddApplicationListener, addBeanFactoryPostProcessor, close, containsBean, containsBeanDefinition, containsLocalBean, destroy, destroyBeans, doClose, findAnnotationOnBean, finishBeanFactoryInitialization, finishRefresh, getAliases, getApplicationListeners, getAutowireCapableBeanFactory, getBean, getBean, getBean, getBean, getBean, getBeanDefinitionCount, getBeanDefinitionNames, getBeanFactoryPostProcessors, getBeanNamesForAnnotation, getBeanNamesForType, getBeanNamesForType, getBeanNamesForType, getBeanProvider, getBeanProvider, getBeansOfType, getBeansOfType, getBeansWithAnnotation, getDisplayName, getEnvironment, getId, getInternalParentBeanFactory, getInternalParentMessageSource, getMessage, getMessage, getMessage, getParent, getParentBeanFactory, getResources, getStartupDate, getType, initApplicationEventMulticaster, initLifecycleProcessor, initMessageSource, invokeBeanFactoryPostProcessors, isActive, isPrototype, isRunning, isSingleton, isTypeMatch, isTypeMatch, obtainFreshBeanFactory, onClose, prepareBeanFactory, prepareRefresh, publishEvent, publishEvent, publishEvent, refresh, registerBeanPostProcessors, registerListeners, registerShutdownHook, resetCommonCaches, setDisplayName, setEnvironment, setParent, start, stop, toStringaddProtocolResolver, clearResourceCaches, getClassLoader, getProtocolResolvers, getResource, getResourceCache, setClassLoaderclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitsetConfigLocation, setConfigLocationsaddApplicationListener, addBeanFactoryPostProcessor, addProtocolResolver, close, getBeanFactory, getEnvironment, isActive, refresh, registerShutdownHook, setEnvironment, setId, setParentgetAutowireCapableBeanFactory, getDisplayName, getId, getParent, getStartupDatecontainsBeanDefinition, findAnnotationOnBean, getBeanDefinitionCount, getBeanDefinitionNames, getBeanNamesForAnnotation, getBeanNamesForType, getBeanNamesForType, getBeanNamesForType, getBeansOfType, getBeansOfType, getBeansWithAnnotationcontainsLocalBean, getParentBeanFactorycontainsBean, getAliases, getBean, getBean, getBean, getBean, getBean, getBeanProvider, getBeanProvider, getType, isPrototype, isSingleton, isTypeMatch, isTypeMatchgetMessage, getMessage, getMessagepublishEvent, publishEventgetResourcesgetClassLoader, getResourcepublic AnnotationConfigWebApplicationContext()
public void setBeanNameGenerator(@Nullable BeanNameGenerator beanNameGenerator)
BeanNameGenerator for use with AnnotatedBeanDefinitionReader
and/or ClassPathBeanDefinitionScanner.
Default is AnnotationBeanNameGenerator.
@Nullable protected BeanNameGenerator getBeanNameGenerator()
BeanNameGenerator for use with AnnotatedBeanDefinitionReader
and/or ClassPathBeanDefinitionScanner, if any.public void setScopeMetadataResolver(@Nullable ScopeMetadataResolver scopeMetadataResolver)
ScopeMetadataResolver for use with AnnotatedBeanDefinitionReader
and/or ClassPathBeanDefinitionScanner.
Default is an AnnotationScopeMetadataResolver.
@Nullable protected ScopeMetadataResolver getScopeMetadataResolver()
ScopeMetadataResolver for use with AnnotatedBeanDefinitionReader
and/or ClassPathBeanDefinitionScanner, if any.public void register(java.lang.Class<?>... annotatedClasses)
Note that AbstractApplicationContext.refresh() must be called in order for the context
to fully process the new classes.
register in interface AnnotationConfigRegistryannotatedClasses - one or more annotated classes,
e.g. @Configuration classesscan(String...),
loadBeanDefinitions(DefaultListableBeanFactory),
AbstractRefreshableConfigApplicationContext.setConfigLocation(String),
AbstractApplicationContext.refresh()public void scan(java.lang.String... basePackages)
Note that AbstractApplicationContext.refresh() must be called in order for the context
to fully process the new classes.
scan in interface AnnotationConfigRegistrybasePackages - the packages to check for annotated classesloadBeanDefinitions(DefaultListableBeanFactory),
register(Class...),
AbstractRefreshableConfigApplicationContext.setConfigLocation(String),
AbstractApplicationContext.refresh()protected void loadBeanDefinitions(DefaultListableBeanFactory beanFactory)
BeanDefinition for
any classes specified by register(Class...) and scan any packages
specified by scan(String...).
For any values specified by AbstractRefreshableConfigApplicationContext.setConfigLocation(String) or
AbstractRefreshableConfigApplicationContext.setConfigLocations(String[]), attempt first to load each location as a
class, registering a BeanDefinition if class loading is successful,
and if class loading fails (i.e. a ClassNotFoundException is raised),
assume the value is a package and attempt to scan it for annotated classes.
Enables the default set of annotation configuration post processors, such that
@Autowired, @Required, and associated annotations can be used.
Configuration class bean definitions are registered with generated bean
definition names unless the value attribute is provided to the stereotype
annotation.
loadBeanDefinitions in class AbstractRefreshableApplicationContextbeanFactory - the bean factory to load bean definitions intoregister(Class...),
scan(String...),
AbstractRefreshableConfigApplicationContext.setConfigLocation(String),
AbstractRefreshableConfigApplicationContext.setConfigLocations(String[]),
AnnotatedBeanDefinitionReader,
ClassPathBeanDefinitionScannerprotected AnnotatedBeanDefinitionReader getAnnotatedBeanDefinitionReader(DefaultListableBeanFactory beanFactory)
AnnotatedBeanDefinitionReader for the given bean factory.
This should be pre-configured with the Environment (if desired)
but not with a BeanNameGenerator or ScopeMetadataResolver yet.
beanFactory - the bean factory to load bean definitions intoAbstractApplicationContext.getEnvironment(),
getBeanNameGenerator(),
getScopeMetadataResolver()protected ClassPathBeanDefinitionScanner getClassPathBeanDefinitionScanner(DefaultListableBeanFactory beanFactory)
ClassPathBeanDefinitionScanner for the given bean factory.
This should be pre-configured with the Environment (if desired)
but not with a BeanNameGenerator or ScopeMetadataResolver yet.
beanFactory - the bean factory to load bean definitions intoAbstractApplicationContext.getEnvironment(),
getBeanNameGenerator(),
getScopeMetadataResolver()