Este artigo fornece uma breve visão geral de três ferramentas para localizar classes anotadas em um projeto java.
Gatos treinando@Retention(RetentionPolicy.RUNTIME) public @interface MyAnnotation {} @MyAnnotation public class Bar {} @MyAnnotation public class Foo {}
Primavera
No Spring, ClassPathScanningCandidateComponentProvider serve para esse fim.
Funcionalidade: rastreia no ClassPath, procurando por classes que satisfaçam as condições especificadas
Recursos adicionaistem muitos outros filtros (por tipo, por métodos etc.)
Exemplo
@Benchmark public void spring() { ClassPathScanningCandidateComponentProvider scanner = new ClassPathScanningCandidateComponentProvider(false); scanner.addIncludeFilter(new AnnotationTypeFilter(MyAnnotation.class)); List<String> collect = scanner .findCandidateComponents("edu.pqdn.scanner") .stream() .map(BeanDefinition::getBeanClassName) .filter(Objects::nonNull) .collect(Collectors.toList()); assertEquals(collect.size(), 2); assertTrue(collect.contains("edu.pqdn.scanner.test.Bar")); assertTrue(collect.contains("edu.pqdn.scanner.test.Foo")); }
Funcionalidade: rastreia no ClassPath, procurando por classes que satisfaçam as condições especificadas
Recursos adicionais- obter todos os subtipos de algum tipo
- obter todos os tipos / membros anotados com alguma anotação
- obtenha todos os recursos correspondentes a uma expressão regular
- obtenha todos os métodos com assinatura específica, incluindo parâmetros, anotações de parâmetros e tipo de retorno
dependência <dependency> <groupId>org.reflections</groupId> <artifactId>reflections</artifactId> <version>0.9.11</version> </dependency>
Exemplo
@Benchmark public void reflection() { Reflections reflections = new Reflections("edu.pqdn.scanner"); Set<Class<?>> set = reflections.getTypesAnnotatedWith(MyAnnotation.class); List<String> collect = set.stream() .map(Class::getCanonicalName) .collect(Collectors.toList()); assertEquals(collect.size(), 2); assertTrue(collect.contains("edu.pqdn.scanner.test.Bar")); assertTrue(collect.contains("edu.pqdn.scanner.test.Foo")); }
Recurso: NÃO entra no ClassPath; as classes são indexadas no momento da compilação
dependência <dependency> <groupId>org.atteo.classindex</groupId> <artifactId>classindex</artifactId> <version>3.4</version> </dependency>
Gatos treinando @IndexMyAnnotated public @interface IndexerAnnotation {} @IndexerMyAnnotation public class Bar {} @IndexerMyAnnotation public class Foo {}
Exemplo
@Benchmark public void indexer() { Iterable<Class<?>> iterable = ClassIndex.getAnnotated(IndexerMyAnnotation.class); List<String> list = StreamSupport.stream(iterable.spliterator(), false) .map(aClass -> aClass.getCanonicalName()) .collect(Collectors.toList()); assertEquals(list.size(), 2); assertTrue(list.contains("edu.pqdn.scanner.classindexer.test.Bar")); assertTrue(list.contains("edu.pqdn.scanner.classindexer.test.Foo")); }
Jmh
Benchmark Mode Cnt Score Error Units ScannerBenchmark.indexer avgt 50 0,100 ? 0,001 ms/op ScannerBenchmark.reflection avgt 50 5,157 ? 0,047 ms/op ScannerBenchmark.spring avgt 50 4,706 ? 0,294 ms/op
Conclusão
Como você pode ver, o indexador é a ferramenta mais produtiva; no entanto, as anotações usadas para pesquisar devem ter o estereótipo @IndexAnnotated.
As outras duas ferramentas funcionam muito mais lentamente, mas para o trabalho delas não é necessário xamanismo com o código. A desvantagem é completamente nivelada se a pesquisa for necessária apenas no início do aplicativo