Skip to content

[Quick Start] Building QBit the microservice lib for Java

Jump to bottom Edit New page
Richard Hightower edited this page Mar 9, 2015 · 3 revisions

##Overview QBit is a queuing library for [microservices. ] (http://www.brunton-spall.co.uk/post/2014/05/21/what-is-a-microservice-and-why-does-it-matter/) It is similar to many other projects. QBit is just a library not a platform. QBit has libraries to put a service behind a queue. You can use QBit queues directly or you can create a service. A service is a Java class whose methods are executed via queues. QBit implements apartment model threading and is similar to the Actor. QBit does not use a disruptor. It uses regular Java Queues. QBit can do 100 million ping pong calls per second which is an amazing speed. QBit also supports calling services via REST, and WebSocket.

Building QBit.

This Wiki will walk through the process of building the QBit framework on your machine.

##What you will build You will build this very powerful and fast framework called QBit using gradle. ##How to complete this guide In order to complete this guide successfully you will need the following installed on your machine:

Now that your machine is all ready let's get started:

git clone https://github.com/fadihub/qbit.git

cd into ~/qbit then run the following:

gradle clean build install

This will take a few minutes especially if you are using gradle for the first time.

####build.gradle Listing

~/qbit/build.gradle/

allprojects {

    group = 'io.advantageous.qbit'
    apply plugin: 'idea'
    apply plugin: 'java'
    apply plugin: 'maven'
    apply plugin: 'application'

    version = '0.6.1'
}


subprojects {

    repositories {
        mavenLocal()
        mavenCentral()
    }

    sourceCompatibility = JavaVersion.VERSION_1_8
    targetCompatibility = JavaVersion.VERSION_1_8


    task buildDockerfile (type: Dockerfile) {
        dependsOn distTar
        from "java:openjdk-8"
        add "$distTar.archivePath", "/"
        workdir "/$distTar.archivePath.name" - ".$distTar.extension" + "/bin"
        entrypoint "./$project.name"
    }

    task buildDockerImage (type: Exec) {
        dependsOn buildDockerfile
        commandLine "docker", "build", "-t", "$project.group/$project.name:$version", buildDockerfile.dockerDir
    }


    task runDockerImage (type: Exec) {
        dependsOn buildDockerImage
        commandLine "docker", "run", "-t", "$project.group/$project.name:$version", buildDockerfile.dockerDir
    }


    task dockerRun (type: Exec) {
        commandLine "docker", "run", '-m="4g"', "-t", "$project.group/$project.name:$version", buildDockerfile.dockerDir
    }
}

project(':qbit-core') {

    apply plugin: 'signing'

    dependencies {
        testCompile group: 'junit', name: 'junit', version: '4.10'
        compile group: 'io.fastjson', name: 'boon', version: '0.31-SNAPSHOT'
        compile "org.slf4j:slf4j-api:[1.7,1.8)"
        testCompile 'ch.qos.logback:logback-classic:1.1.2'
    }

    task javadocJar(type: Jar, dependsOn: javadoc) {
        classifier = 'javadoc'
        from 'build/docs/javadoc'
    }

    task sourcesJar(type: Jar) {
        from sourceSets.main.allSource
        classifier = 'sources'
    }

    artifacts {
        archives jar
        archives javadocJar
        archives sourcesJar
    }

    signing {
        required false
        sign configurations.archives
    }

    uploadArchives {
        repositories {
            mavenDeployer {
                beforeDeployment { MavenDeployment deployment -> signing.signPom(deployment) }

                repository(url: "https://oss.sonatype.org/service/local/staging/deploy/maven2/") {
                    try {
                        authentication(userName: sonatypeUsername, password: sonatypePassword)
                    } catch (MissingPropertyException ignore) {
                    }
                }

                pom.project {
                    name 'qbit-core'
                    packaging 'jar'
                    description 'Go Channels inspired Java lib'
                    url 'https://github.com/advantageous/qbit'

                    scm {
                        url 'scm:[email protected]:advantageous/qbit.git'
                        connection 'scm:[email protected]:advantageous/qbit.git'
                        developerConnection 'scm:[email protected]:advantageous/qbit.git'
                    }

                    licenses {
                        license {
                            name 'The Apache Software License, Version 2.0'
                            url 'http://www.apache.org/licenses/LICENSE-2.0.txt'
                            distribution 'repo'
                        }
                    }

                    developers {
                        developer {
                            id 'richardHightower'
                            name 'Richard Hightower'
                        }
                        developer {
                            id 'sailorgeoffrey'
                            name 'Geoffrey Chandler'
                        }
                    }
                }
            }
        }
    }
}

