Quarkus IO is a microservices based java framework. According to QuarkusIO website , Quarkus is "A Kubernetes Native Java stack tailored for OpenJDK HotSpot & GraalVM, crafted from the best of breed Java libraries and standards". This course will talks about creating microservices based on Quarkus. We will be going through
- Installing required software for understanding full features of Quarkus
- Building Todo and User Microservices using Quarkus
- Building superfast native images
- Writing test cases
- Using Hibernate and Mongodb database as backend
- Creating microservices architecture using Fallbacks and distributed logginh
- deploying them in cloud
Installing Software
In this section we will look at installing software required for this course. This is a prerequisite if you want to follow along this course. We will be installing . We will be installing on Linux based system but you can install on your desired operation system
- JDK 1.8+
- Maven 3.6.X
- GraalVM
- Docker
JDK
To install JDK go to official website and download the latest version for your operating system.On a linux laptop with Ubuntu you can follow the steps as well
- Open terminal
- write following commands
sudo add-apt-repository ppa:openjdk-r/ppa
sudo apt update
sudo apt install open-jdk-8-jdk
export JAVA_HOME=/usr/lib/jvm/java-8-openjdk
export PATH=$PATH:$JAVA_HOME/bin
Check the installed version
java -version
Maven 3.6.X
Maven is a build tool it will help us to create builds effectively. To install maven visit maven website and download latest maven. Unzip it and add to path. JAVA_HOME must be set to use maven
unzip apache-maven-3.6.3-bin.zip
export PATH=/opt/apache-maven-3.6.3/bin:$PATH
GraalVM
GraalVM is a virtual machine by oracle which enables user to create native images. Native images are faster and has lower memory footprint. GraamVM enable local executables and the binary created by it is independent of JVM it runs faster. It must be noticed that while creating native builds GraalVM do analyse all the classes your code will use at its entire life cycle and the compiles to byte code , the entire process is a bit slow. Run below commands to install GraalVM on linux (ubuntu)
sudo apt-get install build-essential libz-dev zlib1g-dev
You can install GraamVM community edition or can download enterprise edition from oracle website. If you have a enterprise edition tar file downloaded
tar -xvf graalvm-ee-java11-linux-amd64-19.3.1.tar.gz
export GRAALVM_HOME=/home/coding/Documents/Softwares/graalvm-ee-java11-19.3.1/
If you have enterprise edition installed download native jar and run following command
${GRAALVM_HOME}/bin/gu install native-image --filr native-image-installable-svm-svmee-java11-linux-amd64-19.3.1.jar
Docker
To install docker at Ubuntu we can use following commands
sudo apt install apt-transport-https ca-certificates curl software-properties-common
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu bionic test"
sudo apt update
sudo apt install docker-ce
For detailed documentation of installation on any platform https://docs.docker.com/
Creating User Microservices
In this section we will create our first microservice. We will create user-service which will help us to perform crud operations on user. User service will have mogodb as back end . We will create it using maven command ,Alternatively we can also use generator site i.e https://code.quarkus.io
Creating user-service using maven
Open terminal and type following command.
mvn io.quarkus:quarkus-maven-plugin:1.2.0.Final:create \
-DprojectGroupId=com.codingsaint.learning.quarkus \
-DprojectArtifactId=user-service \
-DclassName="com.codingsaint.learning.quarkus.UserResource" \
-Dpath="/user"
While the above command will only a bare project which you can run using simple maven command. We will be adding the dependencies later , just to understand how can we use quarkus maven extension to add dependencies ,Obviously both steps can be combined together.
cd user-service
mvn quarkus:dev
Running application in dev mode
The command to run in dev mode is
mvn quarkus:dev
This will start the server in dev mode.In dev mode if you edit the code and do a change it will stop quarkus (not JVM), recompile and start quarkus . This works as live reload and is very helpful in dev mode
building native image
Quarkus comes with integrated support for building native images , you can build bare metal or docker based images.To create a image run the below command
mvn package -Pnative
It must be noted that this is a maven profile for building native images and to support this GraalVM must be installed with native jar as mentioned above. To build native for docker image add
-Dnative-image.docker-build=true
Adding dependencies
We will be using below command to add dependecies
mvn quarkus:add-extension -Dextensions=hibernate-validator,mongodb-panache,resteasy-jsonb
It must be noted that we could have added extensions while creating the project itself adding -D extension , this is just to show , how to add dependencies using maven. You can find list of all the available dependencies at https://quarkus.io/extensions/
Creating User entity
package com.codingsaint.learning.quarkus;
import io.quarkus.mongodb.panache.MongoEntity;
import io.quarkus.mongodb.panache.PanacheMongoEntity;
import org.bson.codecs.pojo.annotations.BsonId;
import org.bson.codecs.pojo.annotations.BsonProperty;
import javax.validation.constraints.NotNull;
import java.time.LocalDate;
@MongoEntity
public class User extends PanacheMongoEntity {
private String userId;
@NotNull(message = "First Name is required")
private String firstName;
private String lastName;
@BsonProperty("dob")
@NotNull(message = "Date of Birth is required")
private LocalDate dateOfBirth;
@NotNull(message = "Email is required")
private String email;
private Boolean active;
public String getFirstName() {
return firstName;
}
public void setFirstName(String firstName) {
this.firstName = firstName;
}
public String getLastName() {
return lastName;
}
public void setLastName(String lastName) {
this.lastName = lastName;
}
public String getUserId() {
return userId;
}
public void setUserId(String userId) {
this.userId = userId;
}
public LocalDate getDateOfBirth() {
return dateOfBirth;
}
public void setDateOfBirth(LocalDate dateOfBirth) {
this.dateOfBirth = dateOfBirth;
}
public String getEmail() {
return email;
}
public void setEmail(String email) {
this.email = email;
}
public Boolean getActive() {
return active;
}
public void setActive(Boolean active) {
this.active = active;
}
public static User findByUserId(String userId) {
return find("userId", userId).firstResult();
}
}
Adding UserResource
package com.codingsaint.learning.quarkus;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import javax.validation.Valid;
import javax.ws.rs.*;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import java.util.UUID;
@Path("/users")
public class UserResource {
private static final Logger LOGGER = LoggerFactory.getLogger(UserResource.class);
/**
* Get all of the users
*
* @return Response> users
*/
@GET
@Produces(MediaType.APPLICATION_JSON)
public Response users() {
return Response.ok(User.listAll()).build();
}
@POST
@Produces(MediaType.APPLICATION_JSON)
@Consumes(MediaType.APPLICATION_JSON)
public Response users(final @Valid User user) {
user.setUserId(UUID.randomUUID().toString());
user.setActive(true);
User.persist(user);
return Response.ok().build();
}
@PUT
@Produces(MediaType.APPLICATION_JSON)
@Consumes(MediaType.APPLICATION_JSON)
public Response update(final @Valid User user) {
user.update();
return Response.ok(user).build();
}
@GET
@Produces(MediaType.APPLICATION_JSON)
@Consumes(MediaType.APPLICATION_JSON)
@Path("id/{id}")
public Response getUserByUserId(@PathParam("id") String userId) {
User user = User.findByUserId(userId);
LOGGER.info(" finding user based on userId {}", userId);
return Response.ok(user).build();
}
@DELETE
@Path("id/{id}")
public Response deleteUser(@PathParam("id") String userId) {
LOGGER.info(" delete user based on userId {}", userId);
User.delete("userId",userId);
return Response.noContent().build();
}
}
Adding application properties
quarkus.mongodb.connection-string = mongodb://localhost:27017
quarkus.mongodb.database=todo-users
Running the server
Run the server using below command
mvn quarkus:dev
Add a user
Add following curl command or use postman or other software to do a post
curl -X POST \
http:
-H 'Content-Type: application/json' \
-d '{
"firstName":"Kumar",
"lastName":"Pallav",
"dateOfBirth":"1987-08-05",
"email":"codingsaint@gmail.com"
}'
Retrieve all users
Use a get request http://localhost:8080/user/all or do a curl as below
curl -X GET \
http://localhost:8080/user/all \
You will get a response like
[{
"id": "5e430af58cd12948d22faa9a",
"active": true,
"dateOfBirth": "1987-08-05",
"email": "codingsaint@gmail.com",
"firstName": "Kumar",
"lastName": "Pallav",
"userId": "10905021-e7c5-43e2-a29e-8a42f69d4fb2"
}]
