Spring Framework 6.1.4 · org.springframework.context.annotation.ClassPathBeanDefinitionScanner

Modifier and Type	Field and Description
private String[]	autowireCandidatePatterns
private BeanDefinitionDefaults	beanDefinitionDefaults
private BeanNameGenerator	beanNameGenerator
private boolean	includeAnnotationConfig
private final BeanDefinitionRegistry	registry
private ScopeMetadataResolver	scopeMetadataResolver

Constructor Summary

Access	Constructor and Description
public	ClassPathBeanDefinitionScanner(BeanDefinitionRegistry the `BeanFactory` to load bean definitions into, in the form of a `BeanDefinitionRegistry` registry) Create a new `ClassPathBeanDefinitionScanner` for the given bean factory.
public	ClassPathBeanDefinitionScanner(BeanDefinitionRegistry the `BeanFactory` to load bean definitions into, in the form of a `BeanDefinitionRegistry` registry, boolean whether to include the default filters for the `@Component`, `@Repository`, `@Service`, and `@Controller` stereotype annotations useDefaultFilters) Create a new `ClassPathBeanDefinitionScanner` for the given bean factory.
public	ClassPathBeanDefinitionScanner(BeanDefinitionRegistry the `BeanFactory` to load bean definitions into, in the form of a `BeanDefinitionRegistry` registry, boolean whether to include the default filters for the `@Component`, `@Repository`, `@Service`, and `@Controller` stereotype annotations useDefaultFilters, Environment the Spring `Environment` to use when evaluating bean definition profile metadata environment) Create a new `ClassPathBeanDefinitionScanner` for the given bean factory and using the given `Environment` when evaluating bean definition profile metadata.
public	ClassPathBeanDefinitionScanner(BeanDefinitionRegistry the `BeanFactory` to load bean definitions into, in the form of a `BeanDefinitionRegistry` registry, boolean whether to include the default filters for the `@Component`, `@Repository`, `@Service`, and `@Controller` stereotype annotations useDefaultFilters, Environment the Spring `Environment` to use when evaluating bean definition profile metadata environment, ResourceLoader the `ResourceLoader` to use resourceLoader) Create a new `ClassPathBeanDefinitionScanner` for the given bean factory and using the given `Environment` when evaluating bean definition profile metadata.

Method Summary

Modifier and Type	Method and Description
protected boolean	Returns: `true` if the bean can be registered as-is; `false` if it should be skipped because there is an existing, compatible bean definition for the specified name checkCandidate(String the suggested name for the bean beanName, BeanDefinition the corresponding bean definition beanDefinition) Check the given candidate's bean name, determining whether the corresponding bean definition needs to be registered or conflicts with an existing definition.
protected Set<BeanDefinitionHolder>	Returns: set of beans registered if any for tooling registration purposes (never `null`) doScan(String... the packages to check for annotated classes basePackages) Perform a scan within the specified base packages, returning the registered bean definitions.
public BeanDefinitionDefaults	getBeanDefinitionDefaults() Return the defaults to use for detected beans (never `null`).
private static Environment	getOrCreateEnvironment(BeanDefinitionRegistry registry) Get the Environment from the given registry if possible, otherwise return a new StandardEnvironment.
public final BeanDefinitionRegistry	getRegistry() Overrides org.springframework.context.annotation.ClassPathScanningCandidateComponentProvider.getRegistry. Return the BeanDefinitionRegistry that this scanner operates on.
protected boolean	Returns: whether the definitions are considered as compatible, with the new definition to be skipped in favor of the existing definition isCompatible(BeanDefinition the new bean definition, originated from scanning newDef, BeanDefinition the existing bean definition, potentially an explicitly defined one or a previously generated one from scanning existingDef) Determine whether the given new bean definition is compatible with the given existing bean definition.
protected void	postProcessBeanDefinition(AbstractBeanDefinition the scanned bean definition beanDefinition, String the generated bean name for the given bean beanName) Apply further settings to the given bean definition, beyond the contents retrieved from scanning the component class.
protected void	registerBeanDefinition(BeanDefinitionHolder the bean definition plus bean name for the bean definitionHolder, BeanDefinitionRegistry the BeanDefinitionRegistry to register the bean with registry) Register the specified bean with the given registry.
public int	Returns: number of beans registered scan(String... the packages to check for annotated classes basePackages) Perform a scan within the specified base packages.
public void	setAutowireCandidatePatterns(String... the patterns to match against autowireCandidatePatterns) Set the name-matching patterns for determining autowire candidates.
public void	setBeanDefinitionDefaults(BeanDefinitionDefaults beanDefinitionDefaults) Set the defaults to use for detected beans.
public void	setBeanNameGenerator(BeanNameGenerator beanNameGenerator) Set the BeanNameGenerator to use for detected bean classes.
public void	setIncludeAnnotationConfig(boolean includeAnnotationConfig) Specify whether to register annotation config post-processors.
public void	setScopedProxyMode(ScopedProxyMode scopedProxyMode) Specify the proxy behavior for non-singleton scoped beans.
public void	setScopeMetadataResolver(ScopeMetadataResolver scopeMetadataResolver) Set the ScopeMetadataResolver to use for detected bean classes.

