AnnotatedElementUtils fails to find annotations on abstract, bridge, or interface methods [SPR-12738]

[spring-projects-issues]

Rossen Stoyanchev opened SPR-12738 and commented

Overview

This was encountered while adding support for @RequestMapping as meta annotation. Following a change from AnnotationUtils.findAnnotation to AnnotatedElementUtils.getAnnotationAttributes, there are failing integration tests with controller hierarchies.

---

Analysis / Known Issues

1. AnnotatedElementUtils does not currently support interfaces or bridge methods in its search algorithms.

---

Deliverables

1. Support abstract methods in AnnotatedElementUtils.
2. Support interface methods in AnnotatedElementUtils.
3. Support bridge methods in AnnotatedElementUtils.
4. Support bridged methods in AnnotatedElementUtils.
5. Search for TODOs in AnnotatedElementUtilsTests and re-instate @Ignore'd tests.
6. Search for TODOs in TransactionalEventListenerTests and re-instate @Ignore'd tests.

---

Affects: 4.1.5

Issue Links:

• Custom @RequestMapping annotations [SPR-12296] #16901 Custom @RequestMapping annotations ("is depended on by")
• AnnotatedElementUtils does not find annotations on methods in dynamic proxies [SPR-12703] #17300 AnnotatedElementUtils does not find annotations on methods in dynamic proxies
• Support composed annotations declared on interfaces [SPR-11108] #15734 Support composed annotations declared on interfaces
• Favor more locally declared composed annotations over inherited annotations [SPR-11598] #16221 Favor more locally declared composed annotations over inherited annotations
• AnnotatedElementUtils fails to find type-level annotations on interfaces [SPR-12944] #17537 AnnotatedElementUtils fails to find type-level annotations on interfaces
• Consider not overriding meta-annotation attributes if empty [SPR-11709] #16331 Consider not overriding meta-annotation attributes if empty

Referenced from: commits 7f0f04d, 91e46cf, bccd59e, 8ece1b1, ad6bea1, e0d2dbd, b94c6fd

[spring-projects-issues]

Rossen Stoyanchev commented

Tests added in b94c6fd.

For example, ServletAnnotationControllerHandlerMethodTests has a number of failures (that's in the temporary branch for @RequestMapping meta-annotation support).

[spring-projects-issues]

Sam Brannen commented

Potentially related commits to review:

• 6d36498#diff-c379a0ad15cd3b7eb09f75b1d9d3a638
• 8e445f3#diff-0351de4276b649d3c97fcd9c9b2e501f

[spring-projects-issues]

Sam Brannen commented

FYI: support for finding annotations at the type level on interfaces is addressed by #17537.

[spring-projects-issues]

Sam Brannen commented

Completed as described in GitHub commit ad6bea1:

Support abstract, bridge, & interface methods in AnnotatedElementUtils

This commit introduces support for finding annotations on abstract,
bridge, and interface methods in AnnotatedElementUtils.

• Introduced dedicated findAnnotationAttributes() methods in
  AnnotatedElementUtils that provide first-class support for
  processing methods, class hierarchies, interfaces, bridge methods,
  etc.

• Introduced find/get search algorithm dichotomy in
  AnnotatedElementUtils which is visible in the public API as well as
  in the internal implementation. This was necessary in order to
  maintain backwards compatibility with the existing API (even though
  it was undocumented).

• Reverted all recent changes made to the "get semantics" search
  algorithm in AnnotatedElementUtils in order to ensure backwards
  compatibility, and reverted recent changes to
  JtaTransactionAnnotationParser and SpringTransactionAnnotationParser
  accordingly.

• Documented internal AnnotatedElementUtils.Processor<T> interface.

• Enabled failing tests and introduced
  findAnnotationAttributesFromBridgeMethod() test in
  AnnotatedElementUtilsTests.

• Refactored ApplicationListenerMethodAdapter.getCondition() and
  enabled failing test in TransactionalEventListenerTests.

• AnnotationUtils.isInterfaceWithAnnotatedMethods() is now package
  private.

[spring-projects-issues]

Sam Brannen commented

Important

To utilize these features, you will need to invoke AnnotatedElementUtils.findAnnotationAttributes(), not AnnotatedElementUtils.getAnnotationAttributes().

The existing getAnnotationAttributes() methods have been left in place and reworked so that they remain backwards compatible.

[spring-projects-issues]

Sam Brannen commented

Rossen Stoyanchev,

Note the (x) in this issue's description.

Basically, AnnotatedElementUtils supports finding annotations on a bridge method but not on a bridged method.

The test you introduced in AnnotatedElementUtilsTests (i.e., findAnnotationAttributesInheritedFromBridgedMethod()) is still @Ignore'd because it actually attempts to find an annotation on a bridged method. Note, however, that the newly introduced findAnnotationAttributesFromBridgeMethod() test works as expected.

Thus, I think your test might not adequately mimic what occurs at runtime. For example, in RequestMappingHandlerMapping it appears to me that all of the methods in a given candidate class will be iterated over reflectively. Thus annotated bridge methods should still be handled appropriately (I hope).

Can you please rebase your temporary branch against master and let me know if the new AnnotatedElementUtils.findAnnotationAttributes() method suits your needs?

Thanks!

Sam

[spring-projects-issues]

Rossen Stoyanchev commented

Sure I'll give it a try.

[spring-projects-issues]

Rossen Stoyanchev commented

Sam Brannen, I rebased my branch but still seeing the same failures. Would you take a look? Run the spring-webmvc tests and the failures are in MvcUriComponentsBuilderTests, ServletAnnotationControllerHandlerMethodTests, and HandlerMethodAnnotationDetectionTests.

[spring-projects-issues]

Sam Brannen commented

Rossen Stoyanchev, I have not checked out your branch, but just by looking at the code on GitHub, I see that you are still invoking AnnotatedElementUtils.getAnnotationAttributes() which does not support the new search features.

Please switch to AnnotatedElementUtils.findAnnotationAttributes() (note the find) and let me know if that solves your problems!

Thanks,

Sam

[spring-projects-issues]

Rossen Stoyanchev commented

All green!

[spring-projects-issues]

Sam Brannen commented

Awesome! :)

Thanks for letting me know.