fix(cli): Replace org.reflections with com.google.auto.service:auto-s…

…ervice-annotations No classpath scanning. Standard Java ServiceLoader used.
olivergondza · Sep 13, 2024 · 8184afe · 8184afe
1 parent 7f27692
commit 8184afe
Show file tree

Hide file tree

Showing 14 changed files with 50 additions and 65 deletions.
diff --git a/cli/pom.xml b/cli/pom.xml
@@ -27,20 +27,11 @@
       <scope>test</scope>
     </dependency>
 
+    <!-- Discover implementations dynamically -->
     <dependency>
-      <groupId>org.reflections</groupId>
-      <artifactId>reflections</artifactId>
-      <version>0.10.2</version>
-      <exclusions>
-        <exclusion>
-          <groupId>com.google.code.findbugs</groupId>
-          <artifactId>annotations</artifactId>
-        </exclusion>
-        <exclusion>
-          <groupId>org.slf4j</groupId>
-          <artifactId>slf4j-api</artifactId>
-        </exclusion>
-      </exclusions>
+      <groupId>com.google.auto.service</groupId>
+      <artifactId>auto-service-annotations</artifactId>
+      <version>1.0.1</version>
     </dependency>
 
     <dependency>
@@ -115,6 +106,19 @@
           </execution>
         </executions>
       </plugin>
+
+      <plugin>
+        <artifactId>maven-compiler-plugin</artifactId>
+        <configuration>
+          <annotationProcessorPaths>
+            <path>
+              <groupId>com.google.auto.service</groupId>
+              <artifactId>auto-service</artifactId>
+              <version>1.0.1</version>
+            </path>
+          </annotationProcessorPaths>
+        </configuration>
+      </plugin>
     </plugins>
   </build>
 </project>
diff --git a/cli/src/main/java/com/github/olivergondza/dumpling/cli/CliCommand.java b/cli/src/main/java/com/github/olivergondza/dumpling/cli/CliCommand.java
@@ -27,7 +27,6 @@
 
 import org.kohsuke.args4j.CmdLineException;
 
-
 /**
  * CLI handler, usually a query invoker.
  *

diff --git a/cli/src/main/java/com/github/olivergondza/dumpling/cli/CliCommandOptionHandler.java b/cli/src/main/java/com/github/olivergondza/dumpling/cli/CliCommandOptionHandler.java
@@ -24,6 +24,7 @@
 package com.github.olivergondza.dumpling.cli;
 
 import java.util.HashSet;
+import java.util.ServiceLoader;
 import java.util.Set;
 
 import javax.annotation.CheckForNull;
@@ -35,7 +36,6 @@
 import org.kohsuke.args4j.spi.OptionHandler;
 import org.kohsuke.args4j.spi.Parameters;
 import org.kohsuke.args4j.spi.Setter;
-import org.reflections.Reflections;
 
 public class CliCommandOptionHandler extends OptionHandler<CliCommand> {
 
@@ -88,27 +88,10 @@ public String getDefaultMetaVariable() {
     }
 
     /*package*/ static @Nonnull Set<? extends CliCommand> getAllHandlers() {
-        Reflections reflections = new Reflections("com.github.olivergondza.dumpling");
-        final Set<Class<? extends CliCommand>> types = reflections.getSubTypesOf(CliCommand.class);
-
-        final Set<CliCommand> handlers = new HashSet<CliCommand>();
-        for (Class<? extends CliCommand> type: types) {
-            try {
-
-                handlers.add(type.newInstance());
-            } catch (InstantiationException ex) {
-
-                AssertionError e = new AssertionError("Cli command " + type.getName() + " does not declare default contructor");
-                e.initCause(ex);
-                throw e;
-            } catch (IllegalAccessException ex) {
-
-                AssertionError e = new AssertionError("Cli command " + type.getName() + " does not declare default contructor");
-                e.initCause(ex);
-                throw e;
-            }
+        final Set<CliCommand> handlers = new HashSet<>();
+        for (CliCommand cliCommand : ServiceLoader.load(CliCommand.class)) {
+            handlers.add(cliCommand);
         }
-
         return handlers;
     }
 }
diff --git a/cli/src/main/java/com/github/olivergondza/dumpling/cli/Factories.java b/cli/src/main/java/com/github/olivergondza/dumpling/cli/Factories.java
@@ -35,9 +35,11 @@
 import com.github.olivergondza.dumpling.factory.ThreadDumpFactory;
 import com.github.olivergondza.dumpling.model.dump.ThreadDumpRuntime;
 import com.github.olivergondza.dumpling.model.jmx.JmxRuntime;
