曾今Go语言里让我最艳羡的两个特性,一个是Goroutine,一个是native编译。 Java 21的虚线程实现了类似Goroutine的能力。Spring Boot 3.x开始提供了GraalVM的支持,现在Spring Boot也能打包成native文件了。
这一篇文章的目标是用一个案例讲解如何将Spring Boot应用打包成native文件。整个过程主要是4步:
- 环境准备,讲解怎么安装GraalVM,安装本地编译器(gcc,cl)
- 测试工程,创建一个极简的Spring Boot应用,只有个Controller
- 编译打包,使用GraalVM、Maven将Spring Boot应用构建成可执行文件
- 测试运行,执行生成的可执行文件,访问Controller看是否正常
1. 环境准备
1. 前置条件
GraalVM依赖一些本地工具才能完成工作,这些工具包括:
- C的头文件
- glibc-devel
- zlib
- gcc
- libstdc++-static
不同的操作系统,采用的安装方式不同,在Linux下可以使用包管理工具安装,比如yum、apt等
Linux
yum install gcc glibc-devel zlib-devel
apt-get install build-essential libz-dev zlib1g-dev
Windows
Windows可以通过安装Visual Studio完成依赖包安装
- 安装Visual Studio Build Tools
- 安装Visual Studio
2. 安装GraalVM
从官网选择Java版本、平台来下载,下载的zip包解压即安装,接下来只要设置环境变量JAVA_HOME、PATH即可
- 设置GRAALVM_HOME为解压文件夹的根目录
- 设置PATH为解压文件夹下的bin
3. 验证安装
通过执行native-image --help,确认我们安装成功
4. 参考资料
关于GraalVM的安装过程,可以参考官方的Get Started文档: Getting Started with GraalVM
2. 测试工程
1. 创建工程
使用mvn archetype:generate根据archetype maven-archetype-quickstart生成一个最简单的Java项目。
mvn archetype:generate -DarchetypeGroupId=org.apache.maven.archetypes -DarchetypeArtifactId=maven-archetype-quickstart -DarchetypeVersion=1.4 -DgroupId=com.keyniu.dis -DartifactId=DiveInSpring -Dversion=0.1 -Dpackage=com.keyniu.dis -DinteractiveMode=false
2. 添加Spring Boot支持
修改pom.xml选择spring-boot-starter-parent作为parent,添加native-maven-plugin插件
<?xml version="1.0" encoding="UTF-8"?><project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"><modelVersion>4.0.0</modelVersion><groupId>com.keyniu.dis</groupId><artifactId>DiveInSpring</artifactId><version>0.1</version><name>DiveInSpring</name><parent><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-parent</artifactId><version>3.3.0</version></parent><properties><project.build.sourceEncoding>UTF-8</project.build.sourceEncoding><maven.compiler.source>17</maven.compiler.source><maven.compiler.target>17</maven.compiler.target></properties><dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><dependency><groupId>junit</groupId><artifactId>junit</artifactId><version>4.11</version><scope>test</scope></dependency></dependencies><build><plugins><plugin><groupId>org.graalvm.buildtools</groupId><artifactId>native-maven-plugin</artifactId></plugin></plugins></build></project>
3. 添加测试类
写一个最简单启动引导类,提供一个最简单的接口/hello,用于后续测试。
package com.keyniu.dis;import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;@SpringBootApplication
@RestController
public class DiveInMain {@GetMapping("/hello")public String hello(@RequestParam("name") String name) {return "hello," + name;}public static void main(String[] args) {SpringApplication.run(DiveInMain.class);}
}
3. 编译打包
1. 命令行窗口
为了让GraalVM能引用到VisualStudio的编译工具,我选择在x64 Native Tools窗口中运行接下来的命令。
在执行命令之前,确保你的环境变量设置正确,有添加GraalVM相关的配置
set GRAALVM_HOME=D:\Programs\GraalVM
set PATH=D:\Programs\GraalVM\bin;%PATH%
2. 进行native编译
在工程的根目录下执行mvn -Pnative native:compile,进行编译,最后会生成一个exe到工程的target目录下,输入如下
D:\Workspace\DiveInSpring>mvn -Pnative native:compile
...
Produced artifacts:D:\Workspace\DiveInSpring\target\DiveInSpring.exe (executable)
4. 测试运行
只需要在命令行里输入DiveInSpring.exe执行,可以看到只需要0.063s就能完成启动,这个项目如果通过java -jar启动的话大概耗时0.97s,还是快了很多的。打包后的exe文件大小是80M。
通过curl命令验证,接口正常提供服务
5. 使用建议
可以看到整个构建过程已经相当的顺畅,从可执行文件的大小,启动时间,内存占用都于明显的提升,应该说Spring + GraalVM离成熟应用已经不远了。由于GraalVM使用了Closed World Optimization,实际上这个可执行程序还是有一些限制的,主要是:
- Class初始化,有些初始化会在build期间完成,可以参考GraalVM文档: Class Initialization in Native Image
- 反射和动态代理,需要的编译期间完成
- 不支持JNI,如果有本地方法调用需要根据GraalVM提供的接口定制实现
- 执行时无法访问字节码,正常的debug、监控等用JVM TI实现的功能都不再可用
在SpringBoot中, 像profiles、 条件配置、 @Enable*等功能会受到影响,而其实这些特性正在被广泛使用,这些限制在完全解决之前实际使用还是有障碍的。关于可以执行文件的DEBUG、监控在GraalVM官网都已经有对应的文档,但是将它和公司内部的监控报警做集成还有一段路要走,已经看到黎明的曙光了。
A. 参考资料
- GraalVM构建Swing应用
- 使用GDB Debug由GraalVM构建的程序,Debug Native Executables with GDB
- 让可执行文件支持JFR,Build and Run Native Executables with JFR
- 手动创建Spring Boot工程