Deploy a Micronaut function as a GraalVM Native Image to AWS Lambda

Learn how to distribute a Micronaut function built as a GraalVM Native image to AWS Lambda Custom Runtime

Authors: Sergio del Amo

Micronaut Version: 3.2.7

1. Introduction

Please read about Micronaut AWS Lambda Support to learn more about different Lambda runtime, Triggers, and Handlers, and how to integrate with a Micronaut application.

The biggest problem with Java applications and Lambda is how to mitigate Cold startups. Executing GraalVM Native images of a Micronaut function in a Lambda Custom runtime is a solution to this problem.

If you want to respond to triggers such as queue events, S3 events, or single endpoints, you should opt to code your Micronaut functions as Serverless functions.

2. Getting Started

In this guide, we will deploy a Micronaut function written in Java as a GraalVM Native image to an AWS Lambda custom runtime.

3. What you will need

To complete this guide, you will need the following:

  • Some time on your hands

  • A decent text editor or IDE

  • JDK 1.8 or greater installed with JAVA_HOME configured appropriately

4. Solution

We recommend that you follow the instructions in the next sections and create the application step by step. However, you can go right to the completed example.

5. Writing the Application

Create an application using the Micronaut Command Line Interface or with Micronaut Launch.

mn create-function-app example.micronaut.micronautguide --features=graalvm,aws-lambda --build=maven --lang=java
If you don’t specify the --build argument, Gradle is used as the build tool.
If you don’t specify the --lang argument, Java is used as the language.

The previous command creates a Micronaut application with the default package example.micronaut in a directory named micronautguide.

If you use Micronaut Launch, select Serverless function as application type and add the graalvm and aws-lambda features.

5.1. Enable annotation Processing

If you use Java or Kotlin and IntelliJ IDEA, make sure to enable annotation processing.

annotationprocessorsintellij

6. Code

The generated project contains sample code. Let’s explore it.

We want to support a JavaBean as input and output types.

The input is a Book object:

src/main/java/example/micronaut/Book.java
package example.micronaut;
import io.micronaut.core.annotation.NonNull;
import io.micronaut.core.annotation.Introspected;
import javax.validation.constraints.NotBlank;

@Introspected
public class Book {

    @NonNull
    @NotBlank
    private String name;

    public Book() {
    }

    @NonNull
    public String getName() {
        return name;
    }

    public void setName(@NonNull String name) {
        this.name = name;
    }
}
  • Annotate the class with @Introspected to generate the Bean Metainformation at compile time.

The output is a BookSaved object:

src/main/java/example/micronaut/BookSaved.java
package example.micronaut;
import io.micronaut.core.annotation.NonNull;
import io.micronaut.core.annotation.Introspected;

import javax.validation.constraints.NotBlank;

@Introspected
public class BookSaved {

    @NonNull
    @NotBlank
    private String name;

    @NonNull
    @NotBlank
    private String isbn;

    public BookSaved() {

    }

    @NonNull
    public String getName() {
        return name;
    }

    public void setName(@NonNull String name) {
        this.name = name;
    }

    @NonNull
    public String getIsbn() {
        return isbn;
    }

    public void setIsbn(@NonNull String isbn) {
        this.isbn = isbn;
    }
}
  • Annotate the class with @Introspected to generate the Bean Metainformation at compile time.

The application contains a class extending MicronautRequestHandler

src/main/java/example/micronaut/BookRequestHandler.java
package example.micronaut;
import io.micronaut.core.annotation.Introspected;
import io.micronaut.function.aws.MicronautRequestHandler;
import java.util.UUID;

@Introspected
public class BookRequestHandler extends MicronautRequestHandler<Book, BookSaved> {

    @Override
    public BookSaved execute(Book input) {
        BookSaved bookSaved = new BookSaved();
        bookSaved.setName(input.getName());
        bookSaved.setIsbn(UUID.randomUUID().toString());
        return bookSaved;
    }
}

