在 Intellij IDEA 裡使用 OpenJFX (JavaFX)

JDK 11 把 JavaFX 剝離了出來，形成了單獨且開源的 OpenJFX 子產品。

本文的目的是通過簡單的例子解釋這一變化對使用 JavaFX 所造成的影響，并找到一種在 IDEA 2018.2 上使用它的辦法。

首先，OpenJFX 官網的入門文檔訓示我們手動下載下傳 SDK，但在 maven 的幫助下這不是必須的。雖然同樣得下載下傳，但這被 maven 自動化了。

我們的 pom.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/xsd/maven-4.0.0.xsd">    <modelVersion>4.0.0modelVersion>    <groupId>samplegroupId>    <artifactId>javafxartifactId>    <version>1.0-SNAPSHOTversion>    <properties>        <project.build.sourceEncoding>UTF-8project.build.sourceEncoding>        <mainClass>sample.JFXMainmainClass>        <javafx.version>11javafx.version>    properties>    <dependencies>        <dependency>            <groupId>org.openjfxgroupId>            <artifactId>javafx-controlsartifactId>            <version>${javafx.version}version>        dependency>        <dependency>            <groupId>org.openjfxgroupId>            <artifactId>javafx-fxmlartifactId>            <version>${javafx.version}version>        dependency>    dependencies>    <build>        <plugins>            <plugin>                <groupId>org.apache.maven.pluginsgroupId>                <artifactId>maven-compiler-pluginartifactId>                <version>3.8.0version>                <configuration>                    <source>11source>                    <target>11target>                configuration>            plugin>        plugins>    build>project>      

這裡引入了 OpenJFX 的依賴包，并設定了項目的 JDK 版本為 JDK 11。

根據 IDEA 的提示 Import Changes，或者手動：右鍵 pom.xml - Maven - Reimport。

注意：這裡沒有使用 maven.compiler.source 和 maven.compiler.target 這兩個 property。這兩個 property 是作為參數定義在 maven-compiler-plugin 裡的，分别對應于源代碼的 Java 版本和目标代碼的 Java 版本。因為 IDEA 目前對這兩項的支援似乎不夠好，不能完美地同步到項目設定裡。

注意：需要手動檢查 Preferences - Build, Execution, Deployment - Compiler - Java Compiler 中 Project bytecode version 及 Per-module bytecode version 的值是否同為 11。理由同上。

我們的 Java 代碼如下：

package sample;import javafx.application.Application;import javafx.fxml.FXMLLoader;import javafx.scene.Parent;import javafx.scene.Scene;import javafx.stage.Stage;public class JFXMain extends Application {    @Override    public void start(Stage primaryStage) throws Exception{
        Parent root = FXMLLoader.load(getClass().getResource("/sample.fxml"));
        primaryStage.setTitle("Hello World");
        primaryStage.setScene(new Scene(root, 300, 275));
        primaryStage.show();
    }    public static void main(String[] args) {
        launch(args);
    }
}      

package sample;public class Controller {
}      

OpenJFX 布局描述檔案 /src/main/resources/sample.fxml 如下：

<?import javafx.scene.layout.GridPane?><GridPane fx:controller="sample.Controller"          xmlns:fx="http://javafx.com/fxml" alignment="center" hgap="10" vgap="10">GridPane>      

Java 子產品描述檔案 /src/main/java/module-info.java 如下：

module sample {    requires javafx.controls;    requires javafx.fxml;    // 暴露包 sample 給 javafx 的子產品們，使其可以在運作時使用反射通路    opens sample to javafx.graphics, javafx.fxml;}      

以上便是在 JDK 11 中使用 OpenJFX 所需的全部鋪墊了。

常見錯誤

啟動報錯：缺少 JavaFX 運作時元件, 需要使用該元件來運作此應用程式

子產品化 Java 程式與非子產品化 Java 程式的啟動方式有所不同。

# 非子產品化java [options] mainclass [args...]

# 子產品化java [options] [--module-path modulepath] --module module[/mainclass] [args...]      

提供了 module-info.java 的話，IDEA 發現這是子產品化的 Java 程式。以上例為例，啟動指令是：

java ${OPTIONS} -m ${METHOD_PATH} -m sample/sample.JFXMain      

否則，IDEA 會認為這是非子產品化 Java 程式，啟動指令是：

java ${OPTIONS} -classpath ${CLASS_PATH} sample.JFXMain      

但這報錯具體是什麼代碼引起的呢？我們在 JDK 11 的 sun.launcher.LauncherHelper 發現：如果 JFXMain 繼承自 javafx.application.Application，同時程式從 JFXMain.main() 啟動，LauncherHelper 會檢查是否存在子產品 javafx.graphics 的聲明：

package sun.launcher;public final class LauncherHelper {    static final class FXHelper {        private static void setFXLaunchParameters(String what, int mode) {
            ...
            Optionalom = ModuleLayer.boot().findModule(JAVAFX_GRAPHICS_MODULE_NAME);            if (!om.isPresent()) {
                abort(null, "java.launcher.cls.error5");
            }
            ...
        }
    }
}      

顯然，如果不以子產品化 Java 程式的方式啟動，沒有子產品資訊。錯誤碼 java.launcher.cls.error5 即為 “錯誤: 缺少 JavaFX 運作時元件, 需要使用該元件來運作此應用程式。”

不過我們還有其他辦法來繞開 LauncherHelper 的檢查，能夠以非子產品化 Java 程式的方式運作程式。思路是：使程式的入口 main() 不繼承自 javafx.application.Application。

是以，我們可以使用 maven 來運作程式，因為 maven 的 main() 顯然滿足該要求。這用到了 exec-maven-plugin，這個插件是預設包含的，我們可以直接使用它的 property exec.mainClass。

修改 pom.xml：

<properties>
    ...    <exec.mainClass>sample.JFXMainexec.mainClass>
    ...properties>      

運作指令如下：

mvn clean compile exec:java      

除此之外，我們也可以單獨建立一個啟動類：

package sample;import javafx.application.Application;public class AppMain {    public static void main(String[] args) {
        Application.launch(JFXMain.class, args);
    }
}      

編譯報錯：Error: (4, 1) java: -source 8 中不支援 子產品