Annotation Type ServletComponentScan
@Target(TYPE) @Retention(RUNTIME) @Documented @Import(org.springframework.boot.web.servlet.ServletComponentScanRegistrar.class) public @interface ServletComponentScan
Enables scanning for Servlet components (filters
,servlets
, andlisteners
). Scanning is only performed when using an embedded web server.Typically, one of
value
,basePackages
, orbasePackageClasses
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.- Since:
- 1.3.0
- See Also:
WebServlet
,WebFilter
,WebListener
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description Class<?>[]
basePackageClasses
Type-safe alternative tobasePackages()
for specifying the packages to scan for annotated servlet components.String[]
basePackages
Base packages to scan for annotated servlet components.String[]
value
Alias for thebasePackages()
attribute.
Element Detail
value
@AliasFor("basePackages") String[] value
Alias for thebasePackages()
attribute. Allows for more concise annotation declarations e.g.:@ServletComponentScan("org.my.pkg")
instead of@ServletComponentScan(basePackages="org.my.pkg")
.- Returns:
- the base packages to scan
- Default:
- {}
basePackages
@AliasFor("value") String[] basePackages
Base packages to scan for annotated servlet components.value()
is an alias for (and mutually exclusive with) this attribute.Use
basePackageClasses()
for a type-safe alternative to String-based package names.- Returns:
- the base packages to scan
- Default:
- {}
basePackageClasses
Class<?>[] basePackageClasses
Type-safe alternative tobasePackages()
for specifying the packages to scan for annotated servlet components. The package of each class specified will be scanned.- Returns:
- classes from the base packages to scan
- Default:
- {}