Spring Boot 3 Native Image 打包成原生镜像全过程详解
折腾了好几天,重要成功将一个SpringBoot的应用打包为原生镜像。过程比较曲折,考虑到很多同学在做打包的时候可能会遇到各种各样的问题,所以我把整个过程贴出来供大家参考。
准备Graal VM 环境
- 去Graal VM官网根据自己的系统去下载最新的版本,社区版和企业版皆可。我的版本是graalvm-ce-java19-22.3.1
- 将JAVA_HOME环境变量修改为Graal VM的安装目录。一般情况下Path环境变量是引用JAVA_HOME的,所以不需要做修改。
注意:JAVA_HOME变量是必须的,在后期编译过程中会引用到JAVA_HOME! - 使用java -version命令确认环境变量生效
- 运行下面的命令安装native-image的相应支持文件。
gu install native-image
注意,这个命令的运行可能需要科学上网使用NPV进行Fan墙后才能运行成功,否则命令会一直卡主!安装的过程也会有相应的进度条提示。
- 下载成功后使用命令来检查自己是否安装成功
gu list
出现下面的图说明安装成功。
安装Visual Stdio
- 下载最新版的Visual Studio Installer,然后勾选安装内容。
大家注意,Visual Studio Installer 中很多安装内容都是重复的,只是版本不同。所以不必全部勾选,只勾选最新版安装内容的即可。 - 勾选语言包,只勾选英文。不要勾选中文!!!!不要勾选中文!!!!
配置编译环境变量
这里比较麻烦,需要配置的环境变量较多
MSVC=D:\MicrosoftVisualStudio\2022\Community\VC\Tools\MSVC\14.35.32215
WK10_INCLUDE=D:\Windows Kits\10\Include\10.0.22000.0
WK10_LIB=D:\Windows Kits\10\Lib\10.0.22000.0
INCLUDE=%MSVC%\include;%WK10_INCLUDE%\ucrt;%WK10_INCLUDE%\shared;%WK10_INCLUDE%\winrt;%WK10_INCLUDE%\um
LIB=%WK10_LIB%\um\x64;%WK10_LIB%\ucrt\x64;%MSVC%\lib\x64
其中,MSVC环境变量和WK10相关环境变量需要大家按照自己安装Visual Studio的路径进行配置。
当然,还需要把
%MSVC%\bin\Hostx64\x64
加到Path环境变量中。
创建项目
首先是创建项目,如果是使用IDEA,可以直接使用Spring Initializar来创建,记得勾选上Graal VM Native Support。
但创建好的项目中,native-maven-plugin这个plugin有可能是红色的,也就是依赖未下载好。那么就可以先去maven仓库找这个插件的最新依赖,然后把依赖放到dependencies标签中手动导入即可。
下面是项目的pom.xml文件:
<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>3.0.5</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.example</groupId>
<artifactId>springboot3-native-demo</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>springboot3-native-demo</name>
<description>springboot3-native-demo</description>
<properties>
<java.version>19</java.version>
<skipTests>true</skipTests>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<!-- 加上这个依赖后再手动import一下,可以解决本pom文件下方的的plugins标签中的
native-maven-plugin报红问题,报红问题解决后删掉本依赖即可-->
<dependency>
<groupId>org.graalvm.buildtools</groupId>
<artifactId>native-maven-plugin</artifactId>
<version>0.9.20</version>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.graalvm.buildtools</groupId>
<artifactId>native-maven-plugin</artifactId>
</plugin>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
剩下的代码就不放出来了,和其他Spring Boot的代码没有区别。
编译
如果是Spring Initializar创建的Spring项目,那么项目下会有一个HELP.md文件可以查看这个文件中的说明。那么编译的命令是
mvnw native:compile -Pnative
直接在当前项目的命令行中运行即可。
当然IDEA的用户更方便,不需要手动敲入命令,只需要点击下面的按钮执行即可。
最后要注意的是,在编译过程中360等杀毒软件可能会产生误报,所以编译的时候最好把杀毒软件关掉.
编译完成后,exe文件会生成到target目录中,双击运行即可。