Inherited from org.springframework.context.annotation.ClassPathScanningCandidateComponentProvider:: addExcludeFilter addIncludeFilter clearCache findCandidateComponents getEnvironment getMetadataReaderFactory getResourceLoader isCandidateComponent isCandidateComponent registerDefaultFilters resetFilters resolveBasePackage setEnvironment setMetadataReaderFactory setResourceLoader setResourcePattern

Field Detail

autowireCandidatePatterns	back to summary
private String[] autowireCandidatePatterns Annotations @Nullable

beanDefinitionDefaults	back to summary
private BeanDefinitionDefaults beanDefinitionDefaults

beanNameGenerator	back to summary
private BeanNameGenerator beanNameGenerator

includeAnnotationConfig	back to summary
private boolean includeAnnotationConfig

registry	back to summary
private final BeanDefinitionRegistry registry

scopeMetadataResolver	back to summary
private ScopeMetadataResolver scopeMetadataResolver

Constructor Detail

ClassPathBeanDefinitionScanner back to summary

ClassPathBeanDefinitionScanner	back to summary
public ClassPathBeanDefinitionScanner(BeanDefinitionRegistry registry) Create a new `ClassPathBeanDefinitionScanner` for the given bean factory. Parameters registry:BeanDefinitionRegistry the `BeanFactory` to load bean definitions into, in the form of a `BeanDefinitionRegistry`

public ClassPathBeanDefinitionScanner(BeanDefinitionRegistry registry)

Create a new ClassPathBeanDefinitionScanner for the given bean factory.

Parameters

registry:BeanDefinitionRegistry: the BeanFactory to load bean definitions into, in the form of a BeanDefinitionRegistry

ClassPathBeanDefinitionScanner back to summary

ClassPathBeanDefinitionScanner	back to summary
public ClassPathBeanDefinitionScanner(BeanDefinitionRegistry registry, boolean useDefaultFilters) Create a new `ClassPathBeanDefinitionScanner` for the given bean factory. If the passed-in bean factory does not only implement the `BeanDefinitionRegistry` interface but also the `ResourceLoader` interface, it will be used as default `ResourceLoader` as well. This will usually be the case for `org.springframework.context.ApplicationContext` implementations. If given a plain `BeanDefinitionRegistry`, the default `ResourceLoader` will be a `org.springframework.core.io.support.PathMatchingResourcePatternResolver`. If the passed-in bean factory also implements `EnvironmentCapable` its environment will be used by this reader. Otherwise, the reader will initialize and use a `org.springframework.core.env.StandardEnvironment`. All `ApplicationContext` implementations are `EnvironmentCapable`, while normal `BeanFactory` implementations are not. Parameters registry:BeanDefinitionRegistry the `BeanFactory` to load bean definitions into, in the form of a `BeanDefinitionRegistry` useDefaultFilters:boolean whether to include the default filters for the `@Component`, `@Repository`, `@Service`, and `@Controller` stereotype annotations See Also `setResourceLoader`, `setEnvironment`

public ClassPathBeanDefinitionScanner(BeanDefinitionRegistry registry, boolean useDefaultFilters)

Create a new ClassPathBeanDefinitionScanner for the given bean factory.

If the passed-in bean factory does not only implement the BeanDefinitionRegistry interface but also the ResourceLoader interface, it will be used as default ResourceLoader as well. This will usually be the case for org.springframework.context.ApplicationContext implementations.

If given a plain BeanDefinitionRegistry, the default ResourceLoader will be a org.springframework.core.io.support.PathMatchingResourcePatternResolver.

