vertk

Vertxk is a set of tools to simplify Vertx application development in Kotlin Programming Language

VertxK: Dependency injection with Kodein

Kodein is a simple, easy to use and easy to configure dependency retrieval container.

By default, Vertx does not provide any real support for dependency injection framerworks.

Vertxk solves this issue enabling simple DI in Vertx Verticles through Kodein.

BTW, it works with coroutines too!

Some Features

• Only 20Kb
• No external dependencies (well... it requires Vertx and Kodein of course!)
• Works with Vertx 3.5+ and Kodein 4.1+

Getting Started

1. To get started, add vertk-kodein dependency to your project:

        <dependency>
            <groupId>com.ufoscout.vertk</groupId>
            <artifactId>vertk-kodein</artifactId>
            <version>${vertk.version}</version>
        </dependency>

2. Inject the VertxkKodein Module in your Kodein Container:

import com.github.salomonbrys.kodein.Kodein
import com.github.salomonbrys.kodein.jxinject.jxInjectorModule
import com.ufoscout.vertk.VertxkKodein
...

        // setup vertk
        val vertk = Vertx.vertx()

        val kodein = Kodein {
            import(jxInjectorModule)
            import(VertxkKodein.module(vertk))
            import(// IMPORT YOUR MODULES)
        }

        VertxkKodein.registerFactory(vertk, kodein)

        awaitResult<String> {
            VertxkKodein.deployVerticle<MainVerticle>(vertk, it)
        }

3. Register vertk Factory in Vertx:

        VertxkKodein.registerFactory(vertk, kodein)

4. Everything's ready now! You can now inject whatever bean in your Verticles:

// In this example I use a Coroutine based Verticle. 
// It works with standard verticles too.
// WARN: To use the coroutines you need to import the vertk-lang-kotlin-coroutines dependency
class MyVerticle (val myServiceOne: MyServiceOne, val myServiceTwo: MyServiceTwo) : CoroutineVerticle() {

    override suspend fun start() {
        println("Start main verticle with injected services!!!!")
    }

} 

5. Deploy your verticles and have fun :)

    // With coroutines. it works even with default async deploy.   
    awaitResult<String> {
        VertxkKodein.deployVerticle<MyVerticle>(vertk, it)
    }

The complete example

Let's put all together.

Creata a Verticle and inject your services:

class MyVerticle (val myServiceOne: MyServiceOne, val myServiceTwo: MyServiceTwo) : CoroutineVerticle() {

    override suspend fun start() {
        println("Start main verticle with injected services!!!!")
    }

} 

Instantiate Vertx and Kodein:

        val vertk = Vertx.vertx()

        val kodein = Kodein {
            import(jxInjectorModule)
            import(VertxkKodein.module(vertk))
            import(// IMPORT YOUR MODULES)
        }

        VertxkKodein.registerFactory(vertk, kodein)

        awaitResult<String> {
            VertxkKodein.deployVerticle<MyVerticle>(vertk, it)
        }

Cheers.

A complete working exmple can be found at https://github.com/ufoscout/kotlin-vertk3