seraphy / JavaFX11ModuleExample

javaFX11をOpenJDK11でビルド・実行するための実験例。(2018年版、更新版はhttps://github.com/seraphy/Java11BrowserExample)

JavaFXをJava11でビルドして使えるようにする方法

※ 2018/09/26修正: Java11(build 11+28) + OpenJFX11で試したバージョンに差し替え

※ 2021/3/10修正: Java11 + OpenJFX15で配備可能ランタイム作成までの新しい手順の新プロジェクトを作成している。基礎的な注意事項については本稿と変わらないが、ツールが改良されていて手順が簡単になっている。

要旨

Java11から、JavaFXは分離されるので、Java11(OpenJDK11)でJavaFXを使うにはどうしたらよいのか？

結論としては、以下の2点だけ注意すればよさそう。

• JavaFX(OpenJFX)はライブラリとして提供される(Java11以降)
  • MavenのCentral Repositoryに公開済みなので、pomの依存ライブラリとして書いておけばよい。
  • http://mail.openjdk.java.net/pipermail/openjfx-dev/2018-July/022088.html
• JavaFXはモジュールになっている(Java9以降)
  • java起動時に、 --add-modules javafx.controls,javafx.fxml のように指定するか、
  • 自分のjarにもmodule-info.javaをつけて、単に --module modulename/FQCN のようにjavaを起動する。

実験コード

Windows上のOpenJDK11(11+28)で、以下のようなJavaFXの簡単なコードで試す。

> java -version
openjdk version "11" 2018-09-25
OpenJDK Runtime Environment 18.9 (build 11+28)
OpenJDK 64-Bit Server VM 18.9 (build 11+28, mixed mode)

使用したMavenは、Apache Maven 3.5.4

> mvn -v
Apache Maven 3.5.4 (1edded0938998edf8bf061f1ceb3cfdeccf443fe; 2018-06-18T03:33:14+09:00)
Maven home: C:\Java\apache-maven-3.5.4\bin\..
Java version: 11, vendor: Oracle Corporation, runtime: C:\java\jdk-11
Default locale: ja_JP, platform encoding: MS932
OS name: "windows 7", version: "6.1", arch: "amd64", family: "windows"

JavaModuleExample.java

package jp.seraphyware.example;

import javafx.application.Application;
import javafx.scene.*;
import javafx.scene.control.*;
import javafx.stage.*;
import javafx.fxml.*;
import javafx.beans.property.*;
import javafx.collections.*;
import javafx.collections.FXCollections;

import java.net.*;
import java.text.*;
import java.io.*;
import java.util.*;

/**
 * システムプロパティを表示するJavaFX画面サンプル
 */
public class JavaModuleExample extends Application implements Initializable {

    /**
     * テーブルビューのモデル
     */
    private static class SysProp {

        private StringProperty name = new SimpleStringProperty();

        private StringProperty value = new SimpleStringProperty();

        public StringProperty name() {
            return name;
        }

        public StringProperty value() {
            return value;
        }
    }

    @FXML
    private TableView<SysProp> tblSysProps;

    @FXML
    private TableColumn<SysProp, String> colName;

    @FXML
    private TableColumn<SysProp, String> colValue;

    private ObservableList<SysProp> sysPropItems = FXCollections.observableArrayList();

    private Stage stage;

    @Override
    public void start(Stage stage) {
        this.stage = stage;

        // FXMLからシーングラフを作成する
        // ※ FXMLLoaderはリフレクションによって、このクラスのプライベートフィールドに書き込む。
        // そのためにはmodule-infoでopensしておく必要がある。
        var ldr = new FXMLLoader();
        ldr.setController(this);
        var fxmlLoc = JavaModuleExample.class.getResource("/MainWindow.fxml");
        System.out.println("fxml=" + fxmlLoc);
        ldr.setLocation(fxmlLoc);

        Parent parent;
        try {
            parent = (Parent) ldr.load();

        } catch (IOException ex) {
            throw new UncheckedIOException(ex);
        }

        // タイトルにモジュール名／クラス名を表示する。
        // 無名クラス(クラスパス指定による起動)の場合はモジュール名はnullとなる。
        Class<?> cls = JavaModuleExample.class;
        stage.setTitle(cls.getModule().getName() + "/" + cls.getSimpleName());

        stage.setScene(new Scene(parent));
        stage.show();
    }

    @Override
    public void initialize(URL location, ResourceBundle resources) {
        colName.setCellValueFactory(feature -> feature.getValue().name());
        colValue.setCellValueFactory(feature -> feature.getValue().value());
        tblSysProps.setItems(sysPropItems);
        initSysPropList();
    }

    private void initSysPropList() {
        var sysProps = System.getProperties();
        var items = new ArrayList<SysProp>();
        for (var name : new TreeSet<>(sysProps.stringPropertyNames())) {
            var value = sysProps.getProperty(name);
            var item = new SysProp();
            item.name().set(name);
            item.value().set(value);
            items.add(item);
        }
        sysPropItems.setAll(items);
    }

    @FXML
    protected void onClose() {
        stage.close();
    }

    public static void main(String... args) throws Exception {
        launch(args);
    }
}

MainWindow.fxml

<?xml version="1.0" encoding="UTF-8"?>
<?import javafx.geometry.Insets?>
<?import javafx.scene.control.Button?>
<?import javafx.scene.control.ButtonBar?>
<?import javafx.scene.control.TableColumn?>
<?import javafx.scene.control.TableView?>
<?import javafx.scene.control.TitledPane?>
<?import javafx.scene.layout.VBox?>
<VBox maxHeight="-Infinity" maxWidth="-Infinity" minHeight="-Infinity" minWidth="-Infinity" prefHeight="400.0" prefWidth="600.0"
    xmlns="http://javafx.com/javafx/8.0.111"
    xmlns:fx="http://javafx.com/fxml/1">
    <children>
        <TitledPane animated="false" collapsible="false" maxHeight="1.7976931348623157E308" maxWidth="1.7976931348623157E308" text="システムプロパティ一覧" VBox.vgrow="ALWAYS">
            <content>
                <TableView fx:id="tblSysProps" maxHeight="1.7976931348623157E308" maxWidth="1.7976931348623157E308">
                    <columns>
                        <TableColumn fx:id="colName" prefWidth="150.0" text="プロパティ名" />
                        <TableColumn fx:id="colValue" minWidth="0.0" prefWidth="347.0" text="値" />
                    </columns>
                </TableView>
            </content>
        </TitledPane>
        <ButtonBar prefHeight="40.0" prefWidth="200.0">
            <buttons>
                <Button cancelButton="true" mnemonicParsing="false" onAction="#onClose" text="閉じる(終わる)" />
            </buttons>
            <VBox.margin>
                <Insets bottom="5.0" left="5.0" right="5.0" top="5.0" />
            </VBox.margin>
            <padding>
                <Insets right="20.0" />
            </padding>
        </ButtonBar>
    </children>
</VBox>

module-info.java

このサンプルはモジュールにもするので、以下のように module-info.java もつける。

module javamoduleexample {
    requires transitive javafx.graphics;
    requires transitive javafx.controls;
    requires transitive javafx.fxml;

    // FXMLLoaderがリフレクションを使うためにopensする必要がある
    opens jp.seraphyware.example;
    exports jp.seraphyware.example;
}

モジュール名は「javamoduleexample」としている。

また、opens により、FXMLLoaderがコントローラクラスにリフレクション経由でアクセスできるようにしている。(@FXMLの部分)

Mavenでのビルド

ビルド時にはOpenJDK11にパスを通しておくこと。

(JavaFXまわりのライブラリはMavenでダウンロードされるので、OpenJFXのSDKなどは入れておく必要はない。)

<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/maven-v4_0_0.xsd">
	<modelVersion>4.0.0</modelVersion>

	<groupId>jp.seraphyware.example</groupId>
	<artifactId>javamoduleexample</artifactId>
	<version>1.0-SNAPSHOT</version>

	<packaging>jar</packaging>

	<name>JavaModuleExample</name>
	<url>http://maven.apache.org</url>

	<properties>
		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
		<java.version>11</java.version>
		<openjfx.version>11</openjfx.version>
		<mainClass>jp.seraphyware.example.JavaModuleExample</mainClass>
	</properties>

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

	<build>
		<plugins>
			<!-- java10以降のコンパイル -->
			<plugin>
				<groupId>org.apache.maven.plugins</groupId>
				<artifactId>maven-compiler-plugin</artifactId>
				<version>3.8.0</version>
				<configuration>
					<release>${java.version}</release>
				</configuration>
			</plugin>
			<!-- JAR -->
			<plugin>
				<groupId>org.apache.maven.plugins</groupId>
				<artifactId>maven-jar-plugin</artifactId>
				<version>3.1.0</version>
				<configuration>
					<!-- 依存jarと同じmodsファイルに出力する -->
					<outputDirectory>${project.build.directory}/mods</outputDirectory>
					<archive>
						<manifest>
							<!-- MEANIFESTによるメインクラスの指定は意味ないかも。
								 java -p mods -m javamoduleexample/jp.seraphyware.example.JavaModuleExampl
								で起動するため。 -->
							<mainClass>${mainClass}</mainClass>
						</manifest>
					</archive>
				</configuration>
			</plugin>
			<!-- 依存するJARのlibへの展開 -->
			<plugin>
				<groupId>org.apache.maven.plugins</groupId>
				<artifactId>maven-dependency-plugin</artifactId>
				<version>3.1.1</version>
				<executions>
					<execution>
						<id>copy-dependencies</id>
						<phase>prepare-package</phase>
						<goals>
							<goal>copy-dependencies</goal>
						</goals>
						<configuration>
							<outputDirectory>${project.build.directory}/mods</outputDirectory>
							<overWriteReleases>false</overWriteReleases>
							<overWriteSnapshots>false</overWriteSnapshots>
							<overWriteIfNewer>true</overWriteIfNewer>
							<includeScope>runtime</includeScope>
						</configuration>
					</execution>
				</executions>
			</plugin>
			<plugin>
				<groupId>org.apache.maven.plugins</groupId>
				<artifactId>maven-antrun-plugin</artifactId>
				<version>1.8</version>
				<executions>
					<!-- 展開されたjavafxの依存jarのうち、-win.jar以外のものを消す。 (-win.jarでないものは1kbの中身空jarであり、module-infoもMANIFESTによる名前指定もないので、
						ないので、ファイル名から自動モジュール名がつけられるが、これがよろしくない。)
						** OpenJFX11正式版では空のjarには xxxEmptyという、別名となるモジュール名が割り当てられ衝突しなくなったので不要となった。 **
						** 不要なjarであることには変わりないので、以下のスクリプトで消しても良い **
					<execution>
						<id>copy-dependencies</id>
						<phase>prepare-package</phase>
						<goals>
							<goal>run</goal>
						</goals>
						<configuration>
							<target>
								<delete>
									<fileset dir="${project.build.directory}/mods">
										<include name="javafx-*.jar" />
										<exclude name="javafx-*-win.jar" />
										<exclude name="javafx-*-mac.jar" />
									</fileset>
								</delete>
							</target>
						</configuration>
					</execution>
					-->
					<execution>
						<!--
							現時点(maven-jar-plugin:3.1.0)では、module-info.javaに対する、module-main-class, module-version属性を
							付与することができないので、java9以降のjarコマンドを直接使用して属性を更新させる。
							https://stackoverflow.com/questions/43671410/how-to-specify-main-class-and-module-version-in-maven-jar-plugin

							これにより、
							java -p target/mods -m javamoduleexample
							としてモジュール名を指定してモジュールのメインクラスを実行することができる。
						-->
						<id>module-info-attributes</id>
						<phase>package</phase>
						<goals>
							<goal>run</goal>
						</goals>
						<configuration>
							<target>
								<exec executable="${java.home}/bin/jar" failonerror="true">
									<arg value="--main-class" />
									<arg value="${mainClass}" />
									<arg value="--module-version" />
									<arg value="${project.version}" />
									<arg value="--update" />
									<arg value="--file" />
									<arg value="${project.build.directory}/mods/${project.artifactId}-${project.version}.jar" />
								</exec>
							</target>
						</configuration>
					</execution>
				</executions>
			</plugin>
			<!-- Mavenからモジュールとして実行できるようにする。
				https://www.mojohaus.org/exec-maven-plugin/examples/example-exec-for-java-programs.html
				mvn package exec:exec
			 -->
			<plugin>
				<groupId>org.codehaus.mojo</groupId>
				<artifactId>exec-maven-plugin</artifactId>
				<version>1.6.0</version>
				<configuration>
					<executable>${java.home}/bin/java</executable>
					<arguments>
						<argument>-p</argument>
						<modulepath />
						<argument>-m</argument>
						<argument>javamoduleexample/${mainClass}</argument>
					</arguments>
				</configuration>
			</plugin>
		</plugins>
	</build>
</project>

ビルド設定の要点

• OpenJFX 11 のものを使用する
• コンパイルでは release=11 を指定した。
  • java10以前ではASMを差し替える等の細工が必要だったが、maven-compiler-plugin:3.8.0 では指定はいらないようだ。(むしろ不味い？)

ビルドとモジュールとしての実行

mvn package exec:exec

このようにすると、ビルドして、実際にJavaFXのアプリケーションを起動してくれる。

exec-maven-plugin:1.6.0 以降の機能を使って、モジュールを指定して起動させている。

JavaFX関連jarの抜き出し

maven-dependency-plugin で依存jarをmodsフォルダに出力するようにしているので、 package コマンドを実行すると、以下のファイルができる。

• javafx-base-11-win.jar
• javafx-base-11.jar
• javafx-controls-11-win.jar
• javafx-controls-11.jar
• javafx-fxml-11-win.jar
• javafx-fxml-11.jar
• javafx-graphics-11-win.jar
• javafx-graphics-11.jar
• javamoduleexample-1.0-SNAPSHOT.jar

対象とするプラットフォームごとに依存jarが異なるようで、Windowsの場合は javafx-*-win.jar という名前がつけられている。

(ちなみに、Macの場合には、javafx-*-mac.jar という名前が付けられている。)

win.jar でないものは、中身が空で、いらないものである。

なお、正式版でなかった時は、モジュール名の衝突問題があったため、この不用な空のjarは削除する必要があったが、正式版では空のjarにはMANIFEST.MF上で明示的に衝突しないxxxxEmptyというダミーのモジュール名を割り当てているため、削除しなくても問題ない。(しかし、無意味なjarであるので消したほうが良いとは思われる。)

なお、最後の「javamoduleexample-1.0-SNAPSHOT.jar」は、このサンプルのモジュールjarである。

javaコマンドからの実行

Javaコマンドでモジュールとして扱うには以下のようにする。

java -p target/mods -m javamoduleexample/jp.seraphyware.example.JavaModuleExample

ウィンドウタイトルは「モジュール名／クラス名」を表示するようにしている。

モジュールの実行クラスを指定する場合

モジュールには「module-main-class」や「module-version」という属性をmodule-info.classに付与することができ、その場合は、

java -p target/mods -m javamoduleexample

このようにモジュール名を指定するだけでメインクラスを実行することができる。

ただし、現時点ではソースコードや、Mavenのmaven-jar-plugin(3.1.0)からは、これらの属性は設定できない。(将来的にはjarプラグインが対応するものと思われる)

現在この属性は jdkの jar コマンドによって付与する。

mavenでは maven-antrun-plugin を使って、JAVA_HOME/bin/jar コマンドを起動して直接書き換えることになる。

<plugin>
	<groupId>org.apache.maven.plugins</groupId>
	<artifactId>maven-antrun-plugin</artifactId>
	<version>1.8</version>
	<executions>
		<execution>
			<phase>package</phase>
			<goals>
				<goal>run</goal>
			</goals>
			<configuration>
				<target>
					<exec executable="${java.home}/bin/jar" failonerror="true">
						<arg value="--main-class" />
						<arg value="${mainClass}" />
						<arg value="--module-version" />
						<arg value="${project.version}" />
						<arg value="--update" />
						<arg value="--file" />
						<arg value="${project.build.directory}/mods/${project.artifactId}-${project.version}.jar" />
					</exec>
				</target>
			</configuration>
		</execution>
	</executions>
</plugin>

こうして設定された属性の内容は

jar --describe-module --file=target\mods\javamoduleexample-1.0-SNAPSHOT.jar

のようにして確認することができる。

jlinkで配備用パッケージを作成してみる

jlinkを使うことにより、使用しているモジュールだけに絞り込んだ配備用のJREを作成できる。

また、そのときランチャ用のスクリプトも指定できる。

jlink --module-path target/mods --add-modules javamoduleexample --no-man-pages --no-header-files --verbose --output release --launcher run=javamoduleexample/jp.seraphyware.example.JavaModuleExample

モジュールパスを指定して、メインとなるモジュールを指定すれば、それが依存するモジュールに絞り込んだJREが作成される。

---launcher シェル名=モジュール名／FQCN とすることで、起動用のシェルも作成してくれる。(中身をみると、たいしたことはやってないのだが。)

これでできあがった実行環境は

release\bin\run.bat

のようにして起動できる。

※ openjfxの 11-ea+19 の場合はネイティブライブラリのロードに失敗するため、jarからdllを抽出してコピーするという小細工が必要だったが、 *** 11-ea+25 では修正された *** ようである。

Macの場合

#! /bin/bash
export JAVA_HOME=$(/usr/libexec/java_home)

mvn clean package

rm -fr release
$JAVA_HOME/bin/jlink --module-path target/mods --add-modules javamoduleexample --no-man-pages --no-header-files --verbose --output release --launcher run=javamoduleexample/jp.seraphyware.example.JavaModuleExample

release/bin/run

実行時にNoSuchMethodErrorエラーが発生する場合

起動時に

Exception in thread "WindowsNativeRunloopThread" java.lang.NoSuchMethodError: <init>
        at javafx.graphics/com.sun.glass.ui.win.WinApplication.staticScreen_getScreens(Native Method)
        at javafx.graphics/com.sun.glass.ui.Screen.initScreens(Screen.java:412)
        at javafx.graphics/com.sun.glass.ui.Application.lambda$run$1(Application.java:152)
        at javafx.graphics/com.sun.glass.ui.win.WinApplication._runLoop(Native Method)
        at javafx.graphics/com.sun.glass.ui.win.WinApplication.lambda$runLoop$3(WinApplication.java:174)
        at java.base/java.lang.Thread.run(Thread.java:834)

のようなエラーがでる場合は、環境変数PATHの中で古いJavaFXを参照して、そのDLLが読み込まれている可能性がある。

(Pleiades標準のEclipseのプラグインでパッケージエクスプローラからコマンドプロンプトを開くものがあるが、 これを使うとEclipseまわりのパスが環境変数PATHに設定されるので不味いことになるようだ。)

対策として、Java関連のPATHをないようにしてする。

たとえば、

set PATH=C:\Windows\system32;C:\Windows
release\bin\run.bat

のようなシンプルな最小限のパスにしてから起動してみると良いかもしれない。

Pleiades201809のAdoptOpenJDK11での実行

Pleiades-201809のJava11でJavaFXをEclipse上から実行する場合も、同様な理由で上記NoSuchMethodError例外が発生する。

これは起動時のPATHに現在のEclipseが使っているパスが含まれているためである。

「実行の構成」から「環境」タブで、環境変数PATHを"${env_var:SystemRoot}\System32;${env_var:SystemRoot}"のように書き換えてやると、うまく起動できるようになる。

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<launchConfiguration type="org.eclipse.jdt.launching.localJavaApplication">
<listAttribute key="org.eclipse.debug.core.MAPPED_RESOURCE_PATHS">
<listEntry value="/javafx11moduleexample/src/main/java/jp/seraphyware/example/JavaModuleExample.java"/>
</listAttribute>
<listAttribute key="org.eclipse.debug.core.MAPPED_RESOURCE_TYPES">
<listEntry value="1"/>
</listAttribute>
<booleanAttribute key="org.eclipse.debug.core.appendEnvironmentVariables" value="false"/>
<mapAttribute key="org.eclipse.debug.core.environmentVariables">
<mapEntry key="Path" value="${env_var:SystemRoot}\System32;${env_var:SystemRoot}"/>
</mapAttribute>
<booleanAttribute key="org.eclipse.jdt.launching.ATTR_EXCLUDE_TEST_CODE" value="true"/>
<booleanAttribute key="org.eclipse.jdt.launching.ATTR_USE_CLASSPATH_ONLY_JAR" value="false"/>
<stringAttribute key="org.eclipse.jdt.launching.CLASSPATH_PROVIDER" value="org.eclipse.m2e.launchconfig.classpathProvider"/>
<stringAttribute key="org.eclipse.jdt.launching.MAIN_TYPE" value="jp.seraphyware.example.JavaModuleExample"/>
<stringAttribute key="org.eclipse.jdt.launching.PROJECT_ATTR" value="javafx11moduleexample"/>
<stringAttribute key="org.eclipse.jdt.launching.SOURCE_PATH_PROVIDER" value="org.eclipse.m2e.launchconfig.sourcepathProvider"/>
</launchConfiguration>

まとめ

MavenでJavaFXを普通のライブラリとしてビルドできるようにしてもらったおかげで、JavaFXアプリのOpenJDK11対応も、それほど不自由なくゆけそうな感じである。

Java9以降のモジュール仕組みに不慣れであったため戸惑うところもあるが、これは本質とは、あまり関係ない。

それほど案ずる必要はなかったという実感を得た。

参考

今回お世話になった数々のページ。順不同

• Getting Started with JavaFX 11 MavenでJavaFX11をビルドする手順が親切です
• OpenJFX11 + OpenJDK11 + Maven で JavaFX を動かす
• Java 8 で作成した JavaFX アプリケーションを Java 9 で動かす Again
• JDK9でのjavapackagerについて
• AnalogClockプログラムをJava SE 9のモジュール化
• JDK9のモジュールとjlinkでアプリ配布向けのJVMを作る
• Using Java 9 Modularization to Ship Zero-Dependency Native Apps

以上、メモ終了。