Multi-module JavaFX maven project packaging issue

by

Packaging via mvn package using the maven-jar-plugin is not enough

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).

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.

You need to build some kind of runtime image

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:

  1. A zip/tar of your application plus libraries in a separate directory.
  2. The creation of a single jar that includes all dependant code.
  3. Either of solutions 1 or 2, plus the inclusion of a packaged JRE.
  4. A runtime image with your code and libraries which also uses just the custom runtime portions of the JRE and JavaFX modules you need (using jlink).
  5. A native installer for either 3 or 4 (using jpackage + a native installer creation tool, e.g. WIX, RPM, DEB installer creators).

The last method (native installer), is the packaging, distribution, and installation method I would recommend for most non-trivial applications.

You need to research how to do this

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.

Related resources

Warning for shaded jars

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+:

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

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+ 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).

More Related Contents:

  1. IntelliJ doesn’t load javafx packages from Maven dependencies (JavaFX 17)
  2. Maven Shade JavaFX runtime components are missing
  3. IntelliJ can’t recognize JavaFX 11 with OpenJDK 11
  4. IntelliJ inspection gives “Cannot resolve symbol” but still compiles code
  5. JavaFX 11: IllegalAccessError when creating Label
  6. Adding external library to artifact jar in IntelliJ IDEA
  7. Import Maven dependencies in IntelliJ IDEA
  8. Maven Compilation Error: (use -source 7 or higher to enable diamond operator)
  9. What is the best way to deploy JavaFX application, create JAR and self-contained applications and native installers
  10. Error: JavaFX runtime components are missing, and are required to run this application with JDK 11 [duplicate]
  11. Package a non-modular JavaFX application
  12. MessageBodyProviderNotFoundException while running jar from command line
  13. JAVA_HOME should point to a JDK not a JRE
  14. Maven plugins can not be found in IntelliJ
  15. Maven Java Version Configuration ignored by Eclipse/Idea
  16. stop IntelliJ IDEA to switch java language level every time the pom is reloaded (or change the default project language level)
  17. Adding resources in IntelliJ for Maven project
  18. Maven project with JavaFX (with jar file in `lib`)
  19. How to make a “fat jar” of a Maven project? [duplicate]
  20. Build order of Maven multimodule project?
  21. cannot resolve symbol javafx.application in IntelliJ Idea IDE
  22. Spring MVC using tomcat, maven and intelliJ Error [duplicate]
  23. IntelliJ – Convert a Java project/module into a Maven project/module
  24. JavaFX and maven: NullPointerException: Location is required
  25. Java FX Modular Application, Module not found (Java 11, Intellij)
  26. Why so red? IntelliJ seems to think every declaration/method cannot be found/resolved
  27. How to change Java version for Maven in IntelliJ?
  28. How to force IntelliJ to download javadocs with Maven?
  29. IntelliJ GUI Designer Maven Executable JAR Export
  30. Build and deploy javafx application using java11

Leave a Comment