project(':qbit-boon') {

    apply plugin: 'signing'

    sourceSets.main.resources.srcDir 'src/main/java'
    dependencies {
        compile project(':qbit-core')
        compile group: 'io.fastjson', name: 'boon', version: '0.31-SNAPSHOT'
        compile "org.slf4j:slf4j-api:[1.7,1.8)"
        testCompile 'ch.qos.logback:logback-classic:1.1.2'
        testCompile group: 'junit', name: 'junit', version: '4.10'
    }

    task javadocJar(type: Jar, dependsOn: javadoc) {
        classifier = 'javadoc'
        from 'build/docs/javadoc'
    }

    task sourcesJar(type: Jar) {
        from sourceSets.main.allSource
        classifier = 'sources'
    }

    artifacts {
        archives jar
        archives javadocJar
        archives sourcesJar
    }

    signing {
        required false
        sign configurations.archives
    }

    uploadArchives {
        repositories {
            mavenDeployer {
                beforeDeployment { MavenDeployment deployment -> signing.signPom(deployment) }

                repository(url: "https://oss.sonatype.org/service/local/staging/deploy/maven2/") {
                    try {
                        authentication(userName: sonatypeUsername, password: sonatypePassword)
                    } catch (MissingPropertyException ignore) {
                    }
                }

                pom.project {
                    name 'qbit-boon'
                    packaging 'jar'
                    description 'Go Channels inspired Java lib'
                    url 'https://github.com/advantageous/qbit'

                    scm {
                        url 'scm:[email protected]:advantageous/qbit.git'
                        connection 'scm:[email protected]:advantageous/qbit.git'
                        developerConnection 'scm:[email protected]:advantageous/qbit.git'
                    }

                    licenses {
                        license {
                            name 'The Apache Software License, Version 2.0'
                            url 'http://www.apache.org/licenses/LICENSE-2.0.txt'
                            distribution 'repo'
                        }
                    }

                    developers {
                        developer {
                            id 'richardHightower'
                            name 'Richard Hightower'
                        }
                        developer {
                            id 'sailorgeoffrey'
                            name 'Geoffrey Chandler'
                        }
                    }
                }
            }
        }
    }
}

project(':qbit-examples-standalone') {
    sourceSets.main.resources.srcDir 'src/main/java'
    dependencies {
        compile project(':qbit-vertx')
        compile "org.slf4j:slf4j-api:[1.7,1.8)"
        compile 'ch.qos.logback:logback-classic:1.1.2'

        testCompile group: 'junit', name: 'junit', version: '4.10'
    }
}


project(':qbit-perf-client') {
    sourceSets.main.resources.srcDir 'src/main/java'
    apply plugin:'application'

    /*
    You can run this by doing this: gradle run -PappArgs="['localhost', 8080]"
     */

    mainClassName = "io.advantageous.qbit.vertx.http.PerfClientTest"

    run {
        if ( project.hasProperty("appArgs") ) {
            args Eval.me(appArgs)
        }
    }


    dependencies {
        compile project(':qbit-vertx')
        compile project(':qbit-boon')
        compile group: 'io.fastjson', name: 'boon', version: '0.31-SNAPSHOT'
        compile "org.slf4j:slf4j-api:[1.7,1.8)"
        compile 'ch.qos.logback:logback-classic:1.1.2'

        testCompile group: 'junit', name: 'junit', version: '4.10'
    }

}


project(':qbit-perf-server') {
    sourceSets.main.resources.srcDir 'src/main/java'
    apply plugin:'application'

    /*
    You can run this by doing this: gradle run -PappArgs="['localhost', 8080]"
     */

    mainClassName = "io.advantageous.qbit.vertx.http.PerfClientTest"

    run {
        if ( project.hasProperty("appArgs") ) {
            args Eval.me(appArgs)
        }
    }

    mainClassName = "io.advantageous.qbit.vertx.http.PerfServerTest"

    dependencies {
        compile project(':qbit-vertx')

        compile project(':qbit-boon')
        compile "org.slf4j:slf4j-api:[1.7,1.8)"
        compile 'ch.qos.logback:logback-classic:1.1.2'

        testCompile group: 'junit', name: 'junit', version: '4.10'
    }

}




