JavaFX, Migrate Maven Build from JDK 8 to JDK 11

As Oracle published the libs for JavaFX have been casted out of the JDK to be open sourced to OpenJFX

Therefore when it is time to update you working project to a newer java version, your project build needs to undergo some light adaptations.

This note brings you a working configuration, you can also refer to openjfx doc for more info on how to get the most out of maven build in Java 11+ but examplifying a working configuration is always good as the evil is in the details.

Here are the steps we will be following

• Update Java Version
• Update Maven Compiler Configuration
• Update Maven JavaFX Plugin
• Reference JavaFX Dependencies

Update Java Version

export PATH=$JAVA11_HOME/bin;$PATH

Update Maven Compiler Configuration

<plugin>
	<groupId>org.apache.maven.plugins</groupId>
	<artifactId>maven-compiler-plugin</artifactId>
	<version>3.8.0</version>
	<configuration>
		<release>11</release>
	</configuration>
</plugin>

Update Maven JavaFX Plugin

in Java 8 you may have used the plugin com.zenjava:org.openjfx, after many years of good and loyal service for Java 11+ it is superseded by org.openjfx:javafx-maven-plugin So you can update your maven pom.xml to

<plugin>
	<groupId>org.openjfx</groupId>
	<artifactId>javafx-maven-plugin</artifactId>
	<version>0.0.5</version>
	<configuration>
		<release>11</release>
		<mainClass>com.company.MyClassMain</mainClass>
	</configuration>
</plugin>

Reference JavaFX Dependencies

As the JavaFX libs are no longer included in the JDK it should be referenced now as dependencies

<dependency>
	<groupId>org.openjfx</groupId>
	<artifactId>javafx-controls</artifactId>
	<version>15.0.1</version>
</dependency>
<!-- the below only if you use fxml (e.g. @FXML javafx.fxml.FXML)-->
<dependency>
	<groupId>org.openjfx</groupId>
	<artifactId>javafx-fxml</artifactId>
	<version>15.0.1</version>
</dependency>

Run via Command Line

To compile or build simply run mvn compile or mvn install, the org.openjfx:javafx-maven-plugin will add for you the necessary libraries. To execute the Java FX app from the command line

mvn javafx:run

Note my Java class is as follows:

1
2
3
4
5
 
public class MyClassMain extends Application {

    public static void main(String[] args) {
        launch(MyClassMain.class, (java.lang.String[]) null);
    }
 

Run via IDE

Add the following VM arguments

--module-path "path/to/openjfx-11.0.2_windows-x64_bin-sdk/javafx-sdk-11.0.2/lib" --add-modules javafx.controls,javafx.fxml