JFX11+Maven+IDEA 发布跨平台应用的完美解决方案

水深无声 2024-02-23 07:56 10阅读 0赞

[JFX11+Maven+IDEA 发布跨平台应用的完美解决方案 - 知乎][JFX11_Maven_IDEA _ -]

<dependencies>
        <dependency>
            <groupId>org.openjfx</groupId>
            <artifactId>javafx-base</artifactId>
            <version>11</version>
            <classifier>linux</classifier>
        </dependency>
        <dependency>
            <groupId>org.openjfx</groupId>
            <artifactId>javafx-base</artifactId>
            <version>11</version>
            <classifier>win</classifier>
        </dependency>
        <dependency>
            <groupId>org.openjfx</groupId>
            <artifactId>javafx-controls</artifactId>
            <version>11</version>
            <classifier>linux</classifier>
        </dependency>
        <dependency>
            <groupId>org.openjfx</groupId>
            <artifactId>javafx-controls</artifactId>
            <version>11</version>
            <classifier>win</classifier>
        </dependency>
        <dependency>
            <groupId>org.openjfx</groupId>
            <artifactId>javafx-fxml</artifactId>
            <version>11</version>
            <classifier>linux</classifier>
        </dependency>
        <dependency>
            <groupId>org.openjfx</groupId>
            <artifactId>javafx-fxml</artifactId>
            <version>11</version>
            <classifier>win</classifier>
        </dependency>
        <dependency>
            <groupId>org.openjfx</groupId>
            <artifactId>javafx-graphics</artifactId>
            <version>11</version>
            <classifier>linux</classifier>
        </dependency>
        <dependency>
            <groupId>org.openjfx</groupId>
            <artifactId>javafx-graphics</artifactId>
            <version>11</version>
            <classifier>win</classifier>
        </dependency>
    </dependencies>

<properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <maven.compiler.source>11</maven.compiler.source>
        <maven.compiler.target>11</maven.compiler.target>
    </properties

\-------------------------------------------------------------------------------------------------------------------------------

原文

### 1 概述 ###

前几天写了两篇关于JFX+IDEA打包跨平台应用的文章，[这篇][Link 1]是使用IDEA自带功能打包的，[这篇][Link 2]是使用Maven进行打包的，但是效果不太满意，因为从JDK9开始实现模块化，同时JFX部分从JDK中独立出来了，也就是说需要默认JDK不再自带JFX。这意味着外部依赖需要手动处理`module-info.java`，这是一件非常麻烦的事情。

### 1.1 不使用Maven ###

其实不使用`Maven`也能打包发布跨平台JFX应用，但是没有使用`Maven`的话，虽然打包出来能直接运行无需jre环境，但是，管理依赖确实麻烦，在使用`jlink`打包一些外部的jar时，对于一些比较简单的jar还是比较舒服的，参照[这里][Link 3]：

![6c7a1a80da572857faa2a7aa08663337.png][]

首先去下载jar，接着生成`module-info.java`，然后使用`jdeps`检查依赖，添加对应的jar到路径中，编译生成`module-info.java`接着更新原来的jar即可。看起来简单，但是笔者碰到了okhttp这种jar，依赖简直环环相扣导致笔者放弃了这种方式。

### 1.2 使用`Maven` ###

使用`Maven`可以完美解决依赖问题，多亏强大的`pom.xml`，几行`<dependency>`就可以解决依赖问题，但是，还是需要手动处理`module-info.java`，而且IDEA文档明确表明仅支持Java8的打包为jar：

![3115873eb2578efa36868d956a2996b9.png][]

因此，这篇文章采取一种最简单的方式利用`Maven`打包发布JFX11应用。

### 2 新建`Maven`工程 ###

![cfe113a2b5fe85495ec30cda29dca5d1.png][]

默认即可，问题不大。

![cd7dee4f78a5d5c05de57af750713470.png][]

### 3 添加依赖 ###

需要在哪个平台在`classifier`中指定即可。这里是`Linux`与`win`。

