Skip to content

perf: Replace Reflections with ClassGraph and share scan across factories (TEDEFO-5033) #53

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rousso merged 1 commit into from
Apr 28, 2026
Merged

perf: Replace Reflections with ClassGraph and share scan across factories (TEDEFO-5033) #53

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@
<version.maven>3.8.6</version.maven>
<version.ph-jaxb>11.1.3</version.ph-jaxb>
<version.ph-genericode>7.1.1</version.ph-genericode>
<version.reflections>0.10.2</version.reflections>
<version.classgraph>4.8.179</version.classgraph>
<version.resolver>1.8.2</version.resolver>
<version.semver4j>3.1.0</version.semver4j>
<version.slf4j>2.0.3</version.slf4j>
Expand All @@ -76,9 +76,9 @@
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.reflections</groupId>
<artifactId>reflections</artifactId>
<version>${version.reflections}</version>
<groupId>io.github.classgraph</groupId>
<artifactId>classgraph</artifactId>
<version>${version.classgraph}</version>
</dependency>

<dependency>
Expand Down Expand Up @@ -228,8 +228,8 @@

<dependencies>
<dependency>
<groupId>org.reflections</groupId>
<artifactId>reflections</artifactId>
<groupId>io.github.classgraph</groupId>
<artifactId>classgraph</artifactId>
</dependency>

<!-- Apache Commons -->
Expand Down
116 changes: 57 additions & 59 deletions src/main/java/eu/europa/ted/eforms/sdk/component/SdkComponentFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,9 @@
import java.util.Map.Entry;
import java.util.Objects;
import java.util.Optional;
import java.util.stream.Stream;
import eu.europa.ted.eforms.sdk.SdkVersion;
import org.reflections.Reflections;
import org.reflections.util.ClasspathHelper;
import org.reflections.util.ConfigurationBuilder;
import io.github.classgraph.ClassGraph;
import io.github.classgraph.ScanResult;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

Expand All @@ -23,6 +21,26 @@
public abstract class SdkComponentFactory {
private static final Logger logger = LoggerFactory.getLogger(SdkComponentFactory.class);

/**
* Lazy-init holder for the JVM-wide classpath scan. Triggered the first time any
* {@link SdkComponentFactory} subclass is constructed; the resulting list is shared
* by all subclasses so that the (potentially expensive) classpath walk runs only once
* per JVM rather than once per factory subclass.
*/
private static final class AnnotatedClassesHolder {
static final List<Class<?>> CLASSES = scan();

private static List<Class<?>> scan() {
logger.debug("Scanning the classpath for types annotated with {}", SdkComponent.class);
try (ScanResult result = new ClassGraph()
.enableAnnotationInfo()
.ignoreClassVisibility()
.scan()) {
return result.getClassesWithAnnotation(SdkComponent.class).loadClasses();
}
}
}

private Map<String, Map<ComponentSelector, SdkComponentDescriptor<?>>> componentsMap;

class ComponentSelector {
Expand Down Expand Up @@ -65,67 +83,47 @@ protected SdkComponentFactory() {
private void populateComponents() {
Class<SdkComponent> annotationType = SdkComponent.class;

logger.debug("Looking in the classpath for types annotated with {}", annotationType);

if (componentsMap == null) {
componentsMap = new HashMap<>();
}

// Get a list of all the packages loaded by the available classloaders.
// This can be a bit expensive in some situations, so this method factory should
// be ensured to run as less as possible (ideally only once).
String[] availablePackages = Arrays
.stream(ClasspathHelper.classLoaders())
.map(ClassLoader::getDefinedPackages)
.flatMap(Stream::of)
.map(Package::getName)
.toArray(String[]::new);
AnnotatedClassesHolder.CLASSES.forEach((Class<?> clazz) -> {
logger.trace("Processing type [{}]", clazz);

if (logger.isTraceEnabled()) {
final List<String> packages = Arrays.asList(availablePackages);
packages.stream().sorted()
.forEach(p -> logger.trace(p));
}
SdkComponent annotation = clazz.getAnnotation(annotationType);

String[] supportedSdkVersions = annotation.versions();
SdkComponentType componentType = annotation.componentType();
String qualifier = annotation.qualifier();
ComponentSelector selector = new ComponentSelector(componentType, qualifier);

logger.trace("Class [{}] has a component type of [{}] and supports SDK versions [{}]",
clazz, componentType, supportedSdkVersions);

Arrays.asList(supportedSdkVersions).forEach((String sdkVersion) -> {
SdkComponentDescriptor<?> component =
new SdkComponentDescriptor<>(sdkVersion, componentType, clazz);

Map<ComponentSelector, SdkComponentDescriptor<?>> components =
componentsMap.get(sdkVersion);

if (components != null) {
SdkComponentDescriptor<?> existingComponent = components.get(selector);

if (existingComponent != null && !existingComponent.equals(component)) {
throw new IllegalArgumentException(MessageFormat.format(
"More than one components of type [{0}] have been found for SDK version [{1}]:\n\t- {2}\n\t- {3}",
componentType, sdkVersion, existingComponent.getImplType().getName(),
clazz.getName()));
}
} else {
components = new HashMap<>();
componentsMap.put(sdkVersion, components);
}

new Reflections(ConfigurationBuilder.build().forPackages(availablePackages))
.getTypesAnnotatedWith(annotationType).stream()
.forEach((Class<?> clazz) -> {
logger.trace("Processing type [{}]", clazz);

SdkComponent annotation = clazz.getAnnotation(annotationType);

String[] supportedSdkVersions = annotation.versions();
SdkComponentType componentType = annotation.componentType();
String qualifier = annotation.qualifier();
ComponentSelector selector = new ComponentSelector(componentType, qualifier);

logger.trace("Class [{}] has a component type of [{}] and supports SDK versions [{}]",
clazz, componentType, supportedSdkVersions);

Arrays.asList(supportedSdkVersions).forEach((String sdkVersion) -> {
SdkComponentDescriptor<?> component =
new SdkComponentDescriptor<>(sdkVersion, componentType, clazz);

Map<ComponentSelector, SdkComponentDescriptor<?>> components =
componentsMap.get(sdkVersion);

if (components != null) {
SdkComponentDescriptor<?> existingComponent = components.get(selector);

if (existingComponent != null && !existingComponent.equals(component)) {
throw new IllegalArgumentException(MessageFormat.format(
"More than one components of type [{0}] have been found for SDK version [{1}]:\n\t- {2}\n\t- {3}",
componentType, sdkVersion, existingComponent.getImplType().getName(),
clazz.getName()));
}
} else {
components = new HashMap<>();
componentsMap.put(sdkVersion, components);
}

components.put(selector, component);
});
});
components.put(selector, component);
});
});
}

protected <T> T getComponentImpl(String sdkVersion, final SdkComponentType componentType,
Expand Down
Loading