project(':qbit-sample-server') {

    apply plugin:'application'


    sourceSets.main.resources.srcDir 'src/main/java'

    mainClassName = "io.advantageous.qbit.sample.server.TodoServerMain"

    dependencies {
        compile project(':qbit-boon')
        compile project(':qbit-sample-model')
        compile project(':qbit-vertx')
        compile "org.slf4j:slf4j-api:[1.7,1.8)"
        compile 'ch.qos.logback:logback-classic:1.1.2'

        testCompile group: 'junit', name: 'junit', version: '4.10'
    }


    buildDockerfile {
        expose 8080
    }
}

project(':qbit-sample-client') {
    sourceSets.main.resources.srcDir 'src/main/java'
    apply plugin:'application'

    mainClassName = "io.advantageous.qbit.sample.server.TodoClientMain"

    dependencies {
        compile project(':qbit-boon')
        compile project(':qbit-sample-model')
        compile "org.slf4j:slf4j-api:[1.7,1.8)"
        compile 'ch.qos.logback:logback-classic:1.1.2'

        testCompile group: 'junit', name: 'junit', version: '4.10'
    }


    buildDockerfile {
        expose 7070
    }
}


project(':qbit-sample-model') {
    sourceSets.main.resources.srcDir 'src/main/java'
    dependencies {
        compile project(':qbit-boon')
        compile project(':qbit-vertx')
        compile "org.slf4j:slf4j-api:[1.7,1.8)"
        compile 'ch.qos.logback:logback-classic:1.1.2'
        testCompile group: 'junit', name: 'junit', version: '4.10'
    }
}

project(':qbit-vertx') {

    apply plugin: 'signing'

    task javadocJar(type: Jar, dependsOn: javadoc) {
        classifier = 'javadoc'
        from 'build/docs/javadoc'
    }

    task sourcesJar(type: Jar) {
        from sourceSets.main.allSource
        classifier = 'sources'
    }

    artifacts {
        archives jar
        archives javadocJar
        archives sourcesJar
    }

    signing {
        required false
        sign configurations.archives
    }

    jar {
        manifest {
            attributes 'Main-Class': 'io.rd.cognizance.example.SampleService'
        }
        from { configurations.compile.collect { it.isDirectory() ? it : zipTree(it) } }
    }
    sourceSets.main.resources.srcDir 'src/main/java'
    dependencies {
        compile project(':qbit-core')
        compile project(':qbit-boon')
        compile group: 'io.vertx', name: 'vertx-core', version: vertxVersion
        compile group: 'io.vertx', name: 'vertx-platform', version: vertxVersion
        compile group: 'io.vertx', name: 'lang-groovy', version: vertxVersion
        compile "org.slf4j:slf4j-api:[1.7,1.8)"
        testCompile 'ch.qos.logback:logback-classic:1.1.2'

        testCompile group: 'junit', name: 'junit', version: '4.10'

    }

    uploadArchives {
        repositories {
            mavenDeployer {
                beforeDeployment { MavenDeployment deployment -> signing.signPom(deployment) }

                repository(url: "https://oss.sonatype.org/service/local/staging/deploy/maven2/") {
                    try {
                        authentication(userName: sonatypeUsername, password: sonatypePassword)
                    } catch (MissingPropertyException ignore) {
                    }
                }

                pom.project {
                    name 'qbit-vertx'
                    packaging 'jar'
                    description 'Go Channels inspired Java lib'
                    url 'https://github.com/advantageous/qbit'

                    scm {
                        url 'scm:[email protected]:advantageous/qbit.git'
                        connection 'scm:[email protected]:advantageous/qbit.git'
                        developerConnection 'scm:[email protected]:advantageous/qbit.git'
                    }

                    licenses {
                        license {
                            name 'The Apache Software License, Version 2.0'
                            url 'http://www.apache.org/licenses/LICENSE-2.0.txt'
                            distribution 'repo'
                        }
                    }

                    developers {
                        developer {
                            id 'richardHightower'
                            name 'Richard Hightower'
                        }
                        developer {
                            id 'sailorgeoffrey'
                            name 'Geoffrey Chandler'
                        }
                    }
                }
            }
        }
    }
}