同时指定编码与JDK：

否则会报错：

![e92283072e5ed29867cdf84368ec01d1.png][]

### 4 新建Main ###

新建一个包再新建`Main.java`、`Launcher.java`以及`Main.fxml`：

![18144a7e5e3eb8bd33ecbd586b2add4a.png][]

`Main.java`如下：

package com.test;
    
    import javafx.application.Application;
    import javafx.fxml.FXMLLoader;
    import javafx.scene.Parent;
    import javafx.scene.Scene;
    import javafx.stage.Stage;
    
    public class Main extends Application {
        public void start(Stage stage) throws Exception {
            Parent root = FXMLLoader.load(getClass().getResource("/Main.fxml"));
            Scene scene = new Scene(root);
            stage.setScene(scene);
            stage.setTitle("Hello World");
            stage.show();
        }
    
        public static void main(String[] args) {
            launch(args);
        }
    }

`Launcher.java`：

package com.test;
    
    public class Launcher {
        public static void main(String[] args) {
            Main.main(args);
        }
    }

`Main.fxml`：

<?xml version="1.0" encoding="UTF-8"?>
    
    <?import javafx.scene.control.*?>
    <?import javafx.scene.layout.*?>
    <?import javafx.scene.text.*?>
    
    
    <AnchorPane prefHeight="400.0" prefWidth="600.0" xmlns="http://javafx.com/javafx/10.0.2-internal"
                xmlns:fx="http://javafx.com/fxml/1" fx:controller="com.test.Main">
       <Label layoutX="228.0" layoutY="185.0" text="Hello World">
          <font>
             <Font size="25.0"/>
          </font>
       </Label>
    </AnchorPane>

注意`getResource`中的`fxml`路径，`Main.fxml`文件放在`resources`下，直接通过根路径读取：

getResource("/Main.fxml");

### 5 添加运行配置 ###

此时应该是没有运行配置的状态，点击`Add Configuration`：

![format_png][]

添加`Application`：

![fcef39b9bb173e896afa9ac8092718cb.png][]

添加`Launcher`类作为`Main class`：

![3f0ce6f1ca5d1fbc5d48ada9d46747c9.png][]

这时候`run`就没问题了：

![74a51e8db48c3cbba2f8427330f70c30.png][]

### 6 使用默认`Maven`打包 ###

虽然现在可以运行了，但是，如果直接使用默认的`Maven`打包的话：

![6d69bc825d140f5e77ea1091d5a9ec14.png][]

在`target`下有一个jar，直接右键运行：

![format_png 1][]

会提示`no main manifest attribute`：

![61f237d622b6f8a20b821a90aa8438c8.png][]

也就是找不到`Manifest`中入口类。

jar实际上是一个class的压缩包，与zip的区别是jar包含了一个`MANIFEST.MF`，`MANIFEST.MF`在`META-INF`下，一个示例文件如下：

![a16b14e2f0733c42b8e04b0f379bd0c5.png][]

有点类似与键值对的格式，`MANIFEST.MF`包含了jar文件的内容描述，并在运行时向JVM提供应用程序信息。注意该文件有严格的格式限制，比如第一行不能为空，行与行之间不能存在空行。

一个暴力的解决办法是直接解压jar并修改里面的`MANIFEST.MF`，添加

Main-Class: com.test.Launcher

但是这样会报找不到Application类的异常：

![57f280e740a99d55579251388a8efb71.png][]

### 7 添加新的打包插件 ###

理论上来说，只需要jar包内的相同目录下提供了javafx的jar或者class文件就不会抛出异常了，但是，如果依赖很多需要一个一个添加，这是一个痛苦的过程。

所以，为了优雅地解决这个问题，引入一个叫`maven-shade-plugin`的插件即可：

<build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-shade-plugin</artifactId>
                <version>3.2.2</version>
                <executions>
                    <execution>
                        <phase>package</phase>
                        <goals>
                            <goal>shade</goal>
                        </goals>
                        <configuration>
                            <transformers>
                                <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
                                    <mainClass>com.test.Launcher</mainClass>
                                </transformer>
                            </transformers>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