If the passed-in bean factory also implements EnvironmentCapable its environment will be used by this reader. Otherwise, the reader will initialize and use a org.springframework.core.env.StandardEnvironment. All ApplicationContext implementations are EnvironmentCapable, while normal BeanFactory implementations are not.

Parameters

registry:BeanDefinitionRegistry: the BeanFactory to load bean definitions into, in the form of a BeanDefinitionRegistry
useDefaultFilters:boolean: whether to include the default filters for the @Component, @Repository, @Service, and @Controller stereotype annotations

See Also

setResourceLoader, setEnvironment

ClassPathBeanDefinitionScanner back to summary

ClassPathBeanDefinitionScanner	back to summary
public ClassPathBeanDefinitionScanner(BeanDefinitionRegistry registry, boolean useDefaultFilters, Environment environment) Create a new `ClassPathBeanDefinitionScanner` for the given bean factory and using the given `Environment` when evaluating bean definition profile metadata. If the passed-in bean factory does not only implement the `BeanDefinitionRegistry` interface but also the `ResourceLoader` interface, it will be used as default `ResourceLoader` as well. This will usually be the case for `org.springframework.context.ApplicationContext` implementations. If given a plain `BeanDefinitionRegistry`, the default `ResourceLoader` will be a `org.springframework.core.io.support.PathMatchingResourcePatternResolver`. Parameters registry:BeanDefinitionRegistry the `BeanFactory` to load bean definitions into, in the form of a `BeanDefinitionRegistry` useDefaultFilters:boolean whether to include the default filters for the `@Component`, `@Repository`, `@Service`, and `@Controller` stereotype annotations environment:Environment the Spring `Environment` to use when evaluating bean definition profile metadata Since 3.1 See Also `setResourceLoader`

public ClassPathBeanDefinitionScanner(BeanDefinitionRegistry registry, boolean useDefaultFilters, Environment environment)

Create a new ClassPathBeanDefinitionScanner for the given bean factory and using the given Environment when evaluating bean definition profile metadata.

If given a plain BeanDefinitionRegistry, the default ResourceLoader will be a org.springframework.core.io.support.PathMatchingResourcePatternResolver.

Parameters

registry:BeanDefinitionRegistry: the BeanFactory to load bean definitions into, in the form of a BeanDefinitionRegistry
useDefaultFilters:boolean: whether to include the default filters for the @Component, @Repository, @Service, and @Controller stereotype annotations
environment:Environment: the Spring Environment to use when evaluating bean definition profile metadata

Since

3.1

See Also

setResourceLoader

ClassPathBeanDefinitionScanner back to summary

ClassPathBeanDefinitionScanner	back to summary
public ClassPathBeanDefinitionScanner(BeanDefinitionRegistry registry, boolean useDefaultFilters, Environment environment, ResourceLoader resourceLoader) Create a new `ClassPathBeanDefinitionScanner` for the given bean factory and using the given `Environment` when evaluating bean definition profile metadata. Parameters registry:BeanDefinitionRegistry the `BeanFactory` to load bean definitions into, in the form of a `BeanDefinitionRegistry` useDefaultFilters:boolean whether to include the default filters for the `@Component`, `@Repository`, `@Service`, and `@Controller` stereotype annotations environment:Environment the Spring `Environment` to use when evaluating bean definition profile metadata resourceLoader:ResourceLoader the `ResourceLoader` to use Since 4.3.6

public ClassPathBeanDefinitionScanner(BeanDefinitionRegistry registry, boolean useDefaultFilters, Environment environment, ResourceLoader resourceLoader)

Create a new ClassPathBeanDefinitionScanner for the given bean factory and using the given Environment when evaluating bean definition profile metadata.

Parameters

registry:BeanDefinitionRegistry: the BeanFactory to load bean definitions into, in the form of a BeanDefinitionRegistry
useDefaultFilters:boolean: whether to include the default filters for the @Component, @Repository, @Service, and @Controller stereotype annotations
environment:Environment: the Spring Environment to use when evaluating bean definition profile metadata
resourceLoader:ResourceLoader: the ResourceLoader to use

Since

4.3.6

Method Detail

checkCandidate back to summary

