多模块JavaFX maven项目打包问题 [英] Multi-module JavaFX maven project packaging issue
问题描述
这是尝试使用 maven 创建多模块 JavaFX 应用程序.
This is an attempt to create a multi-module JavaFX application with maven.
鉴于项目的以下结构:
project
| pom1.xml
|_____ Word Generator (Folder)
| pom2.xml
|_____logic (folder)
| WordGenerator
|_____UI (folder)
| pom3.xml
|_____marty
| App
| PrimaryController
| SecondaryController
按照上述方案的顺序，我们有以下 pom 文件的结构:
We have the following structure of the pom files in order of the scheme above:
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 指令的结果
The way we have attempted to build the application in order for the UI to have access to the WordGenerator logic is to maven package the result from the pom1.xml directive
我们得到了前面提到的上述错误:
We get the above error as mentioned earlier:
Error: Could not find or load main class org.games.marty.App
Caused by: java.lang.NoClassDefFoundError: javafx/application/Application
据我所知，JavaFX 依赖项是通过 maven 安装的，应该可用，但缺少它们?
As far as my understanding goes, the JavaFX dependencies are installed throught maven and should be available but they are missing?
推荐答案
使用maven-jar-plugin通过mvn package打包是不够的强>
Packaging via mvn package using the maven-jar-plugin is not enough
mvn package，默认情况下，只会为您的应用程序代码打包 jar，它不会包含所有依赖库代码(这就是为什么依赖代码不能当您尝试运行您的应用程序时发现).
mvn package, by default, is just going to package the jar for your application code, it isn't going to include all of the dependant library code (which is why the dependent code cannot be found when you attempt to run your application).
您可以使用程序集打包应用程序代码和依赖库，详情请参见 如何使用 Maven 创建具有依赖项的可执行 JAR?，尽管这种方法不是解决您问题的唯一方法.
You could package your application code and dependant libraries using an assembly, as detailed in How can I create an executable JAR with dependencies using Maven?, though that approach is not the only one to solve your problem.
您需要构建某种运行时映像
构建运行时映像有很多选项，我不知道您的要求，因此我无法推荐您应该做什么.示例选项是:
There are numerous options for building runtime images and I don't know your requirements, so I can't recommend what you should do instead. Example options are:
- 应用程序的 zip/tar 以及单独目录中的库.
- 创建包含所有相关代码的单个 jar.
- 解决方案 1 或 2 中的任何一个，以及包含打包的 JRE.
- 包含您的代码和库的运行时映像，它也仅使用您需要的 JRE 和 JavaFX 模块的自定义运行时部分(使用 jlink).
- 适用于 3 或 4 的本机安装程序(使用 jpackage + 本机安装程序创建工具，例如 WIX、RPM、DEB 安装程序创建者).
最后一种方法(本机安装程序)是我推荐用于大多数重要应用程序的打包、分发和安装方法.
The last method (native installer), is the packaging, distribution, and installation method I would recommend for most non-trivial applications.
你需要研究如何做到这一点
要获得您的解决方案，您需要自己进行研究，并且一旦您选择了一种方法和工具集，如果您仍然遇到困难，您可以针对该方法的实施提出一个新问题.
To get your solution, you will need to do your own research, and, once you have chosen an approach and toolset, you could create a new question regarding the implementation of that approach, if you continue to have difficulties.
相关资源
- 如何创建可执行 JAR使用 Maven 依赖项?
- openjfx 运行时图像文档
- maven 阴影插件
- 缺少 Maven Shade JavaFX 运行时组件
- openjfx JavaFX Maven 插件
- badass 运行时插件
- badass jlink 插件
- jlink 指南
- jpackage 脚本
- JEP 392:打包工具
阴影罐的警告
如果您使用 maven shade 插件将所有 JavaFX 代码捆绑到一个 jar 中，当您从 Java 16+ 运行您的应用程序时，您将收到如下警告:
If you bundle all JavaFX code into a single jar using the maven shade plugin, you will get a warning like the following when you run your application from Java 16+:
警告:不支持的 JavaFX 配置:从未命名模块 @28c71909"加载类
这表明不支持这样的配置，并且可能(并且可能会)在未来和当前的 JavaFX 平台修订版中中断.因此，我不推荐包含 JavaFX 平台代码的着色 jar，即使此类 jar 目前可能适用于您的部署.
This indicates that such a configuration is not supported, and may (and probably will) break in future and perhaps current JavaFX platform revisions. Thus, shaded jars that include JavaFX platform code are not recommended by me, even though such jars might currently work for your deployments.
JavaFX 11+ 构建为用作一组模块.如果配置不在模块路径之外运行 JavaFX 平台，而是在类路径之外运行平台代码(就像阴影 jar 一样)，则不支持这些配置.
JavaFX 11+ is built to be used as a set of modules. Configurations are not supported if they do not run the JavaFX platform off of the module path but instead run the platform code off of the classpath (as a shaded jar would).
这篇关于多模块JavaFX maven项目打包问题的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！