+import com.google.auto.service.AutoService;
 
 final /*package*/ class Factories {
 
+    @AutoService(CliRuntimeFactory.class)
     static final class ThreadDump implements CliRuntimeFactory<ThreadDumpRuntime> {
         @Override
         public @Nonnull String getKind() {
@@ -69,6 +71,7 @@ public String getDescription() {
         }
     }
 
+    @AutoService(CliRuntimeFactory.class)
     static final class Jmx implements CliRuntimeFactory<JmxRuntime> {
         @Override
         public @Nonnull String getKind() {
@@ -93,6 +96,7 @@ public String getDescription() {
         }
     }
 
+    @AutoService(CliRuntimeFactory.class)
     static final class Pid implements CliRuntimeFactory<ThreadDumpRuntime> {
 
         @Override

diff --git a/cli/src/main/java/com/github/olivergondza/dumpling/cli/GrepCommand.java b/cli/src/main/java/com/github/olivergondza/dumpling/cli/GrepCommand.java
@@ -23,6 +23,7 @@
  */
 package com.github.olivergondza.dumpling.cli;
 
+import com.google.auto.service.AutoService;
 import groovy.lang.Binding;
 import groovy.lang.GroovyShell;
 
@@ -40,6 +41,7 @@
 
 import javax.annotation.Nonnull;
 
+@AutoService(CliCommand.class)
 public class GrepCommand implements CliCommand {
 
     private static final InterpretterConfig CONFIG = new InterpretterConfig();

diff --git a/cli/src/main/java/com/github/olivergondza/dumpling/cli/GroovyCommand.java b/cli/src/main/java/com/github/olivergondza/dumpling/cli/GroovyCommand.java
@@ -23,6 +23,7 @@
  */
 package com.github.olivergondza.dumpling.cli;
 
+import com.google.auto.service.AutoService;
 import groovy.lang.Binding;
 import groovy.lang.GroovyShell;
 
@@ -53,6 +54,7 @@
  *
  * @author ogondza
  */
+@AutoService(CliCommand.class)
 public class GroovyCommand implements CliCommand {
 
     private static final InterpretterConfig CONFIG = new InterpretterConfig();

diff --git a/cli/src/main/java/com/github/olivergondza/dumpling/cli/GroovyshCommand.java b/cli/src/main/java/com/github/olivergondza/dumpling/cli/GroovyshCommand.java
@@ -31,6 +31,7 @@
 
 import javax.annotation.Nonnull;
 
+import com.google.auto.service.AutoService;
 import org.codehaus.groovy.tools.shell.Groovysh;
 import org.codehaus.groovy.tools.shell.IO;
 import org.kohsuke.args4j.Argument;
@@ -47,6 +48,7 @@
  *
  * @author ogondza
  */
+@AutoService(CliCommand.class)
 public class GroovyshCommand implements CliCommand {
 
     private static final InterpretterConfig CONFIG = new InterpretterConfig();

diff --git a/cli/src/main/java/com/github/olivergondza/dumpling/cli/HelpCommand.java b/cli/src/main/java/com/github/olivergondza/dumpling/cli/HelpCommand.java
@@ -32,10 +32,12 @@
 
 import javax.annotation.Nonnull;
 
+import com.google.auto.service.AutoService;
 import org.kohsuke.args4j.Argument;
 import org.kohsuke.args4j.CmdLineException;
 import org.kohsuke.args4j.CmdLineParser;
 
+@AutoService(CliCommand.class)
 public class HelpCommand implements CliCommand {
 
     @Argument(usage = "Print detailed usage", metaVar = "COMMAND")

diff --git a/cli/src/main/java/com/github/olivergondza/dumpling/cli/Main.java b/cli/src/main/java/com/github/olivergondza/dumpling/cli/Main.java
@@ -26,7 +26,9 @@
 import java.io.File;
 import java.util.ArrayList;
 import java.util.List;
+import java.util.ServiceLoader;
 import java.util.Set;
+import java.util.stream.Collectors;
 
 import javax.annotation.CheckForNull;
 import javax.annotation.Nonnull;
@@ -39,7 +41,6 @@
 import org.kohsuke.args4j.spi.OptionHandler;
 import org.kohsuke.args4j.spi.Parameters;
 import org.kohsuke.args4j.spi.Setter;
-import org.reflections.Reflections;
 
 import com.github.olivergondza.dumpling.model.ProcessRuntime;
 
@@ -156,44 +157,20 @@ public String getDefaultMetaVariable() {
         }
 
         /*package*/ static @Nonnull List<CliRuntimeFactory<?>> getFactories() {
-            List<CliRuntimeFactory<?>> factories = new ArrayList<CliRuntimeFactory<?>>();
-            for (Class<? extends CliRuntimeFactory<?>> type: factoryTypes()) {
-                factories.add(instantiateFactory(type));
+            List<CliRuntimeFactory<?>> out = new ArrayList<>();
+            for (CliRuntimeFactory<?> cliRuntimeFactory : ServiceLoader.load(CliRuntimeFactory.class)) {
+                out.add(cliRuntimeFactory);
             }
-            return factories;
+            return out;
         }
 
         public static @CheckForNull CliRuntimeFactory<?> getFactory(String name) {
-            for (Class<? extends CliRuntimeFactory<?>> type: factoryTypes()) {
-                CliRuntimeFactory<?> factory = instantiateFactory(type);
+            for (CliRuntimeFactory<?> factory : getFactories()) {
                 if (name.equals(factory.getKind())) return factory;
             }
-
             return null;
         }
 
-        @SuppressWarnings({"rawtypes", "unchecked"})
-        private static Set<Class<? extends CliRuntimeFactory<?>>> factoryTypes() {
-            return (Set) new Reflections("com.github.olivergondza.dumpling").getSubTypesOf(CliRuntimeFactory.class);
-        }
-
-        private static CliRuntimeFactory<?> instantiateFactory(Class<? extends CliRuntimeFactory<?>> type) {
-            try {
-
-                return type.newInstance();
-            } catch (InstantiationException ex) {
-
-                AssertionError e = new AssertionError("Cli handler " + type.getName() + " does not declare default constructor");
-                e.initCause(ex);
-                throw e;
-            } catch (IllegalAccessException ex) {
-
-                AssertionError e = new AssertionError("Cli handler " + type.getName() + " does not declare default constructor");
-                e.initCause(ex);
-                throw e;
-            }
-        }
-
         /*package*/ static final class UnknownRuntimeKind extends CmdLineException {
 
             public UnknownRuntimeKind(CmdLineParser owner, String message) {

diff --git a/cli/src/main/java/com/github/olivergondza/dumpling/cli/SampleCommand.java b/cli/src/main/java/com/github/olivergondza/dumpling/cli/SampleCommand.java
@@ -23,6 +23,7 @@
  */
 package com.github.olivergondza.dumpling.cli;
 
+import com.google.auto.service.AutoService;
 import org.kohsuke.args4j.Argument;
 import org.kohsuke.args4j.CmdLineException;
 import org.kohsuke.args4j.Option;
@@ -40,6 +41,7 @@
 /**
  * @author ogondza.
  */
+@AutoService(CliCommand.class)
 public class SampleCommand implements CliCommand {
 
     private int number = -1;

diff --git a/cli/src/main/java/com/github/olivergondza/dumpling/cli/ThreaddumpCommand.java b/cli/src/main/java/com/github/olivergondza/dumpling/cli/ThreaddumpCommand.java
@@ -23,6 +23,7 @@
  */
 package com.github.olivergondza.dumpling.cli;
 
+import com.google.auto.service.AutoService;
 import org.kohsuke.args4j.CmdLineException;
 import org.kohsuke.args4j.Option;
 
@@ -36,6 +37,7 @@
  *
  * @author ogondza
  */
+@AutoService(CliCommand.class)
 public class ThreaddumpCommand implements CliCommand {
 
     @Option(name = "-i", aliases = {"--in"}, usage = "Input for process runtime")

diff --git a/cli/src/main/java/com/github/olivergondza/dumpling/query/BlockingTreeCommand.java b/cli/src/main/java/com/github/olivergondza/dumpling/query/BlockingTreeCommand.java
@@ -25,6 +25,7 @@
 
 import javax.annotation.Nonnull;
 
+import com.google.auto.service.AutoService;
 import org.kohsuke.args4j.CmdLineException;
 import org.kohsuke.args4j.Option;
 
@@ -33,6 +34,7 @@
 import com.github.olivergondza.dumpling.model.ProcessRuntime;
 import com.github.olivergondza.dumpling.query.BlockingTree.Result;
 
+@AutoService(CliCommand.class)
 public final class BlockingTreeCommand implements CliCommand {
 
     @Option(name = "-i", aliases = {"--in"}, required = true, usage = "Input for process runtime")

diff --git a/cli/src/main/java/com/github/olivergondza/dumpling/query/DeadlocksCommand.java b/cli/src/main/java/com/github/olivergondza/dumpling/query/DeadlocksCommand.java
@@ -25,6 +25,7 @@
 
 import javax.annotation.Nonnull;
 
+import com.google.auto.service.AutoService;
 import org.kohsuke.args4j.CmdLineException;
 import org.kohsuke.args4j.Option;
 
@@ -33,6 +34,7 @@
 import com.github.olivergondza.dumpling.model.ProcessRuntime;
 import com.github.olivergondza.dumpling.query.Deadlocks.Result;
 
+@AutoService(CliCommand.class)
 public final class DeadlocksCommand implements CliCommand {
 
     @Option(name = "-i", aliases = {"--in"}, required = true, usage = "Input for process runtime")

diff --git a/cli/src/main/java/com/github/olivergondza/dumpling/query/TopContendersCommand.java b/cli/src/main/java/com/github/olivergondza/dumpling/query/TopContendersCommand.java
@@ -25,6 +25,7 @@
 
 import javax.annotation.Nonnull;
 
+import com.google.auto.service.AutoService;
 import org.kohsuke.args4j.CmdLineException;
 import org.kohsuke.args4j.Option;
 
@@ -33,6 +34,7 @@
 import com.github.olivergondza.dumpling.model.ProcessRuntime;
 import com.github.olivergondza.dumpling.query.TopContenders.Result;
 
+@AutoService(CliCommand.class)
 public final class TopContendersCommand implements CliCommand {
 
     @Option(name = "-i", aliases = {"--in"}, required = true, usage = "Input for process runtime")
-Original file line number
+Diff line change
@@ Expand Up / @@ -27,7 +27,6 @@ @@
     import org.kohsuke.args4j.CmdLineException;
     /**
      * CLI handler, usually a query invoker.
      *
@@ Expand Down @@