2 自己完結型アプリケーションのパッケージ化

自己完結型アプリケーションを作成する最も容易な方法は、デプロイメント・タスクを変更することです。実行中のプラットフォームのすべてのタイプの自己完結型アプリケーション・パッケージの作成を要求するには、次の例に示すように、nativeBundles="all"を<fx:deploy>タスクに追加します。

<fx:deploy width="${javafx.run.width}" height="${javafx.run.height}"
           nativeBundles="all"
           outdir="${basedir}/${dist.dir}" outfile="${application.title}">
    <fx:application name="${application.title}" mainClass="${javafx.main.class}"/>
    <fx:resources>
        <fx:fileset dir="${basedir}/${dist.dir}" includes="*.jar"/>
    </fx:resources>
    <fx:info title="${application.title}" vendor="${application.vendor}"/>
</fx:deploy>

作成する正確なパッケージ形式を指定することもできます。値imageを使用して、基本パッケージ(EXEインストーラを要求するにはexe、DMGインストーラを要求するにはdmgなど)を作成します。属性値の完全なリストは、Antタスク・リファレンスの<fx:deploy>エントリのnativeBundles属性を参照してください。

Javaパッケージャ・ツールを使用して、ネイティブ・パッケージを作成することもできます。-nativeオプションを-deployコマンドと一緒に使用して、特定の形式を要求できます。Java Platform, Standard Editionツール・リファレンスのjavapackagerコマンドを参照してください。

例2-1は、BrickBreakerアプリケーションに適用可能なすべての自己完結型アプリケーション・パッケージの生成に使用される、-deployコマンドとともに使用する-nativeオプションの使用を示しています。-deployコマンドは入力としてJARファイルが必要であるため、dist/BrickBreaker.jarがすでにビルドされていることを前提としています。

javapackager -deploy -native -outdir packages -outfile BrickBreaker 
    -srcdir dist -srcfiles BrickBreaker.jar -appclass brickbreaker.Main 
    -name "BrickBreaker" -title "BrickBreaker demo"

パッケージ化ツールでは、アプリケーション・アイコンまたは構成ファイルなどのパッケージを作成するいくつかの組込みリソースを使用します。生成されるパッケージをカスタマイズする1つの方法は、組込みリソースをカスタマイズされたバージョンで置き換えることです。

次のアクションが必要です。

• カスタム・リソースの準備

• 組込みリソースの置換

自己完結型アプリケーション・パッケージの基本形式の作成およびカスタマイズは非常に簡単なプロセスですが、次の点に注意してください。

• 異なるプラットフォームには異なるアイコン・タイプが必要です。

  たとえば、Windowsでは.ico形式が必要で、Linuxでは.png形式およびmacOSでは.icns形式が必要です。Linuxではランチャにアイコンは埋め込まれておらず、かわりに.desktopファイルがアイコンを参照します。

• JavaFXアプリケーションでは、アイコンをアプリケーション・ステージに追加して、アイコンが実行時に設定されていることを確認します。たとえば、JavaFXアプリケーションのstart()メソッドに次のコードを追加します。

  stage.getIcons().add(new
       Image(this.getClass().getResourceAsStream("app.png")));
  

• アプリケーションを配布する場合、出力フォルダのファイルに署名します。

  たとえば、Windowsでは、signtool.exeを使用して起動ツールの実行ファイルに署名できます。

コマンドラインから自己完結型アプリケーションが起動される際に、アプリケーションに引数を渡すことができます。引数が指定されていない場合は、アプリケーションに渡す引数のセットを定義することもできます。デフォルトの引数を定義するには、javapackager deployコマンドで-argumentオプションを使用するか、アプリケーション・パッケージの作成時にAntタスクで<fx:argument>要素を使用します。コマンドラインから入力された引数は、デフォルトの引数に優先されます。アプリケーションがランチャ・アイコンから起動される場合、デフォルトの引数が使用されます。

アプリケーションのファイルの関連付けを登録するように自己完結型アプリケーションのインストーラを設定できます。Antタスクで<fx:association>要素を使用して、アプリケーションによって処理できるファイルを識別します。ファイルの関連付けは、ファイル拡張子またはMIMEタイプに基づきます。

次の例では、アプリケーションをMIMEタイプがapplication/x-vnd.MyAppFileのファイルに関連付けます。

<fx:info title="Association example">
  <fx:association mimetype="application/x-vnd.MyAppFile" description="Sample Test Files">
  </fx:association>
</fx:info>

