Spring GraalVM native Gradle plugin

Supports for building Spring Boot applications as GraalVM native images.

https://plugins.gradle.org/plugin/com.github.ayltai.spring-graalvm-native-plugin

Quick start

Apply Gradle plugin

Groovy

Using the plugins DSL:

plugins {
    id 'com.github.ayltai.spring-graalvm-native-plugin' version '1.4.10'
}

Using legacy plugin application:

buildscript {
    repositories {
        maven {
            url 'https://plugins.gradle.org/m2/'
        }
    }

    dependencies {
        classpath 'gradle.plugin.com.github.ayltai:spring-graalvm-native-plugin:1.4.10'
    }
}

apply plugin: 'com.github.ayltai.spring-graalvm-native-plugin'

Kotlin

Using the plugins DSL:

plugins {
    id('com.github.ayltai.spring-graalvm-native-plugin') version '1.4.10'
}

Using legacy plugin application:

buildscript {
    repositories {
        maven {
            url = uri('https://plugins.gradle.org/m2/')
        }
    }

    dependencies {
        classpath('gradle.plugin.com.github.ayltai:spring-graalvm-native-plugin:1.4.10')
    }
}

Specify build arguments

This plugin uses the following example Gradle extension for configuration:

nativeImage {
    mainClassName = 'com.example.springboot.Application'

    reportExceptionStackTraces = true
    removeUnusedAutoConfig     = true
    removeYamlSupport          = true
    maxHeapSize                = '6G'
}

More configuration options can be found here.

Update Spring Boot annotation

You need to specify proxyBeanMethods = false for your @SpringBootApplication annotation:

@SpringBootApplication(proxyBeanMethods = false)
public class TomcatApplication {
    public static void main(final String[] args) {
        SpringApplication.run(TomcatApplication.class, args);
    }
}

Build GraalVM Native Image

1. Run the Gradle task buildNativeImage
2. The native image can be located at <buildDir>/native

Sample project

samples contains various samples that demonstrate the basic usage of this Gradle plugin.

Configuration

See Spring GraalVM Native configuration options for more details.

GitHub action

setup-graalvm is a GitHub action that sets up a GraalVM environment for your GitHub workflow.

License

MIT

References

• GraalVM
• GraalVM Native Image
• Spring Native
• Spring Native configuration options