Skip to content
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

feat: replace reflections lib with classgraph #119

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
+59 −70
Open

feat: replace reflections lib with classgraph #119

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
74cc79b
feat: replace reflections lib with classgraph
CarstenWickner Jan 2, 2024
e51670a
feat: avoid changing thread classloader
CarstenWickner Jan 3, 2024
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
8 changes: 4 additions & 4 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@
<groovy.version>1.8.0</groovy.version>
<groovy.eclipse.compiler.version>2.7.0-01</groovy.eclipse.compiler.version>
<groovy-eclipse-batch.version>2.0.4-04</groovy-eclipse-batch.version>
<io.github.classgraph.version>4.8.149</io.github.classgraph.version>
<io.openapitools.jackson.dataformat.version>1.0.8</io.openapitools.jackson.dataformat.version>
<io.swagger.core.v3.version>2.1.7</io.swagger.core.v3.version>
<javax.xml.bin.jaxb-api.version>2.3.0</javax.xml.bin.jaxb-api.version>
Expand All @@ -64,7 +65,6 @@
<org.apache.maven.version>3.6.0</org.apache.maven.version>
<org.apache.maven.plugin-testing.version>3.3.0</org.apache.maven.plugin-testing.version>
<org.mockito.version>3.2.0</org.mockito.version>
<org.reflections.version>0.9.12</org.reflections.version>
<org.slf4j.version>1.7.29</org.slf4j.version>
</properties>

Expand Down Expand Up @@ -105,9 +105,9 @@
<version>${org.apache.maven.version}</version>
</dependency>
<dependency>
<groupId>org.reflections</groupId>
<artifactId>reflections</artifactId>
<version>${org.reflections.version}</version>
<groupId>io.github.classgraph</groupId>
<artifactId>classgraph</artifactId>
<version>${io.github.classgraph.version}</version>
</dependency>
<dependency>
<groupId>javax.xml.bind</groupId>
Expand Down
49 changes: 19 additions & 30 deletions src/main/java/io/openapitools/swagger/GenerateMojo.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,40 +110,29 @@ public void execute() throws MojoExecutionException, MojoFailureException {
return;
}

ClassLoader origClzLoader = Thread.currentThread().getContextClassLoader();
ClassLoader clzLoader = createClassLoader(origClzLoader);
Reader reader = new Reader(swaggerConfig == null ? new OpenAPI() : swaggerConfig.createSwaggerModel());

