jwcarman / spring-native-demo

Spring Boot Native Image Demo

A demo application to illustrate how to build and run a Spring Boot native image.

Building

Using Maven, execute the following command to build the native image:

mvn -Pnative spring-boot:build-image

Alternatively, to build a non-native image:

mvn spring-boot:build-image

Running

Once the image is built, you can run it using Docker:

docker run --rm -p 8080:8080 docker.io/library/spring-native-demo:0.0.1-SNAPSHOT

Startup Time

When running the natively-built Spring boot application, you should see the final line of output similar to the following:

Started SpringNativeDemoApplication in 0.099 seconds (process running for 0.107)

When running as a non-native Spring Boot container, the output looks a bit different:

Started SpringNativeDemoApplication in 2.95 seconds (process running for 3.203)

Our application starts up 30x faster when built natively!

Memory Usage

Let's examine the memory usage of our native application:

docker stats

The output should look similar to the following:

CONTAINER ID   NAME                 CPU %     MEM USAGE / LIMIT    MEM %     NET I/O           BLOCK I/O        PIDS
6c4ded529676   awesome_fermi        0.01%     67.6MiB / 31.3GiB    0.21%     1.63kB / 746B     0B / 0B          19

Here, we see that our natively-built Spring Boot application is only using 67.6BiB of memory! Let's compare that with a container running using a non-native Spring Boot application:

CONTAINER ID   NAME                 CPU %     MEM USAGE / LIMIT    MEM %     NET I/O           BLOCK I/O        PIDS
b7edbc9c7a23   zealous_montalcini   0.08%     419.2MiB / 31.3GiB   1.31%     4.03kB / 2.73kB   0B / 463kB       49

The native application consumes only 16% of the memory used by its non-native counterpart!

Testing

Testing out the API is simple using httpie!

Creating a Person

To create a new Person record, execute the following:

http POST localhost:8080/persons firstName=Spring lastName=Native

You should see output similar to the following:

HTTP/1.1 201
Connection: keep-alive
Content-Type: application/json
Date: Sat, 18 Mar 2023 18:51:34 GMT
Keep-Alive: timeout=60
Transfer-Encoding: chunked

{
    "firstName": "Spring",
    "id": "cddaca53-214c-459a-8eae-96b19a29577f",
    "lastName": "Native"
}

Finding a Person

To find an existing Person record, execute the following:

http localhost:8080/persons/cddaca53-214c-459a-8eae-96b19a29577f

You should see output similar to the following:

HTTP/1.1 200
Connection: keep-alive
Content-Type: application/json
Date: Sat, 18 Mar 2023 18:54:33 GMT
Keep-Alive: timeout=60
Transfer-Encoding: chunked

{
    "firstName": "Spring",
    "id": "cddaca53-214c-459a-8eae-96b19a29577f",
    "lastName": "Native"
}

Updating a Person

To update an existing Person record, execute the following:

http PUT localhost:8080/persons/cddaca53-214c-459a-8eae-96b19a29577f firstName=Spring lastName=Boot

You should see output similar to the following:

HTTP/1.1 200
Connection: keep-alive
Content-Type: application/json
Date: Sat, 18 Mar 2023 18:55:42 GMT
Keep-Alive: timeout=60
Transfer-Encoding: chunked

{
    "firstName": "Spring",
    "id": "cddaca53-214c-459a-8eae-96b19a29577f",
    "lastName": "Boot"
}

Deleting a Person

To delete an existing Person record, execute the following:

http DELETE localhost:8080/persons/cddaca53-214c-459a-8eae-96b19a29577f

You should see output similar to the following:

HTTP/1.1 200
Connection: keep-alive
Content-Length: 0
Date: Sat, 18 Mar 2023 18:56:49 GMT
Keep-Alive: timeout=60