README.md

Vert.x Spring Verticle Factory

An implementation of a Vert.x Verticle Factory where the verticles are obtained via a Spring Application Context. The verticles must exist as Spring Beans whose bean scope must be PROTOTYPE. The verticles are free to use all the Spring-provided capabilities to set themselves up. This factory's createVerticle method can be considered slow, hence blockingCreate() returns true.

This implementation relies on setting a Spring Application Context (using com.chibchasoft.vertx.spring.ApplicationContextProvider) before Vert.x Verticles are deployed. The prefix for this verticle is "spring:" and the verticle name is the spring bean id/name assigned to such verticle.

Usage:

Vert.x Spring Verticle Factory is published to the maven public repo.

Add the vertx-spring-verticle-factory dependency to your project, in case of maven like this:

        <dependency>
            <groupId>com.chibchasoft</groupId>
            <artifactId>vertx-spring-verticle-factory</artifactId>
            <version>VERSION</version>
        </dependency>

where VERSION is

Then create a Spring Application Context (either using an XML or annotation approach) and assign it to the ApplicationContextProvider:

   ApplicationContext appCtx = new AnnotationConfigApplicationContext(AnnotatedSpringConfiguration.class);
   ApplicationContextProvider.setApplicationContext(appCtx);

Proceed to deploy the spring-bean-based verticle like this:

   Vertx vertx = Vertx.vertx();
   vertx.deployVerticle("spring:mySpringVerticle", new DeploymentOptions().setInstances(2).setWorker(true));

NOTE: The Spring Application Context set in the ApplicationContextProvider is used for all the verticles created using the Spring Verticle Factory up to the point where it is changed. Once changed, the Spring Verticle Factory will use the new one when creating new verticles.

The verticle class itself can use any Spring capabilities, for example:

@Component("mySpringVerticle")
@Scope(ConfigurableBeanFactory.SCOPE_PROTOTYPE)
public class MySpringVerticle extends AbstractVerticle {
  @Value("${my.property}")
  private String theProperty;

  @Inject
  private MyService myService;

  @PostConstruct
  public void init() {
     System.out.println("Perform initialization in here");
  }
}