checkCandidate	back to summary
protected boolean checkCandidate(String beanName, BeanDefinition beanDefinition) throws IllegalStateException Check the given candidate's bean name, determining whether the corresponding bean definition needs to be registered or conflicts with an existing definition. Parameters beanName:String the suggested name for the bean beanDefinition:BeanDefinition the corresponding bean definition Returns:boolean `true` if the bean can be registered as-is; `false` if it should be skipped because there is an existing, compatible bean definition for the specified name Exceptions IllegalStateException: if an existing, incompatible bean definition has been found for the specified name

protected boolean checkCandidate(String beanName, BeanDefinition beanDefinition) throws IllegalStateException

Check the given candidate's bean name, determining whether the corresponding bean definition needs to be registered or conflicts with an existing definition.

Parameters

beanName:String: the suggested name for the bean
beanDefinition:BeanDefinition: the corresponding bean definition

Returns:boolean

true if the bean can be registered as-is; false if it should be skipped because there is an existing, compatible bean definition for the specified name

Exceptions

IllegalStateException:: if an existing, incompatible bean definition has been found for the specified name

doScan back to summary

doScan	back to summary
protected Set<BeanDefinitionHolder> doScan(String... basePackages) Perform a scan within the specified base packages, returning the registered bean definitions. This method does not register an annotation config processor but rather leaves this up to the caller. Parameters basePackages:String[] the packages to check for annotated classes Returns:Set<BeanDefinitionHolder> set of beans registered if any for tooling registration purposes (never `null`)

protected Set<BeanDefinitionHolder> doScan(String... basePackages)

Perform a scan within the specified base packages, returning the registered bean definitions.

This method does not register an annotation config processor but rather leaves this up to the caller.

Parameters

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

Returns:Set<BeanDefinitionHolder>

set of beans registered if any for tooling registration purposes (never null)

getBeanDefinitionDefaults back to summary

getBeanDefinitionDefaults	back to summary
public BeanDefinitionDefaults getBeanDefinitionDefaults() Return the defaults to use for detected beans (never `null`). Since 4.1

public BeanDefinitionDefaults getBeanDefinitionDefaults()

Return the defaults to use for detected beans (never null).

Since: 4.1

getOrCreateEnvironment	back to summary
private static Environment getOrCreateEnvironment(BeanDefinitionRegistry registry) Get the Environment from the given registry if possible, otherwise return a new StandardEnvironment.

getRegistry	back to summary
public final BeanDefinitionRegistry getRegistry() Overrides org.springframework.context.annotation.ClassPathScanningCandidateComponentProvider.getRegistry. Return the BeanDefinitionRegistry that this scanner operates on. Annotations @Override

getRegistry

back to summary

public final BeanDefinitionRegistry getRegistry()

Overrides org.springframework.context.annotation.ClassPathScanningCandidateComponentProvider.getRegistry.

Return the BeanDefinitionRegistry that this scanner operates on.

Annotations

@Override

isCompatible	back to summary
protected boolean isCompatible(BeanDefinition newDef, BeanDefinition existingDef) Determine whether the given new bean definition is compatible with the given existing bean definition. The default implementation considers them as compatible when the existing bean definition comes from the same source or from a non-scanning source. Parameters newDef:BeanDefinition the new bean definition, originated from scanning existingDef:BeanDefinition the existing bean definition, potentially an explicitly defined one or a previously generated one from scanning Returns:boolean whether the definitions are considered as compatible, with the new definition to be skipped in favor of the existing definition

isCompatible

back to summary

protected boolean isCompatible(BeanDefinition newDef, BeanDefinition existingDef)

Determine whether the given new bean definition is compatible with the given existing bean definition.

The default implementation considers them as compatible when the existing bean definition comes from the same source or from a non-scanning source.

Parameters

newDef:BeanDefinition: the new bean definition, originated from scanning
existingDef:BeanDefinition: the existing bean definition, potentially an explicitly defined one or a previously generated one from scanning

Returns:boolean

whether the definitions are considered as compatible, with the new definition to be skipped in favor of the existing definition

postProcessBeanDefinition	back to summary
protected void postProcessBeanDefinition(AbstractBeanDefinition beanDefinition, String beanName) Apply further settings to the given bean definition, beyond the contents retrieved from scanning the component class. Parameters beanDefinition:AbstractBeanDefinition the scanned bean definition beanName:String the generated bean name for the given bean

postProcessBeanDefinition

back to summary

protected void postProcessBeanDefinition(AbstractBeanDefinition beanDefinition, String beanName)

