tempbottle / spring-vertx-ext

A spring vertx mod which creates spring aware verticles

spring-vertx-ext

A spring vertx extension which creates spring aware verticles. This extension creates for each spring aware Verticle an own spring context. Spring Verticles can deploy "normal" Verticles and vice versa.

You should use Spring-Verticles in „worker mode“ or use vertx.executeBlocking when calling blocking methods. Avoid blocking the event loop!

##Usage:## Add the spring-vertx-ext dependency to your project, in case of maven like this:

        <dependency>
            <groupId>org.jacpfx.vertx.spring</groupId>
            <artifactId>vertx-spring-ext</artifactId>
            <version>2.0.2</version>
        </dependency>

Version 2.0.2 uses Vert.X 3.2.0 and Spring 4.2.3.RELEASE

To make a Verticle spring aware you first need a (Java) Spring configuration class like this:

@Configuration
@ComponentScan
public class TestConfiguration {
…
}

xml configuration is not supported! (you can import your xml in your java configuration)

Next you create a verticle class and annotate it with @SpringVerticle.

@Component
@SpringVerticle(springConfig=TestConfiguration.class)
public class SpringVerticle extends AbstractVerticle {
    @Inject
    private SayHelloBean bean;

    @Override
    public void start() {
       ...
    }

    @Override
    public void stop() {
       ...
    }
}

deployment

In case of using a spring-verticle as the initial verticle of your project, add the prefix "java-spring" to your vertex class.

    <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-shade-plugin</artifactId>
        <version>2.3</version>
        <executions>
            <execution>
                <phase>package</phase>
                    <goals>
                        <goal>shade</goal>
                    </goals>
                    <configuration>
                        <transformers>
                            <transformer
                                    implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
                                <manifestEntries>
                                    <Main-Class>io.vertx.core.Starter</Main-Class>
                                    <Main-Verticle>java-spring:org.jacpfx.service.SpringVerticle</Main-Verticle>
                                </manifestEntries>
                            </transformer>
                            <transformer
                                    implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">
                                <resource>META-INF/services/io.vertx.core.spi.VerticleFactory</resource>
                            </transformer>
                        </transformers>
                        <outputFile>${project.build.directory}/${artifactId}-${version}-fat.jar</outputFile>
                    </configuration>
                </execution>
            </executions>
        </plugin>

For embedded deployment use:

vertx.deployVerticle("java-spring:org.jacpfx.service.SpringVerticle");