Jooby

Jooby is a scalable, fast and modular micro web framework for Java and Kotlin. It is very easy to use and has a lot of different, ready to use modules.

Build configuration

Kilua RPC provides two different modules for Jooby:

• kilua-rpc-jooby, which doesn't use dependency injection (DI) and requires manual services registration,

• kilua-rpc-jooby-koin, which uses Koin dependency injection framework to access services implementations.

You need to add one of these modules to your project.

val commonMain by getting {
    dependencies {
        implementation("dev.kilua:kilua-rpc-jooby:$kiluaRpcVersion")
//        implementation("dev.kilua:kilua-rpc-jooby-koin:$kiluaRpcVersion")
    }
}

Service implementation

Service class

The implementation of the service class comes down to implementing required interface methods.

class AddressService : IAddressService {
    override suspend fun getAddressList(search: String?, sort: Sort) {
        return listOf()
    }
    override suspend fun addAddress(address: Address) {
        return Address()
    }
    override suspend fun updateAddress(id: Int, address: Address) {
        return Address()
    }
    override suspend fun deleteAddress(id: Int) {
        return false
    }
}

You can use @Factory annotation, if you use Koin and koin-annotations to configure dependency injection.

@Factory
class AddressService : IAddressService {
    // ...
}

Injecting server objects

You can use constructor parameters to inject server objects - Context and Kooby into your service classes. These objects give you access to the application configuration, its state, the current request and the user session.

class AddressService(val ctx: Context, val kooby: Kooby) : IAddressService {
    override suspend fun getAddressList(search: String?, sort: Sort) {
        println(kooby.config.getString("option1") ?: "default")
        println(ctx.remoteAddress)
        println(ctx.session().id)
        return listOf()
    }
}

Blocking code

Since Jooby execution model assumes suspending endpoints are non-blocking, you should never block a thread in your application code. If you have to use some blocking code (e.g. blocking I/O, JDBC) always use the dedicated coroutine dispatcher.

class AddressService : IAddressService {
    override suspend fun getAddressList(search: String?, sort: Sort) {
        return withContext(Dispatchers.IO) {
            retrieveAddressesFromDatabase(search, sort)
        }
    }
}

Application configuration

The main function

This function is the application starting point. It's used to initialize and configure application modules and features. Minimal implementation for Kilua RPC integration contains initRpc and applyRoutes function calls.

When using manual service registration, you call initRpc with a lambda function, which binds interfaces with their implementations. Different overloads of registerService function allow injecting server objects into your service classes.

import dev.kilua.rpc.applyRoutes
import dev.kilua.rpc.getServiceManager
import dev.kilua.rpc.initRpc
import dev.kilua.rpc.registerService
import io.jooby.kt.runApp

fun main(args: Array<String>) {
    runApp(args) {
        initRpc {
            registerService<IAddressService> { AddressService() }
//            registerService<IAddressService> { ctx -> AddressService(ctx) }
//            registerService<IAddressService> { ctx, kooby -> AddressService(ctx, kooby) }
        }
        applyRoutes(getServiceManager<IAddressService>())
    }
}

When using Koin, you call initRpc with a list of Koin modules. Constructor parameter injection is automatically supported by Koin.

import dev.kilua.rpc.applyRoutes
import dev.kilua.rpc.getServiceManager
import dev.kilua.rpc.initRpc
import io.jooby.kt.runApp
import org.koin.core.annotation.ComponentScan
import org.koin.core.annotation.Module
import org.koin.ksp.generated.module

@Module
@ComponentScan
class AddressModule

// val addressModule = module {             // manual Koin module declaration
//    factoryOf(::AddressService)
// }

fun main(args: Array<String>) {
    runApp(args) {
        initRpc(AddressModule().module)
        routing {
            applyRoutes(getServiceManager<IAddressService>())
        }
    }
}

Security with Pac4j

You can use Pac4j security module to configure authentication and authorization in your app. By calling applyRoutes function before or after Pac4j module declaration, you apply different security requirements to different services.

fun main(args: Array<String>) {
    runApp(args) {
        initRpc {
            // ...
        }
        applyRoutes(getServiceManager<IRegisterProfileService>()) // No authentication needed
        val config = org.pac4j.core.config.Config()
        config.addAuthorizer("Authorizer") { _, _, _ -> true }
        install(Pac4jModule(Pac4jOptions().apply {
            defaultUrl = "/"
        }, config).client("*", "Authorizer") { _ ->
            FormClient("/") { credentials, context, sessionStore ->
            }
        })
        applyRoutes(getServiceManager<IAddressService>())    // Authentication needed
        applyRoutes(getServiceManager<IProfileService>())    // Authentication needed
    }
}