Move the discovery of VerticleFactory implementations to the VertxBuilder bootstrap.

Motivation:

The VerticleManager discovers the list of VerticleFactory in its constructor, forcing the discovery to use Java's ServiceLoader.

This should be overridable, to let advanced Vert.x users provide their list of VerticleFactory implementation when boostrapping a Vertx instance.

Changes:

Move the discovery of VerticleFactory to VertxBuilder.

Add a list known of VerticleFactory on the VertxBuilder that is used instead of performing discovery when provided.

Author: vietj

vertx-core/src/main/java/io/vertx/core/impl/VertxBootstrapImpl.java

@@ -15,18 +15,14 @@
 import io.vertx.core.impl.transports.NioTransport;
 import io.vertx.core.internal.VertxBootstrap;
 import io.vertx.core.eventbus.impl.clustered.DefaultNodeSelector;
+import io.vertx.core.spi.*;
 import io.vertx.core.spi.context.executor.EventExecutorProvider;
 import io.vertx.core.spi.file.FileResolver;
 import io.vertx.core.file.impl.FileResolverImpl;
 import io.vertx.core.internal.logging.Logger;
 import io.vertx.core.internal.logging.LoggerFactory;
 import io.vertx.core.json.JsonObject;
 import io.vertx.core.spi.transport.Transport;
-import io.vertx.core.spi.ExecutorServiceFactory;
-import io.vertx.core.spi.VertxMetricsFactory;
-import io.vertx.core.spi.VertxServiceProvider;
-import io.vertx.core.spi.VertxThreadFactory;
-import io.vertx.core.spi.VertxTracerFactory;
 import io.vertx.core.spi.cluster.ClusterManager;
 import io.vertx.core.eventbus.impl.clustered.NodeSelector;
 import io.vertx.core.spi.metrics.VertxMetrics;
@@ -60,6 +56,7 @@ public class VertxBootstrapImpl implements VertxBootstrap {
   private VertxMetricsFactory metricsFactory;
   private VertxMetrics metrics;
   private FileResolver fileResolver;
+  private List<VerticleFactory> verticleFactories;
 
   public VertxBootstrapImpl(JsonObject config) {
     this(new VertxOptions(config));
@@ -266,7 +263,7 @@ private VertxImpl instantiateVertx(ClusterManager clusterManager, NodeSelector n
 
   public Vertx vertx() {
     VertxImpl vertx = instantiateVertx(null, null);
-    vertx.init();
+    vertx.init(verticleFactories);
     return vertx;
   }
 
@@ -282,7 +279,25 @@ public Future<Vertx> clusteredVertx() {
       nodeSelector = new DefaultNodeSelector();
     }
     VertxImpl vertx = instantiateVertx(clusterManager, nodeSelector);
-    return vertx.initClustered(options);
+    return vertx.initClustered(options, verticleFactories);
+  }
+
+  /**
+   * @return the verticle factories to use
+   */
+  public List<VerticleFactory> verticleFactories() {
+    return verticleFactories;
+  }
+
+  /**
+   * Set the list of {@code VerticleFactory} to use.
+   *
+   * @param verticleFactories the verticle factories
+   * @return the builder instance
+   */
+  public VertxBootstrapImpl verticleFactories(List<VerticleFactory> verticleFactories) {
+    this.verticleFactories = verticleFactories;
+    return this;
   }
 
   @Override
@@ -295,6 +310,7 @@ public VertxBootstrapImpl init() {
     initThreadFactory();
     initExecutorServiceFactory();
     initFileResolver();
+    initVerticleFactories();
     return this;
   }
 
@@ -352,6 +368,13 @@ private void initExecutorServiceFactory() {
     executorServiceFactory = ExecutorServiceFactory.INSTANCE;
   }
 
+  private void initVerticleFactories() {
+    if (verticleFactories != null) {
+      return;
+    }
+    verticleFactories = new ArrayList<>(ServiceHelper.loadFactories(VerticleFactory.class));
+  }
+
   private void checkBeforeInstantiating() {
     checkTracing();
     checkMetrics();

vertx-core/src/main/java/io/vertx/core/impl/VertxImpl.java

@@ -244,20 +244,22 @@ private static ThreadFactory virtualThreadFactory() {
     this.shadowContext = enableShadowContext;
   }
 
-  void init() {
+  void init(List<VerticleFactory> verticleFactories) {
     eventBus.start(Promise.promise());
     if (metrics != null) {
       metrics.vertxCreated(this);
     }
+    verticleManager.init(verticleFactories);
   }
 
-  Future<Vertx> initClustered(VertxOptions options) {
+  Future<Vertx> initClustered(VertxOptions options, List<VerticleFactory> verticleFactories) {
     nodeSelector.init(clusterManager);
     clusterManager.registrationListener(nodeSelector);
     clusterManager.init(this);
     Promise<Void> initPromise = Promise.promise();
     clusterManager.join((res, err) -> {
       if (err == null) {
+        verticleManager.init(verticleFactories);
         createHaManager(options, initPromise);
       } else {
         initPromise.fail(err);

vertx-core/src/main/java/io/vertx/core/impl/verticle/VerticleManager.java

@@ -48,12 +48,12 @@ public VerticleManager(VertxInternal vertx, Logger log, DeploymentManager deploy
     this.vertx = (VertxImpl) vertx;
     this.deploymentManager = deploymentManager;
     this.log = log;
-    loadVerticleFactories();
   }
 
-  private void loadVerticleFactories() {
-    Collection<VerticleFactory> factories = ServiceHelper.loadFactories(VerticleFactory.class);
-    factories.forEach(this::registerVerticleFactory);
+  public void init(List<VerticleFactory> factories) {
+    if (factories != null) {
+      factories.forEach(this::registerVerticleFactory);
+    }
     VerticleFactory defaultFactory = new JavaVerticleFactory();
     defaultFactory.init(vertx);
     defaultFactories.add(defaultFactory);

vertx-core/src/main/java/io/vertx/core/internal/VertxBootstrap.java

@@ -174,6 +174,19 @@ static VertxBootstrap create() {
    */
   VertxBootstrap clusterManager(ClusterManager clusterManager);
 
+  /**
+   * @return the verticle factories to use
+   */
+  List<VerticleFactory> verticleFactories();
+
+  /**
+   * Set the list of {@code VerticleFactory} to use.
+   *
+   * @param verticleFactories the verticle factories
+   * @return the builder instance
+   */
+  VertxBootstrap verticleFactories(List<VerticleFactory> verticleFactories);
+
   /**
    *
    * Initialize the service providers.