-
-
Notifications
You must be signed in to change notification settings - Fork 22
How to scan classes for specific annotations and collect its values
Roberto Gentili edited this page Oct 13, 2021
·
15 revisions
Here the solution:
import java.util.Arrays;
import java.util.List;
import java.util.stream.Collectors;
import org.burningwave.core.assembler.ComponentContainer;
import org.burningwave.core.assembler.ComponentSupplier;
import org.burningwave.core.classes.ClassCriteria;
import org.burningwave.core.classes.ClassHunter;
import org.burningwave.core.classes.SearchConfig;
import org.burningwave.core.io.PathHelper;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
public class Finder {
public List<String> find() {
ComponentSupplier componentSupplier = ComponentContainer.getInstance();
PathHelper pathHelper = componentSupplier.getPathHelper();
ClassHunter classHunter = componentSupplier.getClassHunter();
SearchConfig searchConfig = SearchConfig.forPaths(
//Here you can add all absolute path you want:
//both folders, zip and jar will be recursively scanned.
//For example you can add: "C:\\Users\\user\\.m2"
//With the line below the search will be executed on runtime class paths
pathHelper.getMainClassPaths()
).by(
ClassCriteria.create().allThoseThatMatch((cls) -> {
return
//Unconment one of this if you need to filter for package name
//cls.getPackage().getName().matches("regular expression") &&
//cls.getPackage().getName().startsWith("com") &&
//cls.getPackage().getName().equals("com.something") &&
cls.getAnnotation(Controller.class) != null &&
cls.getAnnotation(RequestMapping.class) != null;
})
);
try (ClassHunter.SearchResult searchResult = classHunter.findBy(searchConfig)) {
List<String> pathsList = searchResult.getClasses().stream().map(cls ->
Arrays.asList(cls.getAnnotation(RequestMapping.class).value())
).flatMap(List::stream).distinct().collect(Collectors.toList());
return pathsList;
}
}
}
Burningwave core is a fully indipendent, advanced, free and open source Java frameworks building library that contains AN EXTREMELY POWERFUL CLASSPATH SCANNER.
To include Burningwave Core library in your projects simply use with Apache Maven:
<dependency>
<groupId>org.burningwave</groupId>
<artifactId>core</artifactId>
<version>12.65.2</version>
</dependency>
To use Burningwave Core as a Java module add the following to your module-info.java
:
requires org.burningwave.core;
ClassFactory
ClassHunter
- In depth look to and configuration guide
- USE CASE: retrieving all classes of the classpath
- USE CASE: retrieving all classes that implement one or more interfaces
- USE CASE: finding all classes that extend a base class
- USE CASE: searching for all classes that have package name that matches a regex
- USE CASE: finding all classes for module name (Java 9 and later)
- USE CASE: finding all annotated classes
- USE CASE: how to scan classes for specific annotations and collect its values
- USE CASE: searching for all classes with a constructor that takes a specific type as first parameter and with at least 2 methods that begin for a given string
- USE CASE: searching for all classes with methods whose name begins for a given string and that takes a specific type as its first parameter
- USE CASE: finding all classes that have at least 2 protected fields