Spring Framework 6.1.4 · org.springframework.web.context.support.AnnotationConfigWebApplicationContext

WebApplicationContext implementation which accepts component classes as input — in particular @Configuration classes, but also plain @Component classes as well as JSR-330 compliant classes using jakarta.inject annotations.

Allows for registering classes one by one (specifying class names as config locations) as well as via classpath scanning (specifying base packages as config locations).

This is essentially the equivalent of AnnotationConfigApplicationContext for a web environment. However, in contrast to AnnotationConfigApplicationContext, this class does not extend GenericApplicationContext and therefore does not provide some of the convenient registerBean(...) methods available in a GenericApplicationContext. If you wish to register annotated component classes with a GenericApplicationContext in a web environment, you may use a GenericWebApplicationContext with an AnnotatedBeanDefinitionReader. See the Javadoc for GenericWebApplicationContext for details and an example.

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.

This class may also be directly instantiated and injected into Spring's DispatcherServlet or ContextLoaderListener when using the 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 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 refresh() and scan(String...) methods over the 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.

Modifier and Type	Field and Description
private final Set<String>	basePackages
private BeanNameGenerator	beanNameGenerator
private final Set<Class<?>>	componentClasses
private ScopeMetadataResolver	scopeMetadataResolver

Access	Constructor and Description
public	AnnotationConfigWebApplicationContext()

Modifier and Type	Method and Description
protected AnnotatedBeanDefinitionReader	getAnnotatedBeanDefinitionReader(DefaultListableBeanFactory the bean factory to load bean definitions into beanFactory) Build an `AnnotatedBeanDefinitionReader` for the given bean factory.
protected BeanNameGenerator	getBeanNameGenerator() Return the custom `BeanNameGenerator` for use with `AnnotatedBeanDefinitionReader` and/or `ClassPathBeanDefinitionScanner`, if any.
protected ClassPathBeanDefinitionScanner	getClassPathBeanDefinitionScanner(DefaultListableBeanFactory the bean factory to load bean definitions into beanFactory) Build a `ClassPathBeanDefinitionScanner` for the given bean factory.
protected ScopeMetadataResolver	getScopeMetadataResolver() Return the custom `ScopeMetadataResolver` for use with `AnnotatedBeanDefinitionReader` and/or `ClassPathBeanDefinitionScanner`, if any.
protected void	loadBeanDefinitions(DefaultListableBeanFactory the bean factory to load bean definitions into beanFactory) Implements abstract org.springframework.context.support.AbstractRefreshableApplicationContext.loadBeanDefinitions. Register a `org.springframework.beans.factory.config.BeanDefinition` for any classes specified by `register(Class...)` and scan any packages specified by `scan(String...)`.
public void	register(Class<?>... one or more component classes, e.g. `@Configuration` classes componentClasses) Implements org.springframework.context.annotation.AnnotationConfigRegistry.register. Register one or more component classes to be processed.
public void	scan(String... the packages to check for component classes basePackages) Implements org.springframework.context.annotation.AnnotationConfigRegistry.scan. Perform a scan within the specified base packages.
public void	setBeanNameGenerator(BeanNameGenerator beanNameGenerator) Set a custom `BeanNameGenerator` for use with `AnnotatedBeanDefinitionReader` and/or `ClassPathBeanDefinitionScanner`.
public void	setScopeMetadataResolver(ScopeMetadataResolver scopeMetadataResolver) Set a custom `ScopeMetadataResolver` for use with `AnnotatedBeanDefinitionReader` and/or `ClassPathBeanDefinitionScanner`.

basePackages	back to summary
private final Set<String> basePackages

beanNameGenerator	back to summary
private BeanNameGenerator beanNameGenerator Annotations @Nullable

componentClasses	back to summary
private final Set<Class<?>> componentClasses

AnnotationConfigWebApplicationContext	back to summary
public AnnotationConfigWebApplicationContext()

Method Detail

getAnnotatedBeanDefinitionReader back to summary

getAnnotatedBeanDefinitionReader	back to summary
protected AnnotatedBeanDefinitionReader getAnnotatedBeanDefinitionReader(DefaultListableBeanFactory beanFactory) Build an `AnnotatedBeanDefinitionReader` for the given bean factory. This should be pre-configured with the `Environment` (if desired) but not with a `BeanNameGenerator` or `ScopeMetadataResolver` yet. Parameters beanFactory:DefaultListableBeanFactory the bean factory to load bean definitions into Since 4.1.9 See Also `getEnvironment()`, `getBeanNameGenerator()`, `getScopeMetadataResolver()`

protected AnnotatedBeanDefinitionReader getAnnotatedBeanDefinitionReader(DefaultListableBeanFactory beanFactory)

Build an AnnotatedBeanDefinitionReader for the given bean factory.

This should be pre-configured with the Environment (if desired) but not with a BeanNameGenerator or ScopeMetadataResolver yet.

Parameters

beanFactory:DefaultListableBeanFactory: the bean factory to load bean definitions into

Since

4.1.9

getBeanNameGenerator back to summary

getBeanNameGenerator	back to summary
protected BeanNameGenerator getBeanNameGenerator() Return the custom `BeanNameGenerator` for use with `AnnotatedBeanDefinitionReader` and/or `ClassPathBeanDefinitionScanner`, if any. Annotations @Nullable

protected BeanNameGenerator getBeanNameGenerator()

Return the custom BeanNameGenerator for use with AnnotatedBeanDefinitionReader and/or ClassPathBeanDefinitionScanner, if any.

Annotations

@Nullable

getClassPathBeanDefinitionScanner back to summary

