-
Notifications
You must be signed in to change notification settings - Fork 40.7k
Spring Boot with GraalVM
-
Signed JARs (used for example in the Azure Java SDK) are not supported out of the box. See this comment on the spring-framework issue for the proposed workaround.
-
GraalVM with Truffle (Ruby,JavaScript) as a native image does not work with Spring applications because this disables inlining support.
-
Groovy, due to its dynamic nature, is not supported at the moment.
-
If a library dynamically loads a charset that’s not detected during image build, this could result in a
UnsupportedEncodingExceptionat runtime. To work around that, you can add thebuildArgs.add('-H:+AddAllCharsets')build option to the native build tools build plugin configuration. -
Coordinated Restore at Checkpoint (CRaC) and GraalVM are not supported in combination. A dependency on
org.crac:cracshould be avoided as it will make reachable code paths that do not work in a native image. -
Application context hierarchies are not supported by AOT processing or in a native image.
-
There’s a bug in 1.9.0 of the Kotlin Gradle Plugin that causes additional resource directories to be lost. This breaks native image compilation as resources generated by AOT processing are not included in the native image’s classpath. To work around the problem, apply Kotlin’s Gradle plugin first.
-
Using beans defined as lambdas or instance suppliers with AOT/native is not yet supported (for example when using a functional router with WebFlux). You can track the related issue spring-framework#29555 where some workarounds are described.
-
Loading external resources using the
"jar"protocol is not supported by default, as it’s not enabled by default. You can enable this in your build with thebuildArgs.add('--enable-url-protocols=jar')option with the native build tools build plugin. -
Field injection with
@Resourcedoes not work. Please use constructor injection or@Autowired-based field injection instead. -
To use SpEL expressions in a native image, runtime hints must be provided to enable the reflective calls that the expression requires. spring-framework#29548 is tracking the necessary changes to remove this limitation.
-
Log4j2 is not supported in native images.
-
Logback is supported, including XML configuration. XML configuration is loaded at build time during AOT processing and translated into a fixed, native-friendly format. As a result, loading different XML configuration at runtime is not supported.
-
Commons Logging should be excluded in Spring Applications as
spring-jclprovides its own version and having both leads to duplicated classpath entries.
-
Mockito is not supported yet, see #32195. You can disable tests which rely on Mockito (this includes tests that use
@MockBeanand@SpyBean) with@DisabledInNativeImage.
-
Paketo Buildpacks do not yet have official support for building images for ARM. But there are alternative builders available which support building on ARM.
-
The optional usage of
@ModelAttributeas supported by Spring MVC and Spring WebFlux does not allow ahead-of-time inference of the needed data binding reflection hints. As a consequence, it is recommended to explicitly annotate the method parameters with@ModelAttributewhere binding is required.
-
WebJars are not recommended with native images since the
webjars-locator-coredependency involves unsupported resource scanning at runtime, and since WebJars dependencies lead to the inclusion of unneeded resources fromMETA-INF/resources/. Consider alternative approaches like directly shipping the required frontend resources in the web application, potentially by leveraging build plugins like the gradle-node-plugin for Gradle or the frontend-maven-plugin for Maven (see related blog post).
HSQLDB is not supported in a native image. If you require an in-memory database, please use H2 instead.
Automatic detection of Java migrations are not supported in native image, see #33458. You can work around this limitation in Flyway by using a FlywayConfigurationCustomizer to register your Java migrations:
@Component
class JavaMigrationsFlywayCustomizer implements FlywayConfigurationCustomizer {
@Override
public void customize(FluentConfiguration configuration) {
configuration.javaMigrations(new V1__create_table(), new ...);
}
}Gradle projects written in Kotlin will fail with a ClassCastException when attempting to configure Hibernate’s bytecode enhancement. HHH-15707 is tracking the problem.
If org.glassfish.jaxb:jaxb-runtime is used (for example, JPA / Hibernate depends on it), you’ll need to install the libfreetype library on your Linux or MacOS system. That’s because a class inside JAXB depends on javax.imageio, which will initialize the graphics subsystem.
Spring-WS does not support AOT and GraalVM Native at the moment.
Please see their dedicated document.
To use Spring Cloud Azure with GraalVM, you’ll need to add the spring-cloud-azure-native-reachability dependency.
tomcat-embed-programmatic is an experimental Tomcat dependency designed to lower the memory footprint. Using it produces smaller native images.
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<exclusions>
<exclusion>
<groupId>org.apache.tomcat.embed</groupId>
<artifactId>tomcat-embed-core</artifactId>
</exclusion>
<exclusion>
<groupId>org.apache.tomcat.embed</groupId>
<artifactId>tomcat-embed-websocket</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.apache.tomcat.experimental</groupId>
<artifactId>tomcat-embed-programmatic</artifactId>
<version>${tomcat.version}</version>
</dependency>implementation('org.springframework.boot:spring-boot-starter-web') {
exclude group: 'org.apache.tomcat.embed', module: 'tomcat-embed-core'
exclude group: 'org.apache.tomcat.embed', module: 'tomcat-embed-websocket'
}
String tomcatVersion = dependencyManagement.importedProperties['tomcat.version']
implementation "org.apache.tomcat.experimental:tomcat-embed-programmatic:$tomcatVersion"