最新版本请到[官方Github][Github]查看，使用时只需要修改：

修改为程序入口类。

### 8 打包 ###

此时再从右侧栏打包选中`Maven`，`package`即可：

![format_png 2][]

但是会有警告：

![format_png 3][]

因为一些class文件重复了，但是也提到了通常来说这是没有危害的并且可以跳过警告，或者修改`pom.xml`去手动排除某些依赖。

### 9 运行 ###

直接在IDEA中右键运行或者-jar运行，可以看到没有异常了：

![cda630990444efd7d84c1a105d4f8974.png][]

相比起原来自带的`Maven`打包插件，主要是多了javafx的一些class以及对应平台所需要的一些动态库文件等，比如`Windows`上的`.dll`与`Linux`上的`.so`文件。

![cb6f99c8ea9610b3ecee175085b6c95f.png][]

这样一个跨平台的JFX jar包就制作好了，只需

java -jar

即可跨平台运行。

[JFX11_Maven_IDEA _ -]: https://zhuanlan.zhihu.com/p/145206637
[Link 1]: https://link.zhihu.com/?target=https%3A//blog.csdn.net/qq_27525611/article/details/106444423
[Link 2]: https://link.zhihu.com/?target=https%3A//blog.csdn.net/qq_27525611/article/details/106433723
[Link 3]: https://link.zhihu.com/?target=https%3A//blog.csdn.net/weixin_44326589/article/details/86680972
[6c7a1a80da572857faa2a7aa08663337.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/23/6ef6a3872e9d474b8e3f2db2bb0f3548.png
[3115873eb2578efa36868d956a2996b9.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/23/1302b23f5f7e44018ab55489d8fd3a88.png
[cfe113a2b5fe85495ec30cda29dca5d1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/23/df107074019a4e9494328443f95fa735.png
[cd7dee4f78a5d5c05de57af750713470.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/23/e5e9ba999155471896ed6470897e573b.png
[e92283072e5ed29867cdf84368ec01d1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/23/111969a1058e4385bfa991fe5b85c374.png
[18144a7e5e3eb8bd33ecbd586b2add4a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/23/9ec57d83a82748d3805b6571f8423f88.png
[format_png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/23/3f941c9cc94e4641b206cfcb4b45d3bc.png
[fcef39b9bb173e896afa9ac8092718cb.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/23/b83b81b49b5145368a93eba7f23795ed.png
[3f0ce6f1ca5d1fbc5d48ada9d46747c9.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/23/349bf2fba35b4d01a966009599c8901f.png
[74a51e8db48c3cbba2f8427330f70c30.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/23/30a836e45346495e9c3cafb4d731c0c4.png
[6d69bc825d140f5e77ea1091d5a9ec14.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/23/ee3f1db44ba642ae9c9e8564229aad6b.png
[format_png 1]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/23/335a2986b99c4ac88e4619ebf3e7cc96.png
[61f237d622b6f8a20b821a90aa8438c8.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/23/87b4db1db57d4ad398a5bbfce737245c.png
[a16b14e2f0733c42b8e04b0f379bd0c5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/23/c0e2a4b6c5914e71aa5087494c437db4.png
[57f280e740a99d55579251388a8efb71.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/23/b01bf8fa9186454b9452f2b5ff33fb36.png
[Github]: https://link.zhihu.com/?target=https%3A//github.com/apache/maven-shade-plugin
[format_png 2]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/23/e68546ea3e1b4bd4a109812ffa8cfb7a.png
[format_png 3]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/23/66377c1a21c94ed78ffb6f038505b0dd.png
[cda630990444efd7d84c1a105d4f8974.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/23/43f906a145ad4c19b0404a5546d2fd1d.png
[cb6f99c8ea9610b3ecee175085b6c95f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/23/41790e33fda34d68baa76896ff71429f.png