GraalVM Native Images

GraalVM Native Images: This guide describes how to build a GraalVM native image for a Helidon MP application.

Introduction

Native images are ahead-of-time compiled Java code that result in a self contained native executable. When used appropriately native images have dramatically faster startup and lower runtime memory overhead compared to a Java VM.

In this guide you will learn how to build a native image locally on your machine, as well as using Docker.

What You Need

For this 10 minute tutorial, you will need the following:

A Helidon {upper-case-flavor} Application	You can use your own application or use the Helidon {upper-case-flavor} Quickstart to create a sample application.
Java SE 11 (Open JDK 11)	Helidon requires Java 11+.
Maven 3.6.1+	Helidon requires Maven 3.6.1+.
Docker 18.09+	You need Docker if you want to build and deploy Docker containers.
Kubectl 1.16.5+	If you want to deploy to Kubernetes, you need `kubectl` and a Kubernetes cluster (you can install one on your desktop).
GraalVM CE 21.0.0

Verify Prerequisites

java -version
mvn --version
docker --version
kubectl version --short

Copied

Setting JAVA_HOME

# On Mac
export JAVA_HOME=`/usr/libexec/java_home -v 11`

# On Linux
# Use the appropriate path to your JDK
export JAVA_HOME=/usr/lib/jvm/jdk-11

Copied

Install GraalVM and the Native Image Command

After downloading and installing GraalVM, set the GRAALVM_HOME environment variable to point at your GraalVM installation.

# Your path might be different
export GRAALVM_HOME=/usr/local/graalvm-ce-21.3.0/Contents/Home/

Copied

Then install the optional native-image command:

$GRAALVM_HOME/bin/gu install native-image

Copied

And verify:

$GRAALVM_HOME/bin/java -version
$GRAALVM_HOME/bin/native-image --version

Copied

Generate the Project

Generate the project using the Helidon MP Quickstart Maven archetype.

mvn -U archetype:generate -DinteractiveMode=false \
    -DarchetypeGroupId=io.helidon.archetypes \
    -DarchetypeArtifactId=helidon-quickstart-mp \
    -DarchetypeVersion=2.6.14 \
    -DgroupId=io.helidon.examples \
    -DartifactId=helidon-quickstart-mp \
    -Dpackage=io.helidon.examples.quickstart.mp

Copied

The archetype generates a Maven project in your current directory (for example, helidon-quickstart-mp). Change into this directory and build.

cd helidon-quickstart-mp
mvn package

Copied

At this point you can run the application using the JVM:

java -jar target/helidon-quickstart-mp.jar

Copied

In another shell test an endpoint:

curl -X GET http://localhost:8080/greet

Copied

The application should respond with {"message":"Hello World!"}

Now stop the running application (by pressing Ctrl+C).

For more information about the Quickstart application and other enpoints it supports see the Helidon MP Quickstart Guide.

Building a Native Image

You can build a native executable in 2 different ways:

With a local installation of GraalVM
Using Docker

Local build

Make sure you have GraalVM locally installed:

$GRAALVM_HOME/bin/native-image --version

Copied

Build the native image using the native image profile:

mvn package -Pnative-image

Copied

Tip

This uses the helidon-maven-plugin to perform the native compilation using your installed copy of GraalVM. It might take a while to complete.

Once it completes start the application using the native executable (no JVM!):

./target/helidon-quickstart-mp

Copied

Yep, it starts fast. You can exercise the application’s endpoints as before.

Multi-stage Docker build

Build the "native" Docker image

docker build -t helidon-quickstart-mp-native -f Dockerfile.native .

Copied

Tip

This does a full build inside the Docker container. The first time you run it, it will take a while because it is downloading all of the Maven dependencies and caching them in a Docker layer. Subsequent builds will be much faster as long as you don’t change the pom.xml file. If the pom is modified then the dependencies will be re-downloaded.

Start the application:

docker run --rm -p 8080:8080 helidon-quickstart-mp-native:latest

Copied

Again, it starts fast. You can exercise the application’s endpoints as before.

When should I use Native Images?

Native images are ideal for applications with high horizontal scalability requirements where the ability to rapidly scale out to numerous instances is important.

That said, native images do have some limitations, and for long running applications where startup and footprint are less of a priority, the Java SE HotSpot VM might be more appropriate.

For information about creating custom Java runtime images see Custom Runtime Images with jlink