The generated test shows how to verify the function behaviour:

src/test/java/example/micronaut/BookRequestHandlerTest.java
package example.micronaut;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertEquals;
import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Test;

public class BookRequestHandlerTest {

    private static BookRequestHandler bookRequestHandler;

    @BeforeAll
    public static void setupServer() {
        bookRequestHandler = new BookRequestHandler();
    }

    @AfterAll
    public static void stopServer() {
        if (bookRequestHandler != null) {
            bookRequestHandler.getApplicationContext().close();
        }
    }

    @Test
    public void testHandler() {
        Book book = new Book();
        book.setName("Building Microservices");
        BookSaved bookSaved = bookRequestHandler.execute(book);
        assertEquals(bookSaved.getName(),book.getName());
        assertNotNull(bookSaved.getIsbn());
    }
}
  • When you instantiate the Handler, the application context starts.

  • Remember to close your application context when you end your test. You can use your handler to obtain it.

  • Invoke the execute method of the handler.

7. Testing the Application

To run the tests:

./mvnw test

8. Lambda

Create a Lambda Function. As a runtime, select Custom Runtime

create function bootstrap

8.1. Upload Code

The Micronaut framework eases the deployment of your functions as a Custom AWS Lambda runtime.

The main API you will interact with is AbstractMicronautLambdaRuntime. This is an abstract class which you can subclass to create your custom runtime mainClass. That class includes the code to perform the https:/ /docs.aws.amazon.com/lambda/latest/dg/runtimes-custom.html#runtimes-custom-build[Processing Tasks] described in the Custom Runtime documentation.

The generated project contains such a class:

src/main/java/example/micronaut/BookLambdaRuntime.java
package example.micronaut;
import com.amazonaws.services.lambda.runtime.events.APIGatewayProxyRequestEvent;
import com.amazonaws.services.lambda.runtime.events.APIGatewayProxyResponseEvent;
import io.micronaut.function.aws.runtime.AbstractMicronautLambdaRuntime;
import java.net.MalformedURLException;
import com.amazonaws.services.lambda.runtime.RequestHandler;
import io.micronaut.core.annotation.Nullable;

public class BookLambdaRuntime extends AbstractMicronautLambdaRuntime<APIGatewayProxyRequestEvent, APIGatewayProxyResponseEvent, Book, BookSaved> {

    public static void main(String[] args) {
        try {
            new BookLambdaRuntime().run(args);

        } catch (MalformedURLException e) {
            e.printStackTrace();
        }
    }

    @Override
    @Nullable
    protected RequestHandler<Book, BookSaved> createRequestHandler(String... args) {
        return new BookRequestHandler();
    }
}
./mvnw package -Dpackaging=docker-native -Dmicronaut.runtime=lambda -Pgraalvm

The above command generates a ZIP file which contains a GraalVM Native Image of the application, and a bootstrap file which executes the native image. The GraalVM Native Image of the application is generated inside a Docker container.

Once you have a ZIP file, upload it

lambda custom runtime uploadcode

8.2. Handler

The handler used is the one created at BookLambdaRuntime.

Thus, you don’t need to specify the handler in the AWS Lambda console.

However, I like to specify it in the console as well:

example.micronaut.BookRequestHandler

lambda custom runtime bookrequest handler

8.3. Test

You can test it easily. As Event Template use apigateway-aws-proxy to get you started:

test event
{
  "body": "{\"name\": \"Building Microservices\"}",
  "resource": "/",
  "path": "/",
  "httpMethod": "POST",
  "isBase64Encoded": false,
  "queryStringParameters": {},
  "multiValueQueryStringParameters": {},
  "pathParameters": {},
  "stageVariables": {},
  ...
}

You should see a 200 response:

test result

9. Next steps

Explore more features with Micronaut Guides.

Read more about:

10. Help with the Micronaut Framework

Object Computing, Inc. (OCI) sponsored the creation of this Guide. A variety of consulting and support services are available.