簡介

本文介紹SpringBoot3如何整合graalvm，并打包為可執(zhí)行文件。Windows和Linux都打包。

版本

• springboot3.3.6
• graalvm21（包含JDK21（21是最新的LTS版本，SpringBoot3最低要求JDK17））

安裝graalvm

1.下載

官網(wǎng)：https://www.graalvm.org/

進去后點擊下載，即可找到：

下載后得到此文件：graalvm-jdk-21_windows-x64_bin.zip

（JDK21不需要下載native-image了，因為已經(jīng)捆綁到bin目錄了。直接在bin目錄下cmd輸入native-image即可）

2.安裝

將graalvm-jdk-21_windows-x64_bin.zip解壓到指定目錄，我這里解壓到：E:\work\develop_env\graalvm\graalvm-jdk-21_windows-x64_bin

把JDK環(huán)境變量配置為GraalVM的路徑（因為GraalVM就是JDK）。

由于我要同時用JDK8和JDK21，所以要配置一下，見：Windows使用多個JDK的方法

創(chuàng)建SpringBoot項目

跟原來SpringBoot2的項目結(jié)構(gòu)是一樣的。

依賴及代碼

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.3.6</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.knife</groupId>
    <artifactId>Demo_SpringBoot3</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>Demo_SpringBoot3</name>
    <description>Demo project for Spring Boot3</description>

    <properties>
        <java.version>21</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <scope>provided</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <!-- AOT Graalvm 插件 -->
            <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>

            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <!-- <version>3.5.1</version> -->
                <!-- 指定maven編譯的jdk版本。對于JDK8，寫成8或者1.8都可以 -->
                <configuration>
                    <source>${java.version}</source>
                    <target>${java.version}</target>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

Controller

package com.knife.example.controller;

import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@Slf4j
@RequestMapping("test")
@RestController
public class HelloController {

    @GetMapping("test1")
    public String test1() {
        return "success";
    }
}

啟動與測試

啟動

Connected to the target VM, address: '127.0.0.1:52251', transport: 'socket'

  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/

 :: Spring Boot ::                (v3.3.6)

2024-11-29T15:09:52.849+08:00  INFO 43480 --- [           main] com.knife.example.DemoApplication        : Starting DemoApplication using Java 21.0.5 with PID 43480 (E:\project\Idea_Proj\Demo_Java\Demo_SpringBoot3\target\classes started by aaabbb in E:\project\Idea_Proj\Demo_Java\Demo_SpringBoot3)
2024-11-29T15:09:52.852+08:00  INFO 43480 --- [           main] com.knife.example.DemoApplication        : No active profile set, falling back to 1 default profile: "default"
2024-11-29T15:09:53.549+08:00  INFO 43480 --- [           main] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat initialized with port 8080 (http)
2024-11-29T15:09:53.561+08:00  INFO 43480 --- [           main] o.apache.catalina.core.StandardService   : Starting service [Tomcat]
2024-11-29T15:09:53.562+08:00  INFO 43480 --- [           main] o.apache.catalina.core.StandardEngine    : Starting Servlet engine: [Apache Tomcat/10.1.33]
2024-11-29T15:09:53.612+08:00  INFO 43480 --- [           main] o.a.c.c.C.[Tomcat].[localhost].[/]       : Initializing Spring embedded WebApplicationContext
2024-11-29T15:09:53.613+08:00  INFO 43480 --- [           main] w.s.c.ServletWebServerApplicationContext : Root WebApplicationContext: initialization completed in 715 ms
2024-11-29T15:09:53.925+08:00  INFO 43480 --- [           main] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat started on port 8080 (http) with context path '/'
2024-11-29T15:09:53.933+08:00  INFO 43480 --- [           main] com.knife.example.DemoApplication        : Started DemoApplication in 1.439 seconds (process running for 2.028)
2024-11-29T15:09:56.814+08:00  INFO 43480 --- [nio-8080-exec-1] o.a.c.c.C.[Tomcat].[localhost].[/]       : Initializing Spring DispatcherServlet 'dispatcherServlet'
2024-11-29T15:09:56.814+08:00  INFO 43480 --- [nio-8080-exec-1] o.s.web.servlet.DispatcherServlet        : Initializing Servlet 'dispatcherServlet'
2024-11-29T15:09:56.815+08:00  INFO 43480 --- [nio-8080-exec-1] o.s.web.servlet.DispatcherServlet        : Completed initialization in 1 ms

