在 Intellij IDEA 裏使用 OpenJFX (JavaFX)

JDK 11 把 JavaFX 剝離了出來，造成了單獨且開源的 OpenJFX 模塊。

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

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

咱們的 pom.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>sample</groupId>
    <artifactId>javafx</artifactId>
    <version>1.0-SNAPSHOT</version>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <mainClass>sample.JFXMain</mainClass>
        <javafx.version>11</javafx.version>
    </properties>

    <dependencies>

        <dependency>
            <groupId>org.openjfx</groupId>
            <artifactId>javafx-controls</artifactId>
            <version>${javafx.version}</version>
        </dependency>
        <dependency>
            <groupId>org.openjfx</groupId>
            <artifactId>javafx-fxml</artifactId>
            <version>${javafx.version}</version>
        </dependency>

    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.8.0</version>
                <configuration>
                    <source>11</source>
                    <target>11</target>
                </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) {
            ...
            Optional<Module> om = 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.JFXMain</exec.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);
    }
}

從這個類啓動 Java 程序，效果相同。

編譯報錯：Error: (4, 1) java: -source 8 中不支持 模塊

根據上文所述的方法，檢查並修改 Project bytecode version。

---

原文連接 https://blog.xupu.name/p/using-openjfx-in-intellij-idea/