使用GraalVM native-image 编译SpringBoot3全过程

客官°小女子只卖身不卖艺 2023-10-08 23:54 101阅读 0赞

**本文记录了使用native-image编译SpringBoot3.0.3的过程及遇到的问题。其中一些问题也是网上很多朋友遇到，我在实际操作的过程也遇到过同样的问题，在此做一记录。**

**目录**

一、编译环境准备

1.1 安装GraalVM

1.2 安装native-image

1.3 IDE设置

1.4 Visual Studio 2022

1.5 pom.xml文件

二、使用native-image工具本地编译

三、AOT技术

3.1 AOT与JIT

3.2 缺点

3.3 JIT优点

3.4 JIT缺点

四、单元测试

--------------------

> ## 一、编译环境准备 ##
> 
> ![8ee80b6371e449d9849600e293c190bb.png][]
> 
> ### 1.1 安装GraalVM ###
> 
> 它在java HotSpot JVM的基础上添加了JIT编译器和AOT来实现将应用编译成为本地可执行文件。除了java之外，GraalVM还支持JavaScript、Ruby、Python等多种编程语言。
> 
> GraalVM下载地址：[https://www.oracle.com/downloads/graalvm-downloads.html。][https_www.oracle.com_downloads_graalvm-downloads.html]下载的时候选择对应的平台和版本。
> 
> GraalVM跟JDK一样也有两个版本，社区版和企业版本，大家可以根据需要自行选择。
> 
> 如果下载的zip压缩文件，选择一个目录将它解压即可。
> 
> ![7b3b9b3b1aaf4103800d1e69df936b54.png][]
> 
> ### 1.2 安装native-image ###
> 
>  *  方法1 : 控制台输入命令 gu install native-image即可,下载速度贼慢
>  *  方法2：在github上下载对应版本的native-image安装包进行本地安装
> 
> [Release GraalVM Community Edition 22.3.0 · graalvm/graalvm-ce-builds (github.com)][Release GraalVM Community Edition 22.3.0 _ graalvm_graalvm-ce-builds _github.com]
> 
> ![f14537e38d8d4124b777e064f4f45be9.png][]
> 
> 控制台输入命令 gu install -L 你的下载位置
> 
> 安装成功，控制台输入gu list如图所示
> 
> ![d600ba32dfdf43dba42970ad3a99c3e4.png][]
> 
> **环境变量配置：**
> 
> JAVA\_HOME = GraalVM的的根目录
> 
> PATH = %JAVA\_HOME%\\bin
> 
> ### 1.3 IDE设置 ###
> 
> 打开项目的Project Settings，SDK--->Edit---->Add SDK 选择GraalVM。
> 
> ![12ba56e37c3944bfb942d4d7394c055e.png][]
> 
> Edit Configurations
> 
> ![e438780d2d58429b91d7376ea2a5ab54.png][]
> 
> 设置Build and run 的JRE为GraalVM-17
> 
> ![2a91f59c65bb4937bfe079c534a73b02.png][]
> 
> ### 1.4 Visual Studio 2022 ###
> 
> 由于Windows相关的命令行最大长度限制，所以需要使用x64 Native Tools Command Prompt而不是常规的Windows命令来运行maven或者Gradle插件。
> 
> 安装好后需要配置Visual Studio的环境变量。
> 
> ![919c8dc92ee747f1a77e5a80c61549c0.png][]
> 
> ![d2645271b76d4005965b2cd376b41ae4.png][]
> 
> mvn -Pnative native:compile
> 
> ### 1.5 pom.xml文件 ###
> 
>     <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
> 
> native-maven-plugin 默认为最新版本：0.9.20
> 
> ## 二、使用native-image工具本地编译 ##
> 
> 1、打开X64 Native Tools Command Propmt窗口执行：
> 
>     mvn -Pnative native:compile
> 
> 执行过程中出现下面错误信息：
> 
> Execution of E:\\tools\\graalvm-ce-java17-22.3.1\\bin\\native-image.cmd @target\\tmp\\native-image-2154084464642699530.args returned non-zero result
> 
> 如下图：
> 
> ![0e989ca56b784ce1aa87cb80d8926b80.png][]
> 
> 根据错误提示我们查看并修改
> 
> F:\\myworkspace\\demo-test\\demo\\target\\native-image-2154084464642699530.args
> 
> 文件将里面的所有\\\\路径全局替换为/路径符号。
> 
> **替换前：**
> 
> ![6e4a4aa66fac489ebf0790579915a991.png][]
> 
> **替换后：**
> 
> ![f2acfc8b3cbf47cc86fb0f5feb7e2642.png][]
> 
> 为什么将“\\\\”替换为“/”就可以成功执行，此处应该是 native-maven-plugin（0.9.20） 版本导致的**，0.9.19版本也有同样的问题，在linux下应该没有此问题。**
> 
>  **然后我们手动执行刚才报错的命令 （重要，也就是原来一步完成的任务，现在需要两步完成）**
> 
>     native-image @target\tmp\native-image-2154084464642699530.args
> 
> 此处我们也可以将args文件中的参数粘贴出来作为native-image 后面的参数，不需要替换路径，只需要将相关参数合并成单行命令执行也能成功，说明native-image通过vcvars64.bat脚本执行后是支持window的路径\\\\格式的）
> 
> ![a2c66844992b4477a3f3d9faef9ad3b6.png][]
> 
> 等价于
> 
> ![f4f10c76fcb5486d8ca171ef30f72986.png][]
> 
> 执行完毕结果
> 
> ![3eaa28de46814583981c33ee4b0b8509.png][]
> 
> 本文参考：
> 
> [SpringBoot3 Graalvm Native-Image尝鲜\_Zyp168168的博客-CSDN博客][SpringBoot3 Graalvm Native-Image_Zyp168168_-CSDN]
> 
> ##  ##
> 
> ## 三、AOT技术 ##
> 
> GraalVM Native Images是一个利用AOT(Ahead-of-Time)技术把java程序直接编译成可执行程序的编译工具，编译出来的程序在运行时不再依赖JRE，同时启动速度快，资源消耗低，这对传统java程序来说都是极大的优势。
> 
> 同时云原生应用来说，GraalVM Native Images编译生成的程序体积很小，非常适合云原生环境，目前由于传统java程序生成的镜像中需要包含一个体积很大的JRE或JDK而经常被人诟病。Spring Boot从3.0版本开始支持AOT技术。
> 
> ### 3.1 AOT与JIT ###
> 
>  *  在程序运行前编译，可以避免在运行时的[编译性能][Link 1]消耗和内存消耗
>  *  可以在程序运行初期就达到最高性能
>  *  可以显著的加快程序的启动
> 
> ### 3.2 缺点 ###
> 
> 1.  程序运行时动态调整的资源无法直接使用，例如反射、动态代理等，需要在代码中通过Hint为编译器指定
> 2.  应用的classpath在编译后就固定了，不能动态调整
> 3.  类不会延迟加载（lazy loading），应用启动时一次性加载完成
> 4.  部分java切面（AOP）技术不支持
> 5.  编译时间长
> 6.  牺牲了跨平台的的优势
> 7.  将提前编译的内容保存会占用更多的外存
> 
> ### 3.3 JIT优点 ###
> 
>  顺便说一下JIT
> 
>  *  可以根据当前硬件情况实时编译生成最优机器指令（ps. AOT也可以做到，在用户使用是使用[字节码][Link 2]根据机器情况在做一次编译）
>  *  可以根据当前程序的运行情况生成最优的[机器指令][Link 3]序列
>  *  当程序需要支持[动态链接][Link 4]时，只能使用JIT
>  *  可以根据进程中内存的实际情况调整代码，使内存能够更充分的利用
> 
> ### 3.4 JIT缺点 ###
> 
>  *  编译需要占用运行时资源，会导致进程卡顿
>  *  由于编译时间需要占用运行时间，对于某些代码的[编译优化][Link 5]不能完全支持，需要在[程序流畅][Link 6]和编译时间之间做权衡
>  *  在编译准备和识别频繁使用的方法需要占用时间，使得初始编译不能达到最高性能
> 
> ## 四、单元测试 ##
> 
> 传统的Spring Boot3单元测试技术仍然可以使用。需要注意的是 Spring Native不支持JUnit4，需要使用JUnit5。

[8ee80b6371e449d9849600e293c190bb.png]: https://img-blog.csdnimg.cn/8ee80b6371e449d9849600e293c190bb.png
[https_www.oracle.com_downloads_graalvm-downloads.html]: https://www.oracle.com/downloads/graalvm-downloads.html%E3%80%82
[7b3b9b3b1aaf4103800d1e69df936b54.png]: https://img-blog.csdnimg.cn/7b3b9b3b1aaf4103800d1e69df936b54.png
[Release GraalVM Community Edition 22.3.0 _ graalvm_graalvm-ce-builds _github.com]: https://github.com/graalvm/graalvm-ce-builds/releases/tag/vm-22.3.0
[f14537e38d8d4124b777e064f4f45be9.png]: https://img-blog.csdnimg.cn/f14537e38d8d4124b777e064f4f45be9.png
[d600ba32dfdf43dba42970ad3a99c3e4.png]: https://img-blog.csdnimg.cn/d600ba32dfdf43dba42970ad3a99c3e4.png
[12ba56e37c3944bfb942d4d7394c055e.png]: https://img-blog.csdnimg.cn/12ba56e37c3944bfb942d4d7394c055e.png
[e438780d2d58429b91d7376ea2a5ab54.png]: https://img-blog.csdnimg.cn/e438780d2d58429b91d7376ea2a5ab54.png
[2a91f59c65bb4937bfe079c534a73b02.png]: https://img-blog.csdnimg.cn/2a91f59c65bb4937bfe079c534a73b02.png
[919c8dc92ee747f1a77e5a80c61549c0.png]: https://img-blog.csdnimg.cn/919c8dc92ee747f1a77e5a80c61549c0.png
[d2645271b76d4005965b2cd376b41ae4.png]: https://img-blog.csdnimg.cn/d2645271b76d4005965b2cd376b41ae4.png
[0e989ca56b784ce1aa87cb80d8926b80.png]: https://img-blog.csdnimg.cn/0e989ca56b784ce1aa87cb80d8926b80.png
[6e4a4aa66fac489ebf0790579915a991.png]: https://img-blog.csdnimg.cn/6e4a4aa66fac489ebf0790579915a991.png
[f2acfc8b3cbf47cc86fb0f5feb7e2642.png]: https://img-blog.csdnimg.cn/f2acfc8b3cbf47cc86fb0f5feb7e2642.png
[a2c66844992b4477a3f3d9faef9ad3b6.png]: https://img-blog.csdnimg.cn/a2c66844992b4477a3f3d9faef9ad3b6.png
[f4f10c76fcb5486d8ca171ef30f72986.png]: https://img-blog.csdnimg.cn/f4f10c76fcb5486d8ca171ef30f72986.png
[3eaa28de46814583981c33ee4b0b8509.png]: https://img-blog.csdnimg.cn/3eaa28de46814583981c33ee4b0b8509.png
[SpringBoot3 Graalvm Native-Image_Zyp168168_-CSDN]: https://blog.csdn.net/Zyp689/article/details/129042024
[Link 1]: https://www.zhihu.com/search?q=%E7%BC%96%E8%AF%91%E6%80%A7%E8%83%BD&search_source=Entity&hybrid_search_source=Entity&hybrid_search_extra=%7B%22sourceType%22%3A%22answer%22%2C%22sourceId%22%3A2009699464%7D
[Link 2]: https://www.zhihu.com/search?q=%E5%AD%97%E8%8A%82%E7%A0%81&search_source=Entity&hybrid_search_source=Entity&hybrid_search_extra=%7B%22sourceType%22%3A%22answer%22%2C%22sourceId%22%3A2009699464%7D
[Link 3]: https://www.zhihu.com/search?q=%E6%9C%BA%E5%99%A8%E6%8C%87%E4%BB%A4&search_source=Entity&hybrid_search_source=Entity&hybrid_search_extra=%7B%22sourceType%22%3A%22answer%22%2C%22sourceId%22%3A2009699464%7D
[Link 4]: https://www.zhihu.com/search?q=%E5%8A%A8%E6%80%81%E9%93%BE%E6%8E%A5&search_source=Entity&hybrid_search_source=Entity&hybrid_search_extra=%7B%22sourceType%22%3A%22answer%22%2C%22sourceId%22%3A2009699464%7D
[Link 5]: https://www.zhihu.com/search?q=%E7%BC%96%E8%AF%91%E4%BC%98%E5%8C%96&search_source=Entity&hybrid_search_source=Entity&hybrid_search_extra=%7B%22sourceType%22%3A%22answer%22%2C%22sourceId%22%3A2009699464%7D
[Link 6]: https://www.zhihu.com/search?q=%E7%A8%8B%E5%BA%8F%E6%B5%81%E7%95%85&search_source=Entity&hybrid_search_source=Entity&hybrid_search_extra=%7B%22sourceType%22%3A%22answer%22%2C%22sourceId%22%3A2009699464%7D