Stop using explicitly aliased value attribute as @Component name
#34346
Assignees
Labels
in: core
Issues in core modules (aop, beans, core, context, expression)
type: enhancement
A general enhancement
Milestone
Comments
sbrannen
added
in: core
sbrannen
added a commit
that referenced
this issue
Feb 10, 2025
…name Prior to this commit, if a String 'value' attribute of an annotation was annotated with @AliasFor and explicitly configured to alias an attribute other than @Component.value, the value was still used as the @Component name, but the warning message that was logged stated that the 'value' attribute should be annotated with @AliasFor(annotation=Component.class). However, it is not possible to annotate an annotation attribute twice with @AliasFor. To address that, this commit revises the logic in AnnotationBeanNameGenerator so that it issues a log message similar to the following in such scenarios. WARN o.s.c.a.AnnotationBeanNameGenerator - Although the 'value' attribute in @example.MyStereotype declares @AliasFor for an attribute other than @Component's 'value' attribute, the value is still used as the @Component name based on convention. As of Spring Framework 7.0, such a 'value' attribute will no longer be used as the @Component name. See gh-34346 Closes gh-34317
sbrannen
added a commit
that referenced
this issue
Feb 10, 2025
…name Prior to this commit, if a String 'value' attribute of an annotation was annotated with @AliasFor and explicitly configured to alias an attribute other than @Component.value, the value was still used as the @Component name, but the warning message that was logged stated that the 'value' attribute should be annotated with @AliasFor(annotation=Component.class). However, it is not possible to annotate an annotation attribute twice with @AliasFor. To address that, this commit revises the logic in AnnotationBeanNameGenerator so that it issues a log message similar to the following in such scenarios. WARN o.s.c.a.AnnotationBeanNameGenerator - Although the 'value' attribute in @example.MyStereotype declares @AliasFor for an attribute other than @Component's 'value' attribute, the value is still used as the @Component name based on convention. As of Spring Framework 7.0, such a 'value' attribute will no longer be used as the @Component name. See gh-34346 Closes gh-34317 (cherry picked from commit 17a94fb)
sbrannen
changed the title
value attribute as @Component namevalue attribute as @Component name
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Overview
As discussed in #34317, if a custom annotation is meta-annotated with
@Componentand declares a localString valueattribute that is explicitly configured (via@AliasFor) as an override for an attribute other thanComponent.value, the localvalueattribute is still used as a convention-based override forComponent.value.The result is that a local
valueattribute will be used as a custom@Componentname, even when that is clearly not the intent.In light of that, we will stop using a
valueattribute that is explicitly aliased to something other than@Component.valueas the@Componentname, beginning with Spring Framework 7.0.Related Issues
@Componentstereotype names using@AliasForsemantics #31089AnnotationBeanNameGeneratorissues warning about explicitly aliasedvalueattribute #34317The text was updated successfully, but these errors were encountered: