JavaFX 打包示例（完结篇）
English | 中文
## 分支说明 - `java21` 使用`Maven`，`Gradle`和`GraalVM`打包一个模块化的JavaFX项目。 - `java21-non-modular` [链接](https://github.com/JavaFX-Starter/JavaFX-Package-Sample/tree/java21-non-modular) 使用 `Maven`打包一个非模块化的JavaFX项目。 - `java22-win32` [链接](https://github.com/JavaFX-Starter/JavaFX-Package-Sample/tree/java22-win32) 一个利用 `Foreign Function and Memory (FFM) API`实现Windows全局键盘事件监听的JavaFX项目。 ## HelloWorld [链接](https://github.com/icuxika/HelloWorld) 这个项目演示了如何完全使用`PowerShell7`来编译一个Java项目并创建可执行的jar包和可运行exe文件，项目存在包结构并引入第三方依赖。 ## 环境设置 #### `jpackage` 构建出安装包依赖的程序（如果只需要构建出可执行程序就可以跳过此配置） - Windows: 需要安装 [WIX TOOLSET](https://wixtoolset.org/) ，并将其bin目录添加到环境变量中 - macOS/Linux: 缺失的包一般可以根据提示通过包管理器直接安装 #### 在IDEA中构建项目 - 项目结构 SDK 选择 JDK21 - Gradle：Settings -> Build, Execution, Deployment -> Build Tools -> Gradle -> 指定 Gradle JVM 为项目 SDK #### 使用命令行（此处演示使用Windows的PowerShell，macOS和Linux假设你熟悉在命令行中设置临时环境变量） > `$env:xxx = "yyyy"`是设置一个临时环境变量，重启终端或者开启一些新的PowerShell标签页会失效 - 设置`JAVA_HOME`环境变量 `$env:JAVA_HOME = "C:\CommandLineTools\Java\jdk-21\"` - > 使用 `gradlew`或者`mvn`的时候，只需要存在`JAVA_HOME`这个环境变量就可以，不需要`java`等命令配置在环境变量PATH中 - 设置`GRAALVM_HOME`环境变量 `$env:GRAALVM_HOME = "C:\CommandLineTools\Java\graalvm-jdk-21+35.1"` - 设置`JAVA_TOOL_OPTIONS`环境变量可以为`gradle`设置代理 `$env:JAVA_TOOL_OPTIONS = "-DsocksProxyHost=localhost -DsocksProxyPort=7890"` - 若要进行`GraalVM`构建，需要使用`Maven 3.8.8` ## 项目构建 ### `jpackage` ##### gradle > 构建可执行程序 ```shell .\gradlew.bat jpackageImage ``` > 构建安装包 ```shell .\gradlew.bat jpackage ``` ##### maven 请根据不同操作系统修改`exec-maven-plugin`插件中有关下方两个命令的`--icon`的参数值，Windows为 `${project.basedir}/src/main/resources/application.ico`，macOS为`${project.basedir}/src/main/resources/application.icns` ，Linux为`${project.basedir}/src/main/resources/application.png` > 运行（Maven plugin for JavaFX） ```shell mvn javafx:run ``` > 构建出`.bat`形式的可执行程序（Maven plugin for JavaFX） ```shell mvn javafx:jlink ``` > 构建可执行程序（手动拼接jpackage命令），`此命令构建出的结果其实与上面差别不大，但是是.exe的形式，并且图标已经设置好了` ```shell mvn clean mvn package mvn exec:exec@image ``` > 构建安装包（手动拼接jpackage命令） ```shell mvn clean mvn package mvn exec:exec@installer ``` ### `Oracle GraalVM` - 下载[Oracle GraalVM](https://www.graalvm.org/downloads/) - 请运行在由`Visual Studio`提供的命令行环境中，`Windows 终端`可以直接在标签页中打开`Developer PowerShell for VS 2022` ，其他用户可以在开始菜单的`Visual Studio 2022`文件夹中找到 - 不关注 `module-info.java` 文件的存在与否 #### JAVA_HOME和GRAALVM_HOME可以设置为相同值 ```shell > $env:JAVA_HOME C:\CommandLineTools\Java\graalvm-jdk-21.0.2+13.1\ > $env:GRAALVM_HOME C:\CommandLineTools\Java\graalvm-jdk-21.0.2+13.1\ ``` #### 此项目使用的 Oracle GraalVM 版本 ```shell java 21.0.2 2024-01-16 LTS Java(TM) SE Runtime Environment Oracle GraalVM 21.0.2+13.1 (build 21.0.2+13-LTS-jvmci-23.1-b30) Java HotSpot(TM) 64-Bit Server VM Oracle GraalVM 21.0.2+13.1 (build 21.0.2+13-LTS-jvmci-23.1-b30, mixed mode, sharing) ``` ##### gradle ###### 构建与运行 ```shell .\gradlew.bat nativeBuild .\gradlew.bat nativeRun ``` ###### `Downloading JavaFX static libs...`网络问题 Gluon下载`JavaFX static libs` 涉及到的相关源码[FileOps.java](https://github.com/gluonhq/substrate/blob/master/src/main/java/com/gluonhq/substrate/util/FileOps.java) ，因此可以通过配置`java`的一些系统属性（需要梯子）来加速，在项目根目录下新建文件`gradle.properties` 内容如下，配置项的有关文档[Java Networking and Proxies](https://docs.oracle.com/javase/8/docs/technotes/guides/net/proxies.html) ，gradle相关文档[Accessing the web through a proxy](https://docs.gradle.org/current/userguide/build_environment.html#ex-configuring-an-http-proxy-using-gradle-properties) ```properties org.gradle.jvmargs=-Dfile.encoding=UTF-8 systemProp.http.proxyHost=127.0.0.1 systemProp.http.proxyPort=7890 systemProp.https.proxyHost=127.0.0.1 systemProp.https.proxyPort=7890 ``` 重新执行相关命令，可能会因为之前的下载缓存导致重新执行命令失败，这时可以去删除此文件夹`C:\Users\你的用户名\.gluon\substrate` 再重新运行，`JavaFX static libs`下载成功后可以注释掉相关代理配置以防其他平台梯子配置不同，如果不想改配置文件，也可以通过下述命令的方式来使用代理 ``` gradlew.bat nativeBuild -D"https.proxyHost"=127.0.0.1 -D"https.proxyPort"=7890 ``` ##### maven ###### 构建与运行 ```shell mvn -Pwin gluonfx:build mvn -Pwin gluonfx:run mvn -Pmac gluonfx:build mvn -Pmac gluonfx:run ``` ###### `Downloading JavaFX static libs...`网络问题 ```shell mvn -Pwin gluonfx:build -D"https.proxyHost"=127.0.0.1 -D"https.proxyPort"=7890 mvn -Pmac gluonfx:build -D"https.proxyHost"=127.0.0.1 -D"https.proxyPort"=7890 ``` ## 日志 添加了支持GraalVM的Logback作为日志框架，在你自己的项目，如果是第一次添加以及后续修改了Logback配置文件的时候，在执行GraalVM构建之前，先用 `mvn -Pwin gluonfx:runagent`或`.\gradlew.bat nativeRunAgent`来为`native-image`生成一些必要的文件，它会自动保存到 `src/main/resources/META-INF/native-image`，然后在执行GraalVM构建，否则生成的程序执行时不会生成日志文件，正常情况下，会在程序执行目录创建 `logs`目录及日志文件 ## 补充 有时候`mvn gluonfx:build`或者`.\gradlew.bat jpackageImage`发生了错误后，执行`.\gradlew.bat clean`提示文件被占用，这时候可以打开 `任务管理器-性能-资源监视器-CPU`，在`关联的句柄`处输入`gluon`、`jpackage`等关键词来检索出卡住的相关进程并干掉他 ## Windows安装包制作 `jpackage`默认使用`WiX Toolset`来制作安装包文件，可以通过命令行参数修改`WiX Toolset`相关配置文件，若不想使用`jpackage`内置安装包的制作工具，也可以在构建出image后自行制作安装包 - [NSISBuilder](https://github.com/icuxika/NSISBuilder) - [WiXToolset3Builder](https://github.com/icuxika/WiXToolset3Builder)