SpringBoot3.x原生镜像-Native Image尝鲜

前提

Spring团队致力于为Spring应用程序供给原生映像支撑现已有一段时间了。在SpringBoo2.x的Spring Native实验项目中酝酿了3年多之后，跟着Spring Framework 6和Spring Boot 3的发布，对应的项目便是Spring Native，原生镜像支撑将会发布GA版别（换言之便是，Native Image相关支撑会在Spring Boot 3的GA版别中一起发布）。

前面这一段简介摘录自参考资料中的《Native Support in Spring Boot 3.0.0-M5》

笔者在写这篇文章（2022-10-28）前后SpringBoot没有发布3.x GA，版别3.0.0-M5+算是GA前相对稳定的版别，这里选用当时3.x的最新非GA版别3.0.0-RC1进行调研。

什么是Native Image

Native Image，这里直译为原生镜像或许本地镜像，是一种提前将（Java）代码编译为二进制文件（原生可履行文件，native executable）的技能。原生可履行文件只包括运转时所需要的代码，即应用程序类、标准库类、言语运转时和来自JDK的静态链接的原生代码（也便是这样的二进制文件可以直接运转，不需要额定装置JDK）。由原生镜像生成的可履行文件有几个重要的长处：

• 运用Java虚拟机所需资源的一小部分，因而运转本钱更低
• 发动时间大幅度下降，以毫秒为单位
• 不需要进行预热即可供给最佳功用
• 可以打包到轻量级容器映像中以便快速有效地部署
• 减少了攻击面（这个和网络安全相关）

Spring Boot 3中运用GraalVM计划供给Native Image支撑。

装置GraalVM

在www.graalvm.org/downloads -…页面中下载对应操作系统的GraalVM：

笔者开发环境运用的操作系统是Windows10，下载和选用下图中的装置包：

解压完结后装备一下JAVA_HOME、GRAALVM_HOME而且把GRAALVM_HOME\bin添加到PATH中。完结后可以履行一下java -version进行验证：

如果现已装置了其他版别的JDK，先暂时全局替换为GraalVM，也便是JAVA_HOME、GRAALVM_HOME一起装备为GraalVM的解压目录，由于现在看来这样做才干正常打包原生镜像

确定GraalVM版别无误，到此装置完结。另外，需要装备好了Maven，主张重新装置一个3.6.x+版别的Maven而且把MAVEN_HOME\bin添加到PATH中。

编写应用程序

新建一个命名为spring-boot-native-image的Maven项目或许模块，选用方才下载好的GraalVM：

项目的POM文件引入下面几组依靠：

• spring的快照repository，由于需要下载RC1版别依靠，暂时不能从中央仓库拉取
• spring-boot-starter-parent，定义版别为RC1
• native-maven-plugin插件，用于原生镜像打包
• spring-boot-starter-web，用于构建一个简单的web项目

<!-- spring-boot-starter-parent -->
<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>3.0.0-RC1</version>
</parent>
<!-- repository -->
<repositories>
    <repository>
        <id>spring-snapshots</id>
        <url>https://repo.spring.io/snapshot</url>
        <snapshots>
            <enabled>true</enabled>
        </snapshots>
    </repository>
    <repository>
        <id>spring-milestones</id>
        <url>https://repo.spring.io/milestone</url>
    </repository>
</repositories>
<pluginRepositories>
    <pluginRepository>
        <id>spring-snapshots</id>
        <url>https://repo.spring.io/snapshot</url>
    </pluginRepository>
    <pluginRepository>
        <id>spring-milestones</id>
        <url>https://repo.spring.io/milestone</url>
    </pluginRepository>
</pluginRepositories>
<!-- spring-boot-starter-web -->
<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
</dependencies>
<!-- native-maven-plugin -->
<plugins>
    <plugin>
        <groupId>org.graalvm.buildtools</groupId>
        <artifactId>native-maven-plugin</artifactId>
        <version>0.9.16</version>
        <extensions>true</extensions>
        <executions>
            <execution>
                <id>build-native</id>
                <goals>
                    <goal>compile-no-fork</goal>
                </goals>
                <phase>package</phase>
            </execution>
            <execution>
                <id>test-native</id>
                <goals>
                    <goal>test</goal>
                </goals>
                <phase>test</phase>
            </execution>
        </executions>
        <configuration>
            <mainClass>cn.vlts.NativeApplication</mainClass>
            <imageName>native-app</imageName>
            <buildArgs>
                <buildArg>--verbose</buildArg>
            </buildArgs>
        </configuration>
    </plugin>
</plugins>

终究的POM文件看起来如下：

项目中只有一个发动类cn.vlts.NativeApplication，编写了main办法和一个用于集成测试的控制器办法：

@RestController
@SpringBootApplication
public class NativeApplication {
    public static void main(String[] args) {
        SpringApplication.run(NativeApplication.class, args);
    }
    @GetMapping(path = "/hello")
    public ResponseEntity<String> hello() {
        return ResponseEntity.ok("world");
    }
}

打包和调试

完结项目装备和代码编写后，履行下面的Maven指令进行打包：

mvn package -Pnative

打包过程可能会遇到下面的问题：

• 最有可能的问题：Default native-compiler executable 'cl.exe' not found via environment variable PATH

处理计划在Stackoverflow对应的问题答复中找到：

其实便是在Window操作系统开发环境下基于GraalVM构建原生镜像依靠Microsoft Visual C++ (MSVC)，主张装置MSVC 2017 15.5.5+，可以装置Visual Studio (2019)而且装置对应的MSVC。

由于很早之前笔者在调试Rust时候现已装置过Visual Studio 2019用于其debug东西链，这里无须进行装置。在装置Visual Studio勾选MSVC vXXX的组件进行装置即可，然后需要把对应的MSVC东西的bin目录添加到PATH中（这个目录一般是VS_HOME\VC\Tools\MSVC\版别号\bin\Hostx64\x64）：

• 其次可能遇到的问题：打包过程出现stdio.h库文件报错或许找不到主类Main entry point class 'app.jar' not found x.y.Application

其实仍是由于MSVC的问题，在GraalVM文档中有提示如下：

简单来说便是必须在Visual Studio自带的指令行东西x64 Native Tools Command Prompt中履行native image相关指令，这个指令行东西初始化如下：

在x64 Native Tools Command Prompt中先进入目标项目根目录，然后履行mvn -Pnative package：

终究看到BUILD SUCCESS字眼，项目的target目录下可以看到一个.exe和一个.jar文件，而.exe文件便是前面一直提到的可履行的二进制文件：

直接运转它：

可以看到这个文件运转彻底不依靠外部Java虚拟机，而且发动速度极快（600毫秒左右），可以用POSTMAN等东西测试程序接口：

到此可以验证程序功用正常。

小结

SpringBoot3.x原生镜像正式发布后会是SpringBoot在云原生范畴的一个巨大进步，让我们拭目以待。可是就现在来看，常用的Windows开发环境下想要尝试native image技能需要处理比较多的问题，Linux和Unix渠道下没有验证，期望后面的版别迭代可以降低运用难度而且支撑一个指令多渠道打包的功用。

参考资料：

• Native Support in Spring Boot 3.0.0-M5
• GraalVM – Quick Start Guide

（本文完 c-2-d e-a-20221030）