Windows下使用GraalVM+Maven+Picocli快速构建Java cli原生命令行工具

前言

云计算时代，Java即将重获新生！

在传统企业应用开发中，使用Java开发的程序依赖笨重的JDK运行环境，体积庞大；并且大多数流行的Java开发框架使用动态代理等特性来简化开发体验，但是却使得Java程序在启动过程中需要动态生成字节码，导致启动速度缓慢。

这些问题在过去的单点应用和分布式系统中并没有体现出很大的劣势，但在云计算的今天，大量服务使用Docker和Kubernetes构建和管理，无状态服务架构流行，这要求程序需要更小的体积以便于在庞大的云平台中分发、以及需要更快的启动速度。

而且程序体积庞大也使得Java与构建命令行小工具无缘。

但是，这些问题随着Oracle主导的GraalVM项目的日渐成熟，有了解决方案。

并且，Java的野心绝不只是追赶！

GraalVM简介：

官网：https://www.graalvm.org/

官网首页列出了三条特性：

• 增加应用程序吞吐量并减少延迟
• 将应用程序编译成自包含的小型本机二进制文件
• 无缝地使用多种语言和库

本文将使用GraalVM的第二条特性，使用Maven，结合Picocli库快速构建一个功能完整Java cli命令行工具。

环境准备

安装Visual Studio 2019 Visual C++ Build Tools

1. 下载链接：https://aka.ms/vs/16/release/vs_buildtools.exe

2. 下载完成后双击 vs_BuildTools.exe

3. 选中C++生成工具，记住安装位置，点击安装（安装完成后大约需要3G左右空间）

4. 安装完成（如果提示需要重启电脑，请按提示重启电脑）

安装GraalVM Community 20.3.0

1. 下载 graalvm-ce-java11-windows-amd64-20.3.0.zip（或者访问Gihub下载：https://github.com/graalvm/graalvm-ce-builds/releases/tag/vm-20.3.0）
2. 解压（我的解压路径为C:\Software\graalvm-ce-java11-20.3.0）
3. 设置环境变量

由于GraalVM兼容JDK平台，安装GraalVM相当于是安装了新的Java环境，如果不想替换原有的Java环境变量，可在控制台设置临时的环境变量

set GRAALVM_HOME=C:\Software\graalvm-ce-java11-20.3.0
set JAVA_HOME=%GRAALVM_HOME%
set Path=%GRAALVM_HOME%\bin;%Path%
1
2
3

4. 验证安装

> %GRAALVM_HOME%\bin\java -version
openjdk version "11.0.9" 2020-10-20
OpenJDK Runtime Environment GraalVM CE 20.3.0 (build 11.0.9+10-jvmci-20.3-b06)
OpenJDK 64-Bit Server VM GraalVM CE 20.3.0 (build 11.0.9+10-jvmci-20.3-b06, mixed mode, sharing)
1
2
3
4

安装native-image工具

• 离线安装：

1. 下载 native-image-installable-svm-java11-windows-amd64-20.3.0.jar (我的路径为C:\Software\native-image-installable-svm-java11-windows-amd64-20.3.0.jar)

2. 安装

> %GRAALVM_HOME%\bin\gu -L install C:\Software\native-image-installable-svm-java11-windows-amd64-20.3.0.jar
1

• 在线安装（从github安装，国内下载速度过慢）：

> %GRAALVM_HOME%\bin\gu install native-image
1

创建Maven quickstart项目

添加Picocli Maven依赖

Picocli是一个用于方便构建cli工具的类库。

Picocli官网：https://picocli.info/

<dependency>
    <groupId>info.picocli</groupId>
    <artifactId>picocli</artifactId>
    <version>4.5.2</version>
</dependency>

<dependency>
    <groupId>info.picocli</groupId>
    <artifactId>picocli-jansi-graalvm</artifactId>
    <version>1.2.0</version>
</dependency>
1
2
3
4
5
6
7
8
9
10
11

添加Maven插件

<build>
    <plugins>

        <!-- native-image-maven-plugin使用生成native image -->
        <plugin>
            <groupId>org.graalvm.nativeimage</groupId>
            <artifactId>native-image-maven-plugin</artifactId>
            <version>20.3.0</version>
            <configuration>
                <!-- imageName用于设置生成的二进制文件名称 -->
                <imageName>checksum</imageName>
                <!-- mainClass用于指定main方法类路径 -->
                <mainClass>org.example.CheckSum</mainClass>
                <!-- native image 编译参数文档：https://docs.oracle.com/en/graalvm/enterprise/20/docs/reference-manual/native-image/NativeImageMavenPlugin/ -->
                <buildArgs>
                    --no-fallback
                </buildArgs>
            </configuration>
            <executions>
                <execution>
                    <goals>
                        <goal>native-image</goal>
                    </goals>
                    <phase>package</phase>
                </execution>
            </executions>
        </plugin>
        
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <!-- annotationProcessorPaths requires maven-compiler-plugin version 3.5 or higher -->
            <version>3.8.1</version>
            <configuration>
                <!-- annotationProcessorPaths用于picocli弥补目前GraalVM native image对于反射、resources和动态代理的支持不足 -->
                <annotationProcessorPaths>
                    <path>
                        <groupId>info.picocli</groupId>
                        <artifactId>picocli-codegen</artifactId>
                        <version>4.5.2</version>
                    </path>
                </annotationProcessorPaths>
                <compilerArgs>
                    <arg>-Aproject=${project.groupId}/${project.artifactId}</arg>
                </compilerArgs>
            </configuration>
        </plugin>
    </plugins>