class Dockerfile extends DefaultTask {
    def dockerfileInfo = ""
    def dockerDir = "$project.buildDir/docker"
    def dockerfileDestination = "$project.buildDir/docker/Dockerfile"
    def filesToCopy = []

    File getDockerfileDestination() {
        project.file(dockerfileDestination)
    }

    def from(image="java") {
        dockerfileInfo += "FROM $image\r\n"
    }

    def maintainer(contact) {
        maintainer += "MAINTAINER $contact\r\n"
    }

    def add(sourceLocation, targetLocation) {
        filesToCopy << sourceLocation
        def file = project.file(sourceLocation)
        dockerfileInfo += "ADD $file.name ${targetLocation}\r\n"
    }

    def run(command) {
        dockerfileInfo += "RUN $command\r\n"
    }

    def env(var, value) {
        dockerfileInfo += "ENV $var $value\r\n"
    }

    def expose(port) {
        dockerfileInfo += "EXPOSE $port\r\n"
    }

    def workdir(dir) {
        dockerfileInfo += "WORKDIR $dir\r\n"
    }

    def cmd(command) {
        dockerfileInfo += "CMD $command\r\n"
    }

    def entrypoint(command) {
        dockerfileInfo += "ENTRYPOINT $command\r\n"
    }

    @TaskAction
    def writeDockerfile() {
        for (fileName in filesToCopy) {
            def source = project.file(fileName)
            def target = project.file("$dockerDir/$source.name")
            target.parentFile.mkdirs()
            target << source.bytes
        }
        def file = getDockerfileDestination()
        file.parentFile.mkdirs()
        file.write dockerfileInfo
    }
}

This is where all the plugins and dependencies are located.

Congrats now you have QBit installed on your machine.

##Microservices examples using QBit

Here are some microservices examples using QBit:

-[TODO web microservice server ] (https://github.com/advantageous/qbit/wiki/%5BQuick-Start%5D-Building-a-TODO-web-service-server-with-QBit)

-[TODO web microservice client ] (https://github.com/advantageous/qbit/wiki/%5BQuick-Start%5D-Building-a-TODO-web-microservice-client-with-QBit)

-[Rest server ] (https://github.com/advantageous/qbit/wiki/%5BQuick-Start%5D-Building-a-simple-Rest-web-microservice-server-with-QBit)

-[Simple Hello World app using QBit ] (https://github.com/advantageous/qbit/wiki/%5BQuick-Start%5D-building-a-single-page-web-application-with-QBit)

more to come....

##Related articles [High speed microservices ] (http://rick-hightower.blogspot.com/2015/01/high-speed-soa.html)

Further Reading

QBit Website What is Microservices Architecture?

QBit Java Micorservices lib tutorials

The Java microservice lib. QBit is a reactive programming lib for building microservices - JSON, HTTP, WebSocket, and REST. QBit uses reactive programming to build elastic REST, and WebSockets based cloud friendly, web services. SOA evolved for mobile and cloud. ServiceDiscovery, Health, reactive StatService, events, Java idiomatic reactive programming for Microservices.

Find more tutorial on QBit.

Reactive Programming, Java Microservices, Rick Hightower

High-speed microservices consulting firm and authors of QBit with lots of experience with Vertx - Mammatus Technology

Highly recommended consulting and training firm who specializes in microservices architecture and mobile development that are already very familiar with QBit and Vertx as well as iOS and Android - About Objects

Java Microservices Architecture

[Microservice Service Discovery with Consul] (http://www.mammatustech.com/Microservice-Service-Discovery-with-Consul)

Microservices Service Discovery Tutorial with Consul

[Reactive Microservices] (http://www.mammatustech.com/reactive-microservices)

[High Speed Microservices] (http://www.mammatustech.com/high-speed-microservices)

Java Microservices Consulting

Microservices Training

Reactive Microservices Tutorial, using the Reactor

QBit is mentioned in the Restlet blog

All code is written using JetBrains Idea - the best IDE ever!

Kafka training, Kafka consulting, Cassandra training, Cassandra consulting, Spark training, Spark consulting

Tutorials

__

Docs

Getting Started

Basics

Concepts

REST

Callbacks and Reactor

Event Bus

Advanced

Integration

QBit case studies

QBit 2 Roadmap

-- Related Projects

Kafka training, Kafka consulting, Cassandra training, Cassandra consulting, Spark training, Spark consulting

Clone this wiki locally