■SpringBootアプリをjavafxを使って配布しやすくしよう

概要

Javaで開発されたアプリケーションにはインストールにまつわる難点がある。

それによりせっかく興味をもってくれたユーザーも試す前に諦めてしまいがちである。

また、サーバーサイドアプリケーションもJava製である場合、デプロイや監視の際の難点が多く運用者を悩ませてきた。

javafxで導入されたパッケージャを用いることで各OSネイティブなインストーラーの作成が可能になり、この問題を解消・緩和できる。

SpringBoot などを用いた ExecutableJar を作成するアプリケーションであれば、サーバーサイドアプリケーションであっても一部制限があるもののパッケージングできる。

問題点の整理

Javaで開発されたアプリケーションの配布には以下の問題点がある。

• jreのインストールが必要
  • 30億のデバイスで動こうがそれはjreをインストールした後の話。
  • .netのランタイムのインストールすら面倒で敬遠されるのにOracleとか無理やろ。
  • 自動インストールさせるのも面倒。野良リポジトリURLを追加したりOracleからのダウンロード自動化したり。
• 起動の仕方があまり標準的でない
  • 一般人にとってアプリケーションの起動とは application.exe や application を実行するもの。
  • application.bat や application.sh とかいい加減にしろ！
  • java -jar application.jar とか本当にユーザーに起動させる気あんのか！
• プロセス名がすべてjava
  • 負荷監視時のプロセスの特定が面倒
  • 運用時、killする対象のプロセス取り違えなどのリスクがある
  • だから java という文字列をユーザーに見せるな！！
• 複数バージョンのjreをアプリ毎に切り替えないといけない場合は更に煩雑に
  • JAVA_HOMEを書き換える？alternatives --config java？
  • そんな複雑なことできるか！馬鹿にすんな！！
• パッケージングに関する情報や知見に乏しい
  • ドキュメントは英語だったり曖昧だったりで開発者の意欲を削ぐ。
  • java web start とかコード署名とか、本当にもうお疲れ様です。意味わからん。
• インストーラーじゃない
  • application.tar.gz とか application.zip とか
  • まぁ個人的にはこっちのほうが好きだけど

解決方法として

javafx-maven-pluginを使うとよい。javafxと冠しているが実態はパッケージングツール。

javafxの冠があるがためにスタンドアロンアプリ開発者以外を遠ざけている感あり。

Windows(msi/exe), Linux(rpm/deb), Mac(dmg) など各OS・ディストリビューション固有のパッケージングが行える。

公式ページ( http://zenjava.com/javafx/maven/ )では更新が止まっているが、Github( https://github.com/zonski/javafx-maven-plugin )とMavenRepository( http://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22com.zenjava%22%20AND%20a%3A%22javafx-maven-plugin%22 )を確認するとちゃんと開発は続いている。

実際にどのようにすればパッケージングできるか

まずアプリケーションを maven アプリとして開発する。

pom.xml に以下を追加する。

mainClassはSpringBootなら@SpringBootApplicationのついてるクラスですね。

vendor は適当に組織や個人の名前を入れておきましょう。

※ 以下の XML が化けるのは増田の不具合か仕様っぽい。 http://anond.hatelabo.jp/20100205210805

<plugin>
  <groupId>com.zenjava</groupId>
  <artifactId>javafx-maven-plugin</artifactId>
  <version>8.1.2</version>
  <configuration>
    <mainClass>[main method class]</mainClass>
    <vendor>[Vendor Name]</vendor>
  </configuration>
</plugin>

あとはそのままビルドすればよい。

maven clean jfx:native

ビルドが終わると target/jfx/native 以下に、ビルドしたOS/distributionに合わせて msi, exe, deb, rpm, dmg ができあがります。

本当であればクロスビルドできてしかるべきなのですが、まだ実現はされていないようです。

これらのパッケージは Widonws であれば Program Files(x86) に、Linux系であれば /opt/ の下にインストールされるようです。

/opt/app-name/ の下には app と runtime の2つのディレクトリがあります。

app の下にはビルドした jar ファイルや依存ライブラリが置かれています。

runtime の下には実行用の jre が配備されています。

実行ファイルにそのまま引数を渡せば jar 実行時の引数としてそのまま渡されます。(-Xmxなどはまだ未検証です）

課題

• インストーラーで含めることのできる実行環境は jre なので jdk が必要とされるアプリは実行できない
  • 問題になるのは jsp 。jsp のコンパイルに javac が必要なので。
  • 切り捨てるのが一番だとは思いますが。
• サーバー系のアプリの場合は init script を用意しなければいけない
  • 今後の検討課題ですね。

各OS毎の注意点

• rpm系
  • rpmを作成するときに使われる rpmbuild コマンドのバージョンを確認処理に萎える系のバグがあります。
  • LANG=C mvn clean jfx:native などのように、LANGを変更してやればビルドできます。
  • http://hg.openjdk.java.net/openjfx/8u-dev/rt/rev/ee31427caf20
• Windows系
  • WiXインストール後、PATHにWiXをインストールしたパスを含めておく必要があります。
• Mac系
  • Mac持ってないのでこの記事ではそもそも検証していません。

ツイートする

Permalink | トラックバック(0) | 16:52