try {
// set the TCCL before everything else
Thread.currentThread().setContextClassLoader(clzLoader);

Reader reader = new Reader(swaggerConfig == null ? new OpenAPI() : swaggerConfig.createSwaggerModel());
JaxRSScanner reflectiveScanner = new JaxRSScanner(getLog(), createClassLoader(), resourcePackages, useResourcePackagesChildren);

JaxRSScanner reflectiveScanner = new JaxRSScanner(getLog(), resourcePackages, useResourcePackagesChildren);
Application application = resolveApplication(reflectiveScanner);
reader.setApplication(application);

Application application = resolveApplication(reflectiveScanner);
reader.setApplication(application);
OpenAPI swagger = OpenAPISorter.sort(reader.read(reflectiveScanner.classes()));

OpenAPI swagger = OpenAPISorter.sort(reader.read(reflectiveScanner.classes()));

if (outputDirectory.mkdirs()) {
getLog().debug("Created output directory " + outputDirectory);
}
if (outputDirectory.mkdirs()) {
getLog().debug("Created output directory " + outputDirectory);
}

outputFormats.forEach(format -> {
try {
File outputFile = new File(outputDirectory, outputFilename + "." + format.name().toLowerCase());
format.write(swagger, outputFile, prettyPrint);
if (attachSwaggerArtifact) {
projectHelper.attachArtifact(project, format.name().toLowerCase(), "swagger", outputFile);
}
} catch (IOException e) {
throw new RuntimeException("Unable write " + outputFilename + " document", e);
try {
for (OutputFormat format : outputFormats) {
File outputFile = new File(outputDirectory, outputFilename + "." + format.name().toLowerCase());
format.write(swagger, outputFile, prettyPrint);
if (attachSwaggerArtifact) {
projectHelper.attachArtifact(project, format.name().toLowerCase(), "swagger", outputFile);
}
});
} finally {
// reset the TCCL back to the original class loader
Thread.currentThread().setContextClassLoader(origClzLoader);
}
} catch (IOException e) {
throw new RuntimeException("Unable write " + outputFilename + " document", e);
}
}

Expand All @@ -164,15 +153,15 @@ private Application resolveApplication(JaxRSScanner reflectiveScanner) {
return ClassUtils.createInstance(appClazz);
}

private URLClassLoader createClassLoader(ClassLoader parent) {
private URLClassLoader createClassLoader() {
try {
Collection<String> dependencies = getDependentClasspathElements();
URL[] urls = new URL[dependencies.size()];
int index = 0;
for (String dependency : dependencies) {
urls[index++] = Paths.get(dependency).toUri().toURL();
}
return new URLClassLoader(urls, parent);
return new URLClassLoader(urls, Thread.currentThread().getContextClassLoader());
} catch (MalformedURLException e) {
throw new RuntimeException("Unable to create class loader with compiled classes", e);
} catch (DependencyResolutionRequiredException e) {
Expand Down
72 changes: 36 additions & 36 deletions src/main/java/io/openapitools/swagger/JaxRSScanner.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,11 @@
import javax.ws.rs.core.Application;

import org.apache.maven.plugin.logging.Log;
import org.reflections.Reflections;
import org.reflections.scanners.ResourcesScanner;
import org.reflections.scanners.SubTypesScanner;
import org.reflections.scanners.TypeAnnotationsScanner;
import org.reflections.util.ConfigurationBuilder;

import io.github.classgraph.ClassGraph;
import io.github.classgraph.ClassInfo;
import io.github.classgraph.ClassInfoList;
import io.github.classgraph.ScanResult;
import io.swagger.v3.oas.annotations.OpenAPIDefinition;

/**
Expand All @@ -26,53 +25,54 @@ class JaxRSScanner {

private final Log log;

private final ClassGraph classGraph;

private final Set<String> resourcePackages;

private final boolean useResourcePackagesChildren;

public JaxRSScanner(Log log, Set<String> resourcePackages, Boolean useResourcePackagesChildren) {
public JaxRSScanner(Log log, ClassLoader clzLoader, Set<String> resourcePackages, Boolean useResourcePackagesChildren) {
this.log = log;
this.classGraph = new ClassGraph().enableClassInfo().enableAnnotationInfo()
.addClassLoader(clzLoader);
this.resourcePackages = resourcePackages == null ? Collections.emptySet() : new HashSet<>(resourcePackages);
this.useResourcePackagesChildren = useResourcePackagesChildren != null && useResourcePackagesChildren;
this.useResourcePackagesChildren = Boolean.TRUE.equals(useResourcePackagesChildren);
}

Application applicationInstance() {
ConfigurationBuilder config = ConfigurationBuilder
.build(resourcePackages)
.setScanners(new ResourcesScanner(), new TypeAnnotationsScanner(), new SubTypesScanner());
Reflections reflections = new Reflections(config);
Set<Class<? extends Application>> applicationClasses = reflections.getSubTypesOf(Application.class)
.stream()
.filter(this::filterClassByResourcePackages)
.collect(Collectors.toSet());
if (applicationClasses.isEmpty()) {
return null;
}
if (applicationClasses.size() > 1) {
log.warn("More than one javax.ws.rs.core.Application classes found on the classpath, skipping");
return null;
Application applicationInstance = null;
try (ScanResult scanResult = classGraph.scan()) {
ClassInfoList applicationClasses = scanResult.getSubclasses(Application.class.getName())
.filter(this::filterClassByResourcePackages);
if (applicationClasses.size() == 1) {
applicationInstance = ClassUtils.createInstance(applicationClasses.get(0).loadClass(Application.class));
} else if (applicationClasses.size() > 1) {
log.warn("More than one javax.ws.rs.core.Application classes found on the classpath, skipping");
}
}
return ClassUtils.createInstance(applicationClasses.iterator().next());
return applicationInstance;
}

Set<Class<?>> classes() {
ConfigurationBuilder config = ConfigurationBuilder
.build(resourcePackages)
.setScanners(new ResourcesScanner(), new TypeAnnotationsScanner(), new SubTypesScanner());
Reflections reflections = new Reflections(config);
Stream<Class<?>> apiClasses = reflections.getTypesAnnotatedWith(Path.class)
.stream()
.filter(this::filterClassByResourcePackages);
Stream<Class<?>> defClasses = reflections.getTypesAnnotatedWith(OpenAPIDefinition.class)
.stream()
.filter(this::filterClassByResourcePackages);
return Stream.concat(apiClasses, defClasses).collect(Collectors.toSet());
Set<Class<?>> classes;
try (ScanResult scanResult = classGraph.scan()) {
ClassInfoList apiClasses = scanResult.getClassesWithAnnotation(Path.class.getName());
ClassInfoList defClasses = scanResult.getClassesWithAnnotation(OpenAPIDefinition.class.getName());
classes = Stream.of(apiClasses, defClasses)
.flatMap(classList -> classList.filter(this::filterClassByResourcePackages).stream())
.map(ClassInfo::loadClass)
.collect(Collectors.toSet());
}
if (classes.isEmpty()) {
log.warn("No @Path or @OpenAPIDefinition annotated classes found in given resource packages: " + resourcePackages);
}
return classes;
}

private boolean filterClassByResourcePackages(Class<?> cls) {
private boolean filterClassByResourcePackages(ClassInfo cls) {
return resourcePackages.isEmpty()
|| resourcePackages.contains(cls.getPackage().getName())
|| (useResourcePackagesChildren && resourcePackages.stream().anyMatch(p -> cls.getPackage().getName().startsWith(p)));
|| resourcePackages.contains(cls.getPackageName())
|| (useResourcePackagesChildren && resourcePackages.stream().anyMatch(p -> cls.getPackageName().startsWith(p)));
}

}