自己完結型アプリケーションのパッケージを構築して、複数のエントリ・ポイントを持つ製品スイートをサポートできます。各エントリ・ポイントには独自のショートカットまたはアイコンがあります。<fx:application>要素のmainClass属性では、プライマリ・エントリ・ポイントを識別します。<fx:deploy>タスクで<fx:secondaryLauncher>要素を使用して、各セカンダリ・エントリ・ポイントを定義します。

次の例では、WindowsのTestSuiteアプリケーションのエントリ・ポイントを定義します。

<fx:deploy outdir="test/apps" nativeBundles="image">
    <fx:application name="TestSuite Sample"
                    mainClass="samples.TestSuite"/>

    <fx:info title="Test Suite"/>

    <fx:secondaryLauncher
        mainClass="samples.TestSuite"
        name="Suite Applications"/>
        shortcut="true"/>
 
    <fx:secondaryLauncher name="Editor">
        <fx:bundleArgument arg="icon" value="../resources/editor.ico"/>
    </fx:secondaryLauncher>
 
    <fx:secondaryLauncher name="Spreadsheet">
        <fx:bundleArgument arg="icon" value="../resources/spreadsheet.ico"/>
    </fx:secondaryLauncher>
</fx:deploy>

ターゲット・オペレーティング・システムおよび使用可能なパッケージ化ツールに基づいて、自己完結型アプリケーションのインストール可能なパッケージを作成します。

EXEパッケージを生成するには、Inno Setup 5以降をインストールし、PATHで使用可能にする必要があります。使用可能であることを検証するには、ビルドを起動するコマンド行またはビルド・スクリプトからiscc.exeの実行を試行します。

デフォルトでは、生成されたパッケージには次の特性があります。

• 管理権限は必要ありません。

• 最少のダイアログ数になるよう最適化されます。

• プログラム・メニューまたはデスクトップ・ショートカット、あるいはその両方から参照されます。

• インストールの終わりにアプリケーションを起動します。

図2-2は、Windows上にインストール中の自己完結型JavaFXアプリケーションの一般的なダイアログ・ボックスを示しています。

図2-2 Windowsの自己完結型JavaFXアプリケーションのインストール・ダイアログ

「図2-2 Windowsの自己完結型JavaFXアプリケーションのインストール・ダイアログ」の説明

カスタマイズのヒント:

• システム全体のインストールを選択した場合、ユーザーは管理権限を持っている必要があり、インストールの終わりにアプリケーションは起動しません。

• クリックスルー・ライセンスはサポートされています。.rtfファイルが必要です。

• インストール・ダイアログに表示されるイメージを、アプリケーション・アイコンとは異なるものにできます。

  現在のバージョンのInno Setupでは、イメージが55x58ピクセルの最大サイズのビットマップ・ファイルであることを想定しています。

• JavaFXアプリケーションでは、アイコンをアプリケーション・ステージに追加して、アイコンが実行時に設定されていることを確認できます。

• 生成される.exeパッケージに署名できます。

  信頼できる認証局(TSA)から証明書を取得してから、Windowsのsigntool.exeユーティリティを使用してコードに署名する必要があります。

• Windowsスクリプト・ファイルを使用して、起動ツール実行可能ファイルに署名するためなど、.exeファイルに自己完結型アプリケーション・フォルダをラップする前に、微調整できます。

カスタム・イメージの追加およびWindowsスクリプト・ファイルの指定の技術は、ドロップイン・リソースを使用したパッケージのカスタマイズで説明されています。アイコンをJavaFXアプリケーションのアプリケーション・ステージに追加するには、基本パッケージのプラットフォーム固有のカスタマイズを参照してください。

Windows Installer XML (WiX)ツールセット(WiXとも呼ばれる)を使用して、MSIパッケージが生成されます。WiX 3.8以降が必要で、PATHで使用できる必要があります。検証するには、ビルドを起動するコマンド行またはビルド・スクリプトからcandle /?の実行を試行します。

デフォルトでは、生成されたMSIパッケージには次の特性があります。

• エンタープライズ・デプロイメント・ツールを使用したデプロイメント用に最適化されます。

• システム全体の場所にインストールします。

• クリックスルーUIがなく、進捗ダイアログのみが表示されます。

• プログラム・メニューまたはデスクトップ・ショートカット、あるいはその両方から参照されます。

• インストール・プロセス以外で作成されても、インストール・フォルダのすべてのファイルを削除します。(WiX 3.5以降が必要です。)

