多模块JavaFX maven项目打包问题

Question

这是尝试使用 maven 创建多模块 JavaFX 应用程序。

鉴于项目的以下结构：

project
|  pom1.xml
|_____ Word Generator (Folder)
      |  pom2.xml
      |_____logic (folder)
            |  WordGenerator
|_____UI (folder)
      |  pom3.xml
      |_____marty  
            |  App
            |  PrimaryController
            |  SecondaryController

按照上述方案的顺序，我们的pom文件结构如下：

pom1.xml

<?xml version="1.0" encoding="UTF-8"?>
<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/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>org.games.marty</groupId>
    <artifactId>words</artifactId>
    <packaging>pom</packaging>
    <version>0.1</version>

    <modules>
        <module>UI</module>
        <module>Word Generator</module>
    </modules>

    <properties>
        <maven.compiler.source>16</maven.compiler.source>
        <maven.compiler.target>16</maven.compiler.target>
    </properties>

    <build>
        <pluginManagement>
            <plugins>
                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-compiler-plugin</artifactId>
                    <version>3.8.0</version>
                    <configuration>
                        <source>16</source>
                        <target>16</target>
                    </configuration>
                </plugin>
            </plugins>
        </pluginManagement>
    </build>
</project>

pom2.xml

<?xml version="1.0" encoding="UTF-8"?>
<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/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactId>words</artifactId>
        <groupId>org.games.marty</groupId>
        <version>0.1</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>word.generator</artifactId>

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

    <build>
        <pluginManagement>
            <plugins>
                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-compiler-plugin</artifactId>
                    <version>3.8.0</version>
                    <configuration>
                        <source>16</source>
                        <target>16</target>
                    </configuration>
                </plugin>
                <plugin>
                    <!-- Build an executable JAR -->
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-jar-plugin</artifactId>
                    <version>3.1.0</version>
                    <configuration>
                        <archive>
                            <manifest>
                                <addClasspath>true</addClasspath>
                                <classpathPrefix>lib/</classpathPrefix>
                                <mainClass>org.games.marty.logic.WordGenerator</mainClass>
                            </manifest>
                        </archive>
                    </configuration>
                </plugin>
            </plugins>
        </pluginManagement>
    </build>
</project>

pom3.xml

<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>
    <artifactId>UI</artifactId>
    <version>0.1</version>

    <parent>
        <artifactId>words</artifactId>
        <groupId>org.games.marty</groupId>
        <version>0.1</version>
    </parent>

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

    <dependencies>
        <dependency>
            <groupId>org.openjfx</groupId>
            <artifactId>javafx-controls</artifactId>
            <version>16</version>
        </dependency>
        <dependency>
            <groupId>org.openjfx</groupId>
            <artifactId>javafx-fxml</artifactId>
            <version>16</version>
        </dependency>
        <dependency>
            <groupId>org.games.marty</groupId>
            <artifactId>word.generator</artifactId>
            <version>0.1</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.8.0</version>
                <configuration>
                    <release>16</release>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.openjfx</groupId>
                <artifactId>javafx-maven-plugin</artifactId>
                <version>0.0.6</version>
                <executions>
                    <execution>
                        <!-- Default configuration for running -->
                        <!-- Usage: mvn clean javafx:run -->
                        <id>default-cli</id>
                        <configuration>
                            <mainClass>org.games.marty.App</mainClass>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
            <plugin>
                <!-- Build an executable JAR -->
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-jar-plugin</artifactId>
                <version>3.1.0</version>
                <configuration>
                    <archive>
                        <manifest>
                            <addClasspath>true</addClasspath>
                            <classpathPrefix>lib/</classpathPrefix>
                            <mainClass>org.games.marty.App</mainClass>
                        </manifest>
                    </archive>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

为了让 UI 能够访问 WordGenerator 逻辑，我们尝试构建应用程序的方式是 maven package pom1.xml 指令的结果

如前所述，我们得到了上述错误：

Error: Could not find or load main class org.games.marty.App
Caused by: java.lang.NoClassDefFoundError: javafx/application/Application

据我了解，JavaFX 依赖项是通过 maven 安装的，应该可用，但它们丢失了？

Answer 1

通过mvn package 使用maven-jar-plugin 打包是不够的

mvn package，默认情况下，只是为你的应用程序代码打包jar，它不会包含所有依赖库代码（这就是为什么当你尝试运行时找不到依赖代码的原因您的申请）。

您可以使用程序集来打包您的应用程序代码和依赖库，如 How can I create an executable JAR with dependencies using Maven? 中所述，尽管这种方法并不是解决您问题的唯一方法。

您需要构建某种运行时映像

构建运行时映像有很多选择，我不知道您的要求，所以我不能推荐您应该做什么。示例选项是：

1. 应用程序的 zip/tar 文件以及单独目录中的库。
2. 创建一个包含所有相关代码的 jar。
3. 解决方案 1 或 2 中的任一种，外加一个打包的 JRE。
4. 包含您的代码和库的运行时映像，它还仅使用您需要的 JRE 和 JavaFX 模块的自定义运行时部分（使用 jlink）。
5. 适用于 3 或 4 的本机安装程序（使用 jpackage + 本机安装程序创建工具，例如 WIX、RPM、DEB 安装程序创建器）。

最后一种方法（本机安装程序）是我推荐用于大多数重要应用程序的打包、分发和安装方法。

您需要研究如何做到这一点

要获得解决方案，您需要进行自己的研究，并且，一旦您选择了一种方法和工具集，如果您仍然遇到困难，您可以就该方法的实施提出一个新问题。

相关资源

• How can I create an executable JAR with dependencies using Maven?
• openjfx Runtime images documentation
• maven shade plugin
• Maven Shade JavaFX runtime components are missing
• openjfx JavaFX maven plugin
• badass runtime plugin
• badass jlink plugin
• jlink guide
• jpackage script
• JEP 392: packaging tool

阴影罐警告

如果您使用 maven shade 插件将所有 JavaFX 代码捆绑到一个 jar 中，当您从 Java 16+ 运行应用程序时，您将收到如下警告：

WARNING: Unsupported JavaFX configuration: classes were loaded from 'unnamed module @28c71909'

这表明不支持这样的配置，并且可能（并且可能会）在未来以及当前的 JavaFX 平台修订版中中断。因此，我不推荐包含 JavaFX 平台代码的阴影 jar，即使此类 jar 当前可能适用于您的部署。

JavaFX 11+ 被构建为用作一组模块。如果配置不在模块路径之外运行 JavaFX 平台，而是在类路径之外运行平台代码（就像阴影 jar 那样），则不支持配置。