@Target(value=TYPE) @Retention(value=RUNTIME) @Documented @Import(value=org.springframework.boot.web.servlet.ServletComponentScanRegistrar.class) public @interface ServletComponentScan
filters
, servlets
, and listeners
). Scanning is only performed when using an
embedded web server.
Typically, one of value
, basePackages
, or basePackageClasses
should be specified to control the packages to be scanned for components. In their
absence, scanning will be performed from the package of the class with the annotation.
WebServlet
,
WebFilter
,
WebListener
Modifier and Type | Optional Element and Description |
---|---|
Class<?>[] |
basePackageClasses
Type-safe alternative to
basePackages() for specifying the packages to
scan for annotated servlet components. |
String[] |
basePackages
Base packages to scan for annotated servlet components.
|
String[] |
value
Alias for the
basePackages() attribute. |
@AliasFor(value="basePackages") public abstract String[] value
basePackages()
attribute. Allows for more concise annotation
declarations e.g.: @ServletComponentScan("org.my.pkg")
instead of
@ServletComponentScan(basePackages="org.my.pkg")
.@AliasFor(value="value") public abstract String[] basePackages
value()
is an
alias for (and mutually exclusive with) this attribute.
Use basePackageClasses()
for a type-safe alternative to String-based
package names.
public abstract Class<?>[] basePackageClasses
basePackages()
for specifying the packages to
scan for annotated servlet components. The package of each class specified will be
scanned.Copyright © 2021 Pivotal Software, Inc.. All rights reserved.