</build>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

增加小工具逻辑

这里借用infoq上的CheckSum生成文件摘要的小工具代码，详情参见：https://www.infoq.cn/article/4RRJuxPRE80h7YsHZJtX

import picocli.CommandLine;
import picocli.CommandLine.Command;
import picocli.CommandLine.Option;
import picocli.CommandLine.Parameters;
import picocli.jansi.graalvm.AnsiConsole;

import java.io.File;
import java.math.BigInteger;
import java.nio.file.Files;
import java.security.MessageDigest;
import java.util.concurrent.Callable;

@Command(
        name = "checksum",
        mixinStandardHelpOptions = true,
        version = "checksum 4.0",
        description = "Prints the checksum (MD5 by default) of a file to STDOUT."
)
public class CheckSum implements Callable<Integer> {

    @Parameters(
            index = "0",
            arity = "1",
            description = "The file whose checksum to calculate."
    )
    private File file;

    @Option(
            names = {"-a", "--algorithm"},
            description = "MD5, SHA-1, SHA-256, ..."
    )
    private String algorithm = "MD5";

    // this example implements Callable, so parsing, error handling
    // and handling user requests for usage help or version help
    // can be done with one line of code.
    public static void main(String... args) {
        /*int exitCode = new CommandLine(new CheckSum()).execute(args);
        System.exit(exitCode);*/

        int exitCode = 0;
        // enable colors on Windows
        try (AnsiConsole ansi = AnsiConsole.windowsInstall()) {
            exitCode = new CommandLine(new CheckSum()).execute(args);
        }
        System.exit(exitCode);
    }

    @Override
    public Integer call() throws Exception { // the business logic...
        byte[] data = Files.readAllBytes(file.toPath());
        byte[] digest = MessageDigest.getInstance(algorithm).digest(data);
        String format = "%0" + (digest.length * 2) + "x%n";
        System.out.printf(format, new BigInteger(1, digest));
        return 0;
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

编译

建议使用Window cmd或者Windows Powershell执行mvn package命令编译，我在测试的过程中使用IntelliJ IDEA的Maven插件package选项编译时报错。

执行mvn package的控制台中需要有C++构建工具环境，我们在安装Visual Studio 2019 Visual C++ Build Tools后并不会自动添加环境变量，我们需要自行执行安装目录C:\Program Files (x86)\Microsoft Visual Studio\2019\BuildTools\VC\Auxiliary\Build\（默认安装路径）目录下的vcvars64.bat脚本设置环境变量，此设置只在当前控制台临时生效的。因此我们可以以如下方式执行编译：

Window cmd下执行：

"C:\Program Files (x86)\Microsoft Visual Studio\2019\BuildTools\VC\Auxiliary\Build\vcvars64.bat" && mvn package
1

或者Windows Powershell下执行：

cmd /c 'call "C:\Program Files (x86)\Microsoft Visual Studio\2019\BuildTools\VC\Auxiliary\Build\vcvars64.bat" && mvn package'
1

或者加上最开始的环境变量设置的话，全部的命令如下（打开新的cmd窗口复制如下全部命令即可编译成功）：

set GRAALVM_HOME=C:\Software\graalvm-ce-java11-20.3.0
set JAVA_HOME=%GRAALVM_HOME%
set Path=%GRAALVM_HOME%\bin;%Path%
"C:\Program Files (x86)\Microsoft Visual Studio\2019\BuildTools\VC\Auxiliary\Build\vcvars64.bat"
mvn package

1
2
3
4
5
6

编译过程可能导致某些防病毒软件触发拦截，请按提示允许运行或者暂时退出防病毒软件

编译成功后会在项目目录的target目录下生成exe文件，大小14.8M。

运行

源码

https://gitee.com/jthinking/native-image-test.git

总结

目前Java生成原生可执行程序虽然没有Golang那种便捷，生成的可执行文件也比同等功能的Golang程序大好多，但是Java平台的更新速度非常快速，相信会越来越好！

参考

• https://www.infoq.cn/article/4RRJuxPRE80h7YsHZJtX
• https://docs.oracle.com/en/graalvm/enterprise/20/docs/reference-manual/native-image/NativeImageMavenPlugin/
• https://picocli.info/
• https://quarkus.io/guides/building-native-image