測試接口

訪問：http://localhost:8080/test/test1

結(jié)果：

打包為可執(zhí)行文件(Windows的.exe)

從上邊來看，好像與SpringBoot2沒啥區(qū)別。但SpringBoot3有一個重要改動：可以打包為可執(zhí)行文件，比如：Windows的.exe文件，可以直接執(zhí)行。性能強、啟動快、占內(nèi)存低。

下邊就實戰(zhàn)一下打包為可執(zhí)行文件。

1.下載Visual Studio組件

Windows使用native-image 打包需要C++環(huán)境，VisualStudio 可以提供c++開發(fā)環(huán)境，所以我們要先下載安裝好VisualStudio。

必須安裝VisualStudio組件，否則在下邊mvn -Pnative native:compile時會報錯：

Error: Failed to find 'vcvarsall.bat' in a Visual Studio installation.
Please make sure that Visual Studio 2022 version 17.1.0 or later is installed on your system. You can download it at https://visualstudio.microsoft.com/downloads/. If this error persists, please try and run GraalVM Native Image in an x64 Native Tools Command Prompt or file a ticket.

下載

地址：https://visualstudio.microsoft.com/zh-hans/

進去后點擊這里：

點擊完后，會自動下載VisualStudioSetup.exe

2.安裝Visual Studio組件

雙擊VisualStudioSetup.exe，點擊繼續(xù)，然后到如下界面：

選擇正確版本的SDK

運行cmd，輸入VER并回車，即可得到版本，找最接近的即可。

選擇英文語言包

修改安裝位置：

注意：記住這個位置，后邊要用。

最后點擊安裝：

正在安裝：

安裝完成

如果上邊有操作錯誤，可以點擊修改：

刪除無用的安裝包，之前選定了下載緩存，把它刪掉，我的目錄是：

D:\ProgramData\Microsoft\VisualStudio\Packages

3.配置環(huán)境變量

配置VS環(huán)境變量

1.新建VISUAL_STUDIO系統(tǒng)變量

指定到自己的VS路徑

2.Path添加VISUAL_STUDIO的bin路徑

即：%VISUAL_STUDIO%\VC\Tools\MSVC\14.42.34433\bin\Hostx64\x64

3. 添加INCLUDE環(huán)境變量

我上邊設(shè)置的套件安裝位置是：E:\work\develop_env\visual_studio，Windows Kits自動安裝到了這里：E:\Windows Kits。為統(tǒng)一管理，我把E:\Windows Kits復(fù)制到E:\work\develop_env\visual_studio\下邊。

（如果沒改過路徑，那會在這個路徑下：C:\Program Files (x86)\Windows Kits\）

然后添加環(huán)境變量：

%VISUAL_STUDIO%\VC\Tools\MSVC\14.42.34433\include;E:\work\develop_env\visual_studio\Windows Kits\10\Include\10.0.19041.0\shared;E:\work\develop_env\visual_studio\Windows Kits\10\Include\10.0.19041.0\ucrt;E:\work\develop_env\visual_studio\Windows Kits\10\Include\10.0.19041.0\um;E:\work\develop_env\visual_studio\Windows Kits\10\Include\10.0.19041.0\winrt

即：

4.添加lib環(huán)境變量

與上邊INCLUDE類似。

添加lib環(huán)境變量，值為：

%VISUAL_STUDIO%\VC\Tools\MSVC\14.42.34433\lib\x64;E:\work\develop_env\visual_studio\Windows Kits\10\Lib\10.0.19041.0\ucrt\x64;E:\work\develop_env\visual_studio\Windows Kits\10\Lib\10.0.19041.0\um\x64

即：

4.打包

打包的步驟如下。

mvn clean
mvn compile
mvn spring-boot:process-aot
mvn -Pnative native:compile

第四步才會生成.jar和.exe文件。

以上四個步驟，可以在Idea里運行（但是必須在上一步配置完環(huán)境變量后，重啟Idea，否則環(huán)境變量不生效！）：

結(jié)果：

主要步驟

