Document placeholder and Ant-style pattern support for @ComponentScan
#35491
+52
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…onentscan - JavaDoc: clarify that basePackages/value resolve ${…} via Environment and accept Ant-style package patterns (e.g., com.example.**); note patterns don’t apply to basePackageClasses. - Reference: add “Property placeholders and Ant-style patterns” subsection in classpath-scanning.adoc with Java/Kotlin + properties examples. Closes spring-projectsgh-35288 Signed-off-by: Byeong-Uk Park <114344042+Rockernun@users.noreply.github.com>
spring-projects-issues
added
the
status: waiting-for-triage
sbrannen
added
type: documentation
sbrannen
changed the title
${…} placeholders & Ant-style patterns for @ComponentScan
sbrannen
removed
the
status: waiting-for-triage
sbrannen
approved these changes
Sep 18, 2025
| `exports` declaration in your `module-info` descriptor). | ||
| ==== | ||
|
|
||
| ==== Property placeholders and Ant-style patterns |
There was a problem hiding this comment.
Please note that this breaks the build.
[16:49:49.179] WARN (asciidoctor): section title out of sequence: expected level 2, got level 3
file: /XXX/spring-framework/framework-docs/modules/ROOT/pages/core/beans/classpath-scanning.adoc:335
However, I have addressed this locally, thus there is no need to update this PR.
|
|
||
| NOTE: Ant-style patterns do not apply to `basePackageClasses`, which accepts concrete | ||
| classes and derives packages from those classes. | ||
|
|
There was a problem hiding this comment.
FYI: the following paragraph and note belong to the previous section about XML configuration.
However, I have addressed this locally, thus there is no need to update this PR.
Comment on lines
+97
to
+99
| * <p><strong>Note:</strong> Ant-style patterns are <em>not</em> applicable to | ||
| * {@link #basePackageClasses()}, which accepts concrete classes for type-safe | ||
| * package selection. |
There was a problem hiding this comment.
I don't think there is any need to point this out, since one can only supply Class references via the basePackageClasses attribute.
Thus, I have removed this and other such text locally.
sbrannen
reviewed
Sep 18, 2025
| `exports` declaration in your `module-info` descriptor). | ||
| ==== | ||
|
|
||
| ==== Property placeholders and Ant-style patterns |
There was a problem hiding this comment.
For future reference, please note that we do our best to introduce custom anchors that align with other anchors used in the same file.
For example, I've added the following that I will apply after merging this PR.
[[beans-scanning-placeholders-and-patterns]]
sbrannen
changed the title
${…} placeholders & Ant-style patterns for @ComponentScan@ComponentScan
sbrannen
added a commit
that referenced
this pull request
Sep 18, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
@ComponentScan(basePackages)already supports:However, this behavior wasn’t explicitly called out in the JavaDoc or the reference docs, making it easy to miss. This PR documents those capabilities and clarifies where pattern support applies.
JavaDoc: clarify that basePackages/value resolve ${…} via the Environment and support Ant-style package patterns (e.g., com.example.**); note patterns do not apply to basePackageClasses.
Reference docs: add a short subsection in classpath-scanning.adoc with Java/Kotlin + properties examples.
Related Issues
@ComponentScan(basePackages)property placeholder and ant-path support #35288