Gradle JavaFX Jlink打包：解决模块路径重复错误

本文详细探讨了在使用gradle和javafx进行jlink打包时，可能遇到的“模块路径重复”错误。该问题通常源于第三方库不当引入重复的javafx模块。教程提供了通过在gradle构建脚本中精确排除特定依赖的javafx组来解决此问题的具体方法，确保jlink过程的顺利执行，并保持模块路径的清晰性。

1. 理解Gradle JavaFX Jlink中的模块重复问题

在使用Gradle构建JavaFX应用程序并利用Jlink工具创建自定义运行时镜像时，开发者可能会遇到一个常见的错误：error: duplicate module on application module path。这个错误通常在createMergedModule任务执行期间出现，并明确指出javafx.base、javafx.controls等JavaFX核心模块在应用程序模块路径上存在重复。

错误现象示例：

> Task :createMergedModule
error: duplicate module on application module path
  module in javafx.base
error: duplicate module on application module path
  module in javafx.controls
2 errors

> Task :createMergedModule FAILED

问题根源分析：

当项目配置了org.openjfx.javafxplugin插件来管理JavaFX依赖时，该插件会负责将正确的JavaFX模块（如javafx.controls、javafx.fxml等）添加到项目的模块路径中。然而，如果项目中还引入了其他第三方库（例如org.controlsfx:controlsfx、org.aerofx:aerofx等），并且这些库在其自身的传递性依赖中也包含了JavaFX模块，就会导致Jlink在构建时发现相同的JavaFX模块被重复引入。这种重复不仅可能导致构建失败，还会造成不必要的资源膨胀和潜在的运行时冲突。

立即学习“Java免费学习笔记（深入）”；

2. 识别并解决冲突的JavaFX依赖

解决“模块路径重复”问题的关键在于识别并阻止那些不必要地引入JavaFX模块的第三方依赖。在许多JavaFX项目中，org.controlsfx:controlsfx是一个常见的冲突源，因为它是一个基于JavaFX构建的UI控件库，自然会依赖JavaFX。

解决方案：排除传递性JavaFX依赖

Word-As-Image for Semantic Typography

文字变形艺术字、文字变形象形字

62

查看详情

Gradle提供了强大的依赖管理功能，允许我们精确控制传递性依赖。通过在特定的依赖声明中使用exclude关键字，我们可以阻止某个库引入其自身的org.openjfx组下的JavaFX模块。

以下是修改build.gradle文件以解决此问题的示例：

plugins {
  id 'java'
  id 'org.openjfx.javafxplugin' version '0.0.13'
  id 'org.beryx.jlink' version '2.16.2'
}

repositories {
    mavenCentral()
    mavenLocal()
}

javafx {
    version = "19"
    modules = [ 'javafx.controls', 'javafx.fxml' ]
}

dependencies {
    implementation "org.aerofx:aerofx:0.2"
    implementation "pdfbox:pdfbox:0.7.3"
    implementation "org.javatuples:javatuples:1.2"
    // 解决JavaFX模块重复问题的关键修改
    implementation ("org.controlsfx:controlsfx:11.0.3") {
        exclude group: 'org.openjfx' // 阻止ControlsFX引入其自身的JavaFX依赖
    }
    implementation "org.mariadb.jdbc:mariadb-java-client:2.1.2"
    implementation "io.gitlab.vincent-lambert:miscellaneousWidgets:1.7"
    implementation "org.apache.httpcomponents:httpclient:4.5.13"
    implementation "org.apache.httpcomponents:httpmime:4.3.1"
}

application {
    mainModule = 'CharacterCreator'
    mainClass = 'CharacterCreator.Menu.App'
}

tasks.withType(JavaCompile) {
    options.compilerArgs << '-Xlint:unchecked'
    options.deprecation = true
}

jlink {
    options = ['--strip-debug', '--compress', '2', '--no-header-files', '--no-man-pages']
    launcher{
        name = 'hello'
        jvmArgs = ['-Dlog4j.configurationFile=./log4j2.xml']
    }
}

在上述代码中，我们对org.controlsfx:controlsfx:11.0.3的implementation依赖进行了修改。通过添加 { exclude group: 'org.openjfx' }，我们明确告诉Gradle在解析controlsfx的依赖时，忽略任何来自org.openjfx组的传递性依赖。由于org.openjfx.javafxplugin已经正确地为项目提供了JavaFX模块，这项排除操作可以有效地消除模块路径上的重复。

3. 进一步排查与最佳实践

如果排除org.controlsfx后问题依然存在，或者您怀疑有其他库也导致了类似问题，可以采取以下步骤进行进一步排查和优化：

• 分析依赖树： 使用Gradle的dependencies任务来可视化项目的完整依赖树。运行 gradle dependencies --configuration implementation 命令，仔细检查输出，寻找任何可能间接引入org.openjfx模块的第三方库。一旦发现，就对其应用exclude group: 'org.openjfx'。
• 检查module-info.java： 确保您的module-info.java文件只声明了项目直接需要的JavaFX模块（例如requires javafx.controls;、requires javafx.fxml;等），并且没有不必要的或重复的requires语句。
• javafxplugin配置： 确认org.openjfx.javafxplugin的版本和javafx块中的version及modules配置是正确的，并且与您的项目需求和JavaFX版本兼容。
• 模块路径清理： Jlink在构建时会检查所有输入模块的路径。确保build/jlinkbase/jlinkjars等中间目录不会意外地包含重复的JavaFX模块，尤其是在跨平台开发环境（如WSL）中，有时可能会因为缓存或构建残留导致多平台JavaFX模块混淆。上述的exclude机制是解决此问题的最有效方法。
• 跨平台考量： 模块路径重复问题通常是依赖管理层面的逻辑错误，与操作系统平台（如Windows、Linux、WSL）本身关系不大。一旦通过exclude解决了模块重复，Jlink工具就能够为目标平台正确生成自定义运行时镜像。

4. 总结

在模块化的JavaFX项目中，尤其是在利用Jlink进行应用程序打包时，精确的依赖管理至关重要。error: duplicate module on application module path错误是一个明确的信号，表明您的构建环境中存在冗余的JavaFX模块。通过理解问题根源，并运用Gradle的exclude机制来阻止第三方库传递性地引入重复的org.openjfx模块，可以有效地解决这一问题。这种方法不仅能够确保Jlink构建过程的顺利进行，还能使最终生成的运行时镜像更加精简和高效。在面对复杂的依赖图时，积极利用Gradle提供的工具（如gradle dependencies）来分析和管理依赖，是每个JavaFX开发者都应掌握的关键技能。

以上就是Gradle JavaFX Jlink打包：解决模块路径重复错误的详细内容，更多请关注php中文网其它相关文章！