[1/8] Initializing...
[2/8] Performing analysis...
[3/8] Building universe...
[4/8] Parsing methods...
[5/8] Inlining methods...
[6/8] Compiling methods...
[7/8] Layouting methods...
[8/8] Creating image...

看結(jié)果文件：

對比一下jar和exe大?。海?exe文件竟然是.jar的四倍）

備注

有人說必須用官方命令行工具，不能用Idea等，其實是因為配置完環(huán)境變量后沒有重啟Idea，導(dǎo)致沒編譯成功。

官方雖然有說明：

但是，只要重啟Idea，就能直接用Idea去通過點擊直接操作！

5.運行.exe

直接雙擊Demo_SpringBoot3.exe即可運行：

測試一下它的接口：（成功訪問）

6.對比內(nèi)存占用

先看上邊.exe的內(nèi)存占用：

把它關(guān)掉，運行一下jar看一下

可見，單純看.exe和.jar的內(nèi)存占用的話：

• .exe：29MB
• .jar：154MB

打包為可執(zhí)行文件(Linux)

目標(biāo)：打包為Ubuntu的可執(zhí)行文件，本處我的Ubuntu版本：2022.04.04，x86_64架構(gòu)。

備注：無法在Windows下交叉編譯，只能到Linux里直接編譯。

1.下載graalvm（Linux版）

官網(wǎng)：https://www.graalvm.org/

進去后點擊下載，即可找到：

我的Ubuntu是x86_64，所以下載這個：

下載后得到此文件：graalvm-jdk-21_linux-x64_bin.tar.gz

（JDK21不需要下載native-image了，因為已經(jīng)捆綁到bin目錄了）

2.配置Ubuntu宿主機環(huán)境變量

將上邊文件上傳到Ubuntu宿主機，這里我上傳到此路徑：/work/env/graalvm/

解壓一下：

tar xf graalvm-jdk-21_linux-x64_bin.tar.gz

解壓之后：

執(zhí)行兩條命令：

export JAVA_HOME=/work/env/graalvm/graalvm-jdk-21.0.5+9.1
export PATH=$PATH:$JAVA_HOME/bin

執(zhí)行一下java看看：

3.用Docker搭建maven

見：Docker Compose--安裝本地maven

4.Maven容器配置環(huán)境變量

將graalvm復(fù)制到maven容器路徑：這里我復(fù)制到：/work/env/maven/tool/graalvm/

執(zhí)行兩條命令：

export JAVA_HOME=/tool/graalvm/graalvm-jdk-21.0.5+9.1
export PATH=$PATH:$JAVA_HOME/bin

驗證Java版本：java -version

驗證native-image：native-image --version

5.Maven容器安裝編譯工具

apt update
apt install build-essential libz-dev zlib1g-dev

native-image要用到二進制編譯工具，所以要安裝編譯工具。

6.Maven容器打包

將項目上傳到Linux服務(wù)器，然后把它打包為二進制文件。

先把項目打包：tar czf Demo_SpringBoot3.tar.gz Demo_SpringBoot3/

我直接用Windows下的git bash工具：

把Demo_SpringBoot3.tar.gz上傳到Linux服務(wù)器。

我放到此目錄：/work/env/maven/app。將其解壓：

tar xf Demo_SpringBoot3.tar.gz

結(jié)果：

進入maven容器

docker exec -it maven_3.9 bash

進入/app/Demo_SpringBoot3執(zhí)行打包命令：

mvn clean
mvn compile
mvn spring-boot:process-aot
mvn -Pnative native:compile

結(jié)果（用的虛擬機，運行有點慢，用了十幾分鐘）：

7.運行可執(zhí)行文件

進入宿主機，進入target目錄：/work/env/maven/app/Demo_SpringBoot3/target

執(zhí)行：./Demo_SpringBoot3

訪問： http://192.168.5.193:8080/test/test1

成功！

8.對比內(nèi)存占用

看二進制執(zhí)行時的占用：

關(guān)掉它，執(zhí)行一下.jar試試

可見，物理內(nèi)存占用：

• 二進制：80m
• .jar：169m總結(jié)

總結(jié)

以上為個人經(jīng)驗，希望能給大家一個參考，也希望大家多多支持腳本之家。