• アプリケーション識別子のUpgradeCodeとしての使用を試行します。

  アプリケーション識別子が有効なGUIDではない場合、UpgradeCodeのランダムなGUIDが生成されます。

• ProductCodeをランダムに生成します。

固定製品コードを使用したり、MSIパッケージにカスタムUIを追加するには、ドロップイン・リソースを使用したパッケージのカスタマイズで説明されているように、Javaパッケージャで使用されるWiXテンプレート・ファイルをカスタマイズします。カスタムUIについては、WiXドキュメントも参照してください。

ネットワーク上でMSIパッケージを配布する場合、最適なユーザー操作のためにこれに署名します。

起動ツール実行可能ファイルに署名するためなど、.msiファイルに自己完結型アプリケーション・フォルダをラップする前に、微調整することもできます。

デフォルトでは、DMGパッケージは単純なドラッグ・アンド・ドロップのインストール操作を提供しています。図2-3は、インストール中のデフォルト動作の例を示しています。

図2-3 macOSのデフォルト・インストーラの例

「図2-3 macOSのデフォルト・インストーラの例」の説明

インストール・ウィンドウの外観をカスタマイズするために、カスタム・バックグラウンド・イメージを指定できます。

バックグラウンド・イメージに異なるディメンションがあるか、アイコンを別に配置する必要がある場合、インストール・ビュー内の要素のサイズおよび位置を変更するために使用されるDMG設定スクリプトをカスタマイズする必要もあります。ドロップイン・リソースを使用したパッケージのカスタマイズを参照してください。

図2-4 macOSのインストール可能なパッケージのカスタマイズされた外観の例

「図2-4 macOSのインストール可能なパッケージのカスタマイズされた外観の例」の説明

自己完結型アプリケーション・フォルダをラップする前に微調整するには、アプリケーション・フォルダが移入された後で実行する独自のbashスクリプトを指定します。そのようなアクションのスクリプトを、パッケージへのローカリゼーション・ファイルの追加として使用できます。図2-4は、調整されたアプリケーション・インストーラの例を示しています。

Gatekeeperフレンドリなパッケージを作成するには、DMGパッケージのアプリケーションに署名する必要があります。DMGファイル自体には署名する必要はありません。Macバンドラはアプリケーションの署名を処理します。ローカル・ユーザー情報が証明書の名前と異なる場合、例2-4に示すように、バンドル引数mac.signing-key-user-nameを設定する必要がある可能性があります。

アプリケーションに手動で署名するために、macOSで説明されている技術を使用して、アプリケーション・バンドルが移入された後で実行する構成スクリプトを指定できます。サンプルDemoAppの場合、構成スクリプトはpackage/macosx/DemoApp-post-image.shにあり、次の例に示すようなコンテンツがあります。

echo "Signing application bundle"
#Move to the folder containing application bundle
cd ../images/dmg.image
#do sign
codesign -s "Developer ID Application" *.app
echo "Done with signing"

DMGインストーラは、テキスト形式で提供されたクリックスルー・ライセンスもサポートしています。リッチ・テキスト形式の使用が必要な場合、license.plistファイルを外部で準備し、ドロップイン・リソースを使用したパッケージのカスタマイズで説明されている技術を使用してパッケージに追加します。

DMGパッケージを作成するには、サード・パーティ製ツールは必要ありません。

Linuxのインストール・パッケージの生成では、インストール・パッケージのビルドに必要なネイティブ・ツールがインストールされていることを前提としています。RPMパッケージの場合、通常、これはRPMBuildパッケージおよびその依存を意味します。DEBパッケージの場合、dpkg-debおよび依存が必要です。

パッケージをビルドするには、管理権限は必要ありません。

デフォルトでは、生成されたパッケージには次の特性があります。

• アプリケーションを/optディレクトリにインストールします。

• ショートカットをアプリケーション・メニューに追加します。

• Linuxパッケージの通常の動作であるインストール用のUIはありません。

カスタマイズのヒント:

• アプリケーション・メニューの特定のカテゴリにアプリケーションを配置するには、<fx:info>のcategory属性を使用します。

  デスクトップ・メニューの仕様を参照し、カテゴリ名のリストはウィンドウ・マネージャのドキュメントを参照してください。

• アイコンは.pngファイルである必要があります。

• ドロップイン・リソースを使用したパッケージのカスタマイズで説明されている技術を使用してビルド・テンプレート・ファイルを調整することによって、高度なカスタマイズが可能です。

  使用可能なオプションの詳細は、DEB/RPMのパッケージ化ガイドを参照してください。