Apply further settings to the given bean definition, beyond the contents retrieved from scanning the component class.

Parameters

beanDefinition:AbstractBeanDefinition: the scanned bean definition
beanName:String: the generated bean name for the given bean

registerBeanDefinition	back to summary
protected void registerBeanDefinition(BeanDefinitionHolder definitionHolder, BeanDefinitionRegistry registry) Register the specified bean with the given registry. Can be overridden in subclasses, e.g. to adapt the registration process or to register further bean definitions for each scanned bean. Parameters definitionHolder:BeanDefinitionHolder the bean definition plus bean name for the bean registry:BeanDefinitionRegistry the BeanDefinitionRegistry to register the bean with

registerBeanDefinition

back to summary

protected void registerBeanDefinition(BeanDefinitionHolder definitionHolder, BeanDefinitionRegistry registry)

Can be overridden in subclasses, e.g. to adapt the registration process or to register further bean definitions for each scanned bean.

Parameters

definitionHolder:BeanDefinitionHolder: the bean definition plus bean name for the bean
registry:BeanDefinitionRegistry: the BeanDefinitionRegistry to register the bean with

scan	back to summary
public int scan(String... basePackages) Perform a scan within the specified base packages. Parameters basePackages:String[] the packages to check for annotated classes Returns:int number of beans registered

scan

back to summary

public int scan(String... basePackages)

Perform a scan within the specified base packages.

Parameters

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

Returns:int

number of beans registered

setAutowireCandidatePatterns	back to summary
public void setAutowireCandidatePatterns(String... autowireCandidatePatterns) Set the name-matching patterns for determining autowire candidates. Parameters autowireCandidatePatterns:String[] the patterns to match against

setAutowireCandidatePatterns

back to summary

public void setAutowireCandidatePatterns(String... autowireCandidatePatterns)

Set the name-matching patterns for determining autowire candidates.

Parameters

autowireCandidatePatterns:String[]: the patterns to match against

setBeanDefinitionDefaults back to summary

setBeanDefinitionDefaults	back to summary
public void setBeanDefinitionDefaults(BeanDefinitionDefaults beanDefinitionDefaults) Set the defaults to use for detected beans. See Also `BeanDefinitionDefaults`

public void setBeanDefinitionDefaults(BeanDefinitionDefaults beanDefinitionDefaults)

Set the defaults to use for detected beans.

See Also: BeanDefinitionDefaults

setBeanNameGenerator back to summary

setBeanNameGenerator	back to summary
public void setBeanNameGenerator(BeanNameGenerator beanNameGenerator) Set the BeanNameGenerator to use for detected bean classes. Default is a `AnnotationBeanNameGenerator`.

public void setBeanNameGenerator(BeanNameGenerator beanNameGenerator)

Set the BeanNameGenerator to use for detected bean classes.

Default is a AnnotationBeanNameGenerator.

setIncludeAnnotationConfig	back to summary
public void setIncludeAnnotationConfig(boolean includeAnnotationConfig) Specify whether to register annotation config post-processors. The default is to register the post-processors. Turn this off to be able to ignore the annotations or to process them differently.

setIncludeAnnotationConfig

back to summary

public void setIncludeAnnotationConfig(boolean includeAnnotationConfig)

Specify whether to register annotation config post-processors.

The default is to register the post-processors. Turn this off to be able to ignore the annotations or to process them differently.

setScopedProxyMode back to summary

setScopedProxyMode	back to summary
public void setScopedProxyMode(ScopedProxyMode scopedProxyMode) Specify the proxy behavior for non-singleton scoped beans. Note that this will override any custom "scopeMetadataResolver" setting. The default is `ScopedProxyMode#NO`. See Also `setScopeMetadataResolver`

public void setScopedProxyMode(ScopedProxyMode scopedProxyMode)

Specify the proxy behavior for non-singleton scoped beans. Note that this will override any custom "scopeMetadataResolver" setting.

The default is ScopedProxyMode#NO.

See Also: setScopeMetadataResolver

setScopeMetadataResolver back to summary

public void setScopeMetadataResolver(ScopeMetadataResolver scopeMetadataResolver)

Set the ScopeMetadataResolver to use for detected bean classes. Note that this will override any custom "scopedProxyMode" setting.

The default is an AnnotationScopeMetadataResolver.

See Also: setScopedProxyMode

public Class ClassPathBeanDefinitionScanner

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail