Guice Integration for Vert.x


License

License

Categories

Categories

GUI User Interface Guice Application Layer Libs Dependency Injection
GroupId

GroupId

com.goodow.vertx
ArtifactId

ArtifactId

vertx-mod-guice
Last Version

Last Version

4.0-beta5
Release Date

Release Date

Type

Type

jar
Description

Description

Guice Integration for Vert.x
Guice Integration for Vert.x
Project URL

Project URL

https://github.com/larrytin/vertx-mod-guice
Source Code Management

Source Code Management

https://github.com/larrytin/vertx-mod-guice

Download vertx-mod-guice

How to add to project

<!-- https://jarcasting.com/artifacts/com.goodow.vertx/vertx-mod-guice/ -->
<dependency>
    <groupId>com.goodow.vertx</groupId>
    <artifactId>vertx-mod-guice</artifactId>
    <version>4.0-beta5</version>
</dependency>
// https://jarcasting.com/artifacts/com.goodow.vertx/vertx-mod-guice/
implementation 'com.goodow.vertx:vertx-mod-guice:4.0-beta5'
// https://jarcasting.com/artifacts/com.goodow.vertx/vertx-mod-guice/
implementation ("com.goodow.vertx:vertx-mod-guice:4.0-beta5")
'com.goodow.vertx:vertx-mod-guice:jar:4.0-beta5'
<dependency org="com.goodow.vertx" name="vertx-mod-guice" rev="4.0-beta5">
  <artifact name="vertx-mod-guice" type="jar" />
</dependency>
@Grapes(
@Grab(group='com.goodow.vertx', module='vertx-mod-guice', version='4.0-beta5')
)
libraryDependencies += "com.goodow.vertx" % "vertx-mod-guice" % "4.0-beta5"
[com.goodow.vertx/vertx-mod-guice "4.0-beta5"]

Dependencies

compile (3)

Group / Artifact Type Version
com.google.inject : guice jar 4.0-beta5
com.google.inject.extensions : guice-multibindings jar 4.0-beta5
com.google.guava : guava jar 18.0

provided (2)

Group / Artifact Type Version
io.vertx : vertx-core jar 2.1.5
io.vertx : vertx-platform jar 2.1.5

test (2)

Group / Artifact Type Version
junit : junit jar 4.11
io.vertx : testtools jar 2.0.3-final

Project Modules

There are no modules declared in this project.

vertx-mod-guice README Build Status

vertx-mod-guice is a Google Guice module for Vert.x. It includes everything you need to be Guicing your Vert.x like a pro in five minutes.

The easy tutorial

First, create a Guice Module that implements VertxModule

public class MyModule implements VertxModule {

    private Container container;
    private Vertx vertx;

    @Override
    public void configure(Binder binder) {
		///Do binding stuff here!
		binder.bind(MyService.class).to(MyServiceImpl.class);
    }

    @Override
    public void setContainer(Container container) {
        this.container = container;
    }

    @Override
    public void setVertx(Vertx vertx) {
        this.vertx = vertx;
    }
}

Next create your Verticle, extending GuiceVerticle. Using the @GuiceVertxBinding annotation, supply a list of all the Modules the verticle needs at runtime. Use the @Inject annotation to inject any dependencies defined in the modules. You should @Override the onStart() method to kick off any of your normal verticle activity.

@GuiceVertxBinding(modules = {MyModule.class})
public class MyVerticle extends GuiceVerticle {

    @Inject
    MyService myService;

    @Override
    public void onStart() {
       	myService.doStuff();
    }
}

Make sure that you include the name of the module in your mod.json for any module that needs to use vertx-mod-guice.

com.goodow.vertx~vertx-mod-guice~4.0-beta5

But wait, my Verticles already inherit from some other class!

Not a problem, here is an example for that case.

@GuiceVertxBinding(modules = {MyModule.class})
public class RawVerticle extends Verticle {

    @Inject
    MyService myService;

    @Override
    public void start() {
    	//Just call this firt from the start method
        GuiceVerticleHelper.inject(this, vertx, container);

		//Proceed as normal
		myService.doStuff();
    }
}

Versions

Version
4.0-beta5
1.0.0-beta4