开发你的第一个 GraalVM 原生应用

构建 Spring Boot 原生镜像应用主要有两种方法

启动一个新的 Spring Boot 原生项目最简单的方法是访问 start.spring.io，添加 GraalVM Native Support 依赖并生成项目。随附的 HELP.md 文件将提供入门提示。

示例应用

我们需要一个示例应用来创建我们的原生镜像。就本文而言，开发你的第一个 Spring Boot 应用 一节中介绍的简单“Hello World!” Web 应用就足够了。

回顾一下，我们的主应用代码如下

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@SpringBootApplication
public class MyApplication {

	@RequestMapping("/")
	String home() {
		return "Hello World!";
	}

	public static void main(String[] args) {
		SpringApplication.run(MyApplication.class, args);
	}

}

此应用使用了 Spring MVC 和内嵌 Tomcat，两者都经过测试和验证，可以与 GraalVM 原生镜像配合工作。

使用 Buildpacks 构建原生镜像

Spring Boot 支持使用 Cloud Native Buildpacks (CNB) 与 Maven 和 Gradle 集成，并结合 Paketo Java Native Image buildpack 来构建包含原生可执行文件的 Docker 镜像。这意味着你只需键入一个命令，即可快速将一个合适的镜像放入本地运行的 Docker daemon 中。生成的镜像不包含 JVM，而是静态编译的原生镜像。这会生成更小的镜像。

用于这些镜像的 CNB builder 是 paketobuildpacks/builder-jammy-java-tiny:latest。它占用空间小，攻击面小。它不包含 shell，并且只包含少量系统库。如果需要镜像中有更多工具，请使用 paketobuildpacks/builder-jammy-base:latest 或 paketobuildpacks/builder-jammy-full:latest。

系统要求

应安装 Docker。更多详情请参阅获取 Docker。如果你在 Linux 上，将其配置为允许非 root 用户。

你可以运行 docker run hello-world（不带 sudo）来检查 Docker daemon 是否如预期那样可访问。更多详情请查阅 Maven 或 Gradle Spring Boot 插件文档。
在 macOS 上，建议将分配给 Docker 的内存增加到至少 8GB，并且可能还需要增加 CPU 数量。更多详情请参阅此Stack Overflow 回答。在 Microsoft Windows 上，请确保启用 Docker WSL 2 后端以获得更好的性能。

使用 Maven

要使用 Maven 构建原生镜像容器，你应该确保你的 pom.xml 文件使用 spring-boot-starter-parent 和 org.graalvm.buildtools:native-maven-plugin。你应该有一个如下所示的 <parent> 部分

<parent>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-parent</artifactId>
	<version>3.4.5</version>
</parent>

此外，你的 <build> <plugins> 部分中应该有此内容

<plugin>
	<groupId>org.graalvm.buildtools</groupId>
	<artifactId>native-maven-plugin</artifactId>
</plugin>

spring-boot-starter-parent 声明了一个 native profile，用于配置创建原生镜像所需的执行步骤。你可以使用命令行上的 -P 标志来激活 profile。

如果你不想使用 spring-boot-starter-parent，则需要为 Spring Boot 插件的 process-aot goal 和 Native Build Tools 插件的 add-reachability-metadata goal 配置执行步骤。

要构建镜像，可以在激活 native profile 的情况下运行 spring-boot:build-image goal

$ mvn -Pnative spring-boot:build-image

使用 Gradle

应用 GraalVM Native Image 插件后，Spring Boot Gradle 插件会自动配置 AOT 任务。你应该检查你的 Gradle 构建是否包含一个包含 org.graalvm.buildtools.native 的 plugins 块。

只要应用了 org.graalvm.buildtools.native 插件，bootBuildImage 任务就会生成原生镜像，而不是 JVM 镜像。你可以使用以下命令运行该任务

$ gradle bootBuildImage

运行示例

运行相应的构建命令后，应该会有一个可用的 Docker 镜像。你可以使用 docker run 启动你的应用

$ docker run --rm -p 8080:8080 docker.io/library/myproject:0.0.1-SNAPSHOT

你应该会看到类似于以下的输出

  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::  (v{version-spring-boot})
....... . . .
....... . . . (log output here)
....... . . .
........ Started MyApplication in 0.08 seconds (process running for 0.095)
启动时间因机器而异，但应该比运行在 JVM 上的 Spring Boot 应用快得多。

如果你在 Web 浏览器中打开 localhost:8080，你应该会看到以下输出

Hello World!

要优雅地退出应用，请按 ctrl-c。

使用 Native Build Tools 构建原生镜像

如果你想直接生成原生可执行文件而不使用 Docker，可以使用 GraalVM Native Build Tools。Native Build Tools 是 GraalVM 为 Maven 和 Gradle 提供的插件。你可以使用它们执行各种 GraalVM 任务，包括生成原生镜像。

先决条件

要使用 Native Build Tools 构建原生镜像，你的机器上需要安装 GraalVM 发行版。你可以在 Liberica Native Image Kit 页面手动下载，或者使用像 SDKMAN! 这样的下载管理器。

Linux 和 macOS

要在 macOS 或 Linux 上安装原生镜像编译器，我们推荐使用 SDKMAN!。从 sdkman.io 获取 SDKMAN!，并使用以下命令安装 Liberica GraalVM 发行版

$ sdk install java 22.3.r17-nik
$ sdk use java 22.3.r17-nik

通过检查 java -version 的输出来验证是否配置了正确的版本

$ java -version
openjdk version "17.0.5" 2022-10-18 LTS
OpenJDK Runtime Environment GraalVM 22.3.0 (build 17.0.5+8-LTS)
OpenJDK 64-Bit Server VM GraalVM 22.3.0 (build 17.0.5+8-LTS, mixed mode)

Windows

在 Windows 上，请按照这些说明安装 22.3 版本的 GraalVM 或 Liberica Native Image Kit，以及 Visual Studio Build Tools 和 Windows SDK。由于 Windows 相关的命令行最大长度限制，请确保使用 x64 Native Tools Command Prompt 而不是常规的 Windows 命令行来运行 Maven 或 Gradle 插件。

使用 Maven

与 buildpacks 支持一样，你需要确保你正在使用 spring-boot-starter-parent 以继承 native profile，并且使用了 org.graalvm.buildtools:native-maven-plugin 插件。

激活 native profile 后，你可以调用 native:compile goal 来触发 native-image 编译

$ mvn -Pnative native:compile

原生镜像可执行文件可以在 target 目录中找到。

使用 Gradle

当 Native Build Tools Gradle 插件应用于你的项目时，Spring Boot Gradle 插件会自动触发 Spring AOT 引擎。任务依赖已自动配置，因此你只需运行标准的 nativeCompile 任务即可生成原生镜像

$ gradle nativeCompile

原生镜像可执行文件可以在 build/native/nativeCompile 目录中找到。

运行示例

至此，你的应用应该可以工作了。现在你可以直接运行应用来启动它

  • Maven

  • Gradle

$ target/myproject
$ build/native/nativeCompile/myproject

你应该会看到类似于以下的输出

  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::  (v3.4.5)
....... . . .
....... . . . (log output here)
....... . . .
........ Started MyApplication in 0.08 seconds (process running for 0.095)
启动时间因机器而异，但应该比运行在 JVM 上的 Spring Boot 应用快得多。

如果你在 Web 浏览器中打开 localhost:8080，你应该会看到以下输出

Hello World!

要优雅地退出应用，请按 ctrl-c。