getClassPathBeanDefinitionScanner	back to summary
protected ClassPathBeanDefinitionScanner getClassPathBeanDefinitionScanner(DefaultListableBeanFactory beanFactory) Build a `ClassPathBeanDefinitionScanner` for the given bean factory. This should be pre-configured with the `Environment` (if desired) but not with a `BeanNameGenerator` or `ScopeMetadataResolver` yet. Parameters beanFactory:DefaultListableBeanFactory the bean factory to load bean definitions into Since 4.1.9 See Also `getEnvironment()`, `getBeanNameGenerator()`, `getScopeMetadataResolver()`

protected ClassPathBeanDefinitionScanner getClassPathBeanDefinitionScanner(DefaultListableBeanFactory beanFactory)

Build a ClassPathBeanDefinitionScanner for the given bean factory.

This should be pre-configured with the Environment (if desired) but not with a BeanNameGenerator or ScopeMetadataResolver yet.

Parameters

beanFactory:DefaultListableBeanFactory: the bean factory to load bean definitions into

Since

4.1.9

getScopeMetadataResolver back to summary

protected ScopeMetadataResolver getScopeMetadataResolver()

Return the custom ScopeMetadataResolver for use with AnnotatedBeanDefinitionReader and/or ClassPathBeanDefinitionScanner, if any.

Annotations

@Nullable

loadBeanDefinitions back to summary

loadBeanDefinitions	back to summary
protected void loadBeanDefinitions(DefaultListableBeanFactory beanFactory) Implements abstract org.springframework.context.support.AbstractRefreshableApplicationContext.loadBeanDefinitions. Register a `org.springframework.beans.factory.config.BeanDefinition` for any classes specified by `register(Class...)` and scan any packages specified by `scan(String...)`. For any values specified by `setConfigLocation(String)` or `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 component classes. Enables the default set of annotation configuration post processors, such that `@Autowired` 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. Parameters beanFactory:DefaultListableBeanFactory the bean factory to load bean definitions into Annotations @Override See Also `register(Class...)`, `scan(String...)`, `setConfigLocation(String)`, `setConfigLocations(String[])`, `AnnotatedBeanDefinitionReader`, `ClassPathBeanDefinitionScanner`

protected void loadBeanDefinitions(DefaultListableBeanFactory beanFactory)

Implements abstract org.springframework.context.support.AbstractRefreshableApplicationContext.loadBeanDefinitions.

Register a org.springframework.beans.factory.config.BeanDefinition for any classes specified by register(Class...) and scan any packages specified by scan(String...).

For any values specified by setConfigLocation(String) or 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 component classes.

Enables the default set of annotation configuration post processors, such that @Autowired 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.

Parameters

beanFactory:DefaultListableBeanFactory: the bean factory to load bean definitions into

Annotations

@Override

register	back to summary
public void register(Class<?>... componentClasses) Implements org.springframework.context.annotation.AnnotationConfigRegistry.register. Register one or more component classes to be processed. Note that `refresh()` must be called in order for the context to fully process the new classes. Parameters componentClasses:Class<?>[] one or more component classes, e.g. `@Configuration` classes Annotations @Override See Also `scan(String...)`, `loadBeanDefinitions(DefaultListableBeanFactory)`, `setConfigLocation(String)`, `refresh()`

public void register(Class<?>... componentClasses)

Implements org.springframework.context.annotation.AnnotationConfigRegistry.register.

Note that refresh() must be called in order for the context to fully process the new classes.

Parameters

componentClasses:Class<?>[]: one or more component classes, e.g. @Configuration classes

Annotations

@Override

scan back to summary

scan	back to summary
public void scan(String... basePackages) Implements org.springframework.context.annotation.AnnotationConfigRegistry.scan. Perform a scan within the specified base packages. Note that `refresh()` must be called in order for the context to fully process the new classes. Parameters basePackages:String[] the packages to check for component classes Annotations @Override See Also `loadBeanDefinitions(DefaultListableBeanFactory)`, `register(Class...)`, `setConfigLocation(String)`, `refresh()`

public void scan(String... basePackages)

Implements org.springframework.context.annotation.AnnotationConfigRegistry.scan.

Perform a scan within the specified base packages.

Note that refresh() must be called in order for the context to fully process the new classes.

Parameters

basePackages:String[]: the packages to check for component classes

Annotations

@Override

setBeanNameGenerator back to summary

setBeanNameGenerator	back to summary
public void setBeanNameGenerator(BeanNameGenerator beanNameGenerator) Set a custom `BeanNameGenerator` for use with `AnnotatedBeanDefinitionReader` and/or `ClassPathBeanDefinitionScanner`. Default is `org.springframework.context.annotation.AnnotationBeanNameGenerator`. See Also `AnnotatedBeanDefinitionReader#setBeanNameGenerator`, `ClassPathBeanDefinitionScanner#setBeanNameGenerator`

public void setBeanNameGenerator(BeanNameGenerator beanNameGenerator)

Set a custom BeanNameGenerator for use with AnnotatedBeanDefinitionReader and/or ClassPathBeanDefinitionScanner.

Default is org.springframework.context.annotation.AnnotationBeanNameGenerator.

See Also: AnnotatedBeanDefinitionReader#setBeanNameGenerator, ClassPathBeanDefinitionScanner#setBeanNameGenerator

setScopeMetadataResolver back to summary

public void setScopeMetadataResolver(ScopeMetadataResolver scopeMetadataResolver)

Set a custom ScopeMetadataResolver for use with AnnotatedBeanDefinitionReader and/or ClassPathBeanDefinitionScanner.

Default is an org.springframework.context.annotation.AnnotationScopeMetadataResolver.

See Also: AnnotatedBeanDefinitionReader#setScopeMetadataResolver, ClassPathBeanDefinitionScanner#setScopeMetadataResolver

public Class AnnotationConfigWebApplicationContext

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail