Maven Shade JavaFX 运行时组件丢失

javafx java maven javafx-11

2022-08-31 15:09:16

我正在尝试使用 maven 依赖项创建一个 JFX11 自包含 jar。从我所做的研究中，似乎最好的方法是通过maven shade插件。但是，当我运行它时，我得到这个错误：

错误：缺少 JavaFX 运行时组件，并且需要这些组件才能运行此应用程序

我不明白为什么会发生这种情况。我搞砸了什么？有没有更好的方法来做到这一点？我还尝试了具有相同消息的maven程序集插件。

pom 文件供参考

<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 http://maven.apache.org/maven-v4_0_0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>Application</groupId>
    <artifactId>Main</artifactId>
    <packaging>jar</packaging>
    <version>1.0-SNAPSHOT</version>
    <name>SpaceRunner</name>
    <url>http://maven.apache.org</url>
    <dependencies>
        <dependency>
            <groupId>org.openjfx</groupId>
            <artifactId>javafx-controls</artifactId>
            <version>11</version>
        </dependency>
    </dependencies>
    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.8.0</version>
                <configuration>
                    <release>10</release>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.codehaus.mojo</groupId>
                <artifactId>exec-maven-plugin</artifactId>
                <version>1.6.0</version>
                <executions>
                    <execution>
                        <goals>
                            <goal>java</goal>
                        </goals>
                    </execution>
                </executions>
                <configuration>
                    <mainClass>Application.Main</mainClass>
                </configuration>
            </plugin>
            <plugin>
                <artifactId>maven-jar-plugin</artifactId>
                <configuration>
                    <archive>
                        <manifest>
                            <mainClass>
                                Application.Main
                            </mainClass>
                        </manifest>
                    </archive>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-shade-plugin</artifactId>
                <version>3.2.0</version>
                <executions>
                    <execution>
                        <phase>package</phase>
                        <goals>
                            <goal>shade</goal>
                        </goals>
                        <configuration>
                            <transformers>
                                <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
                                    <mainClass>Application.Main</mainClass>
                                </transformer>
                            </transformers>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
</project>

答案 1

更新 10/2021

由于 JavaFX 16，当 JavaFX 不在模块路径上运行时，将显示警告，这就是 uber/fat jar 的情况：

$ java -jar myFatJar-1.0-SNAPSHOT.jar
Oct 02, 2021 1:45:21 PM com.sun.javafx.application.PlatformImpl startup
WARNING: Unsupported JavaFX configuration: classes were loaded from 'unnamed module @14c24f4c'

此外，您还会从阴影插件本身收到警告：

[WARNING] Discovered module-info.class. Shading will break its strong encapsulation.

虽然最初可以忽略这些警告，但它们是有原因的。

如本企业社会责任中所述：

JavaFX 作为一组命名模块进行构建和分发，每个模块都位于自己的模块化 jar 文件中，JavaFX 运行时希望其类从一组命名的 javafx.* 模块中加载，并且不支持从类路径加载这些模块。

和：

当从类路径加载 JavaFX 类时，它会中断封装，因为我们不再获得 Java 模块系统的好处。

因此，即使这个被广泛接受的答案也解释了如何在Maven项目上创建uber/fat jar，不鼓励使用它，并且应该使用其他现代替代方法来分发您的应用程序，如jlink，jpackage或native-image。

原始答案

这个答案解释了为什么胖子/超级罐子在JavaFX 11上失败。总之：

此错误来自 java.base 模块中的 sun.launcher.LauncherHelper。这样做的原因是主应用程序扩展了应用程序并具有main方法。如果是这种情况，启动器助手将检查模块是否作为命名模块存在。如果该模块不存在，则启动将中止。javafx.graphics

并且已经为Gradle提出了修复方法。

对于 Maven，解决方案完全相同：提供一个不从扩展的新主类。Application

您的软件包中将有新类（名称错误）：application

// NewMain.java
public class NewMain {

    public static void main(String[] args) {
        Main.main(args);
    }
}

以及您现有的类，如下所示：Main

//Main.java
public class Main extends Application {

    @Override
    public void start(Stage stage) {
        ...
    }

    public static void main(String[] args) {
        launch(args);
    }
}

现在，您需要修改您的pom并为不同的插件设置主类：

<mainClass>application.NewMain</mainClass>

特定于平台的胖罐

最后，使用遮阳插件，您将在机器上生产一个胖罐。

这意味着，到目前为止，您的 JavaFX 依赖项使用的是唯一的分类器。例如，如果您使用的是Windows，Maven将在内部使用分类器。这具有仅包含 Windows 本机库的效果。win

所以你正在使用：

org.openjfx：javafx-controls：11
org.openjfx：javafx-controls：11：win
org.openjfx：javafx-graphics：11
org.openjfx：javafx-graphics：11：win <-- 这包含 Windows 的原生 dll
org.openjfx：javafx-base：11
org.openjfx：javafx-base：11：win

现在，如果您生成胖jar，您将捆绑所有这些依赖项（以及项目中的其他常规第三方依赖项），并且您将能够以以下方式运行您的项目：

java -jar myFatJar-1.0-SNAPSHOT.jar

虽然这非常好，但如果你想分发你的jar，请注意这个jar不是跨平台的，它只能在你的平台上工作，在这种情况下是Windows。

跨平台胖罐

有一个解决方案可以生成一个可以分发的跨平台jar：包括其他平台的其余本机库。

这可以很容易地完成，因为您只需要包含三个平台的图形模块依赖项：

<dependencies>
    <dependency>
        <groupId>org.openjfx</groupId>
        <artifactId>javafx-controls</artifactId>
        <version>11</version>
    </dependency>
    <dependency>
        <groupId>org.openjfx</groupId>
        <artifactId>javafx-graphics </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>mac</classifier>
    </dependency>
</dependencies>

大小

这种方法有一个主要问题：大小。正如您在其他答案中看到的那样，如果您使用 WebView 控件，由于 WebKit 本机库，您将捆绑大约 220 MB。

答案 2