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

7.3.1 自己完結型アプリケーション構造

自己完結型アプリケーション・パッケージの基本形式は、図7-1の例などのハード・ドライブ上の単一フォルダです。 パッケージのいずれかをインストールすると、結果は同じコンテンツのフォルダとなります。

図7-1 自己完結型アプリケーション・パッケージの例

「図7-1 自己完結型アプリケーション・パッケージの例」の説明

自己完結型アプリケーション・フォルダの内部構造は、プラットフォーム固有で、将来変更される可能性があります。 ただし、次のアイテムはすべてのプラットフォームに適用され、変更されない可能性があります。

• 第5章「パッケージ化の基本」に定義されているように、アプリケーション・パッケージはフォルダとして含まれ、アプリケーション・ディレクトリ構造を保持します。

• JREのコピーは別のフォルダとして含まれ、JREディレクトリ構造は保持されます。

ディレクトリ構造が保持されるため、アプリケーションは、アプリケーションJARまたはjava.homeシステム・プロパティに相対的なパスを使用して外部リソースをロードできます。

7.3.2 基本的なビルド

自己完結型アプリケーションを作成する最も容易な方法は、デプロイメント・タスクを変更することです。 実行中のプラットフォームのすべてのタイプの自己完結型アプリケーション・パッケージの作成を要求するには、例7-1に示すように、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パッケージャ・ツールを使用して、ネイティブ・パッケージを作成することもできます。 自己完結型アプリケーション・パッケージは、-makeallコマンドを使用するときにデフォルトでビルドされます。 -nativeオプションを-deployコマンドと一緒に使用して、特定の形式を要求できます。 Windows、またはSolaris、LinuxまたはOS Xのjavapackagerコマンド・リファレンスを参照してください。

例7-2は、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"

7.3.3 ドロップイン・リソースを使用したパッケージのカスタマイズ

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

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

• どのリソースが使用されているかを学習します。

• パッケージ化ツールが検索している場所にカスタム・リソースをドロップします。

次の各項では、カスタム・リソースの使用方法について説明します。

Using base JDK at: /Library/Java/JavaVirtualMachines/jdk1.7.0_06.jdk
  Using default package resource [Bundle config file] (add
    package/macosx/Info.plist to the class path to customize)
  Using default package resource [icon] (add package/macosx/DemoApp.icns
      to the class path to customize)
Creating app bundle: /tmp/test/TestPackage/bundles/DemoApp.app
Config files are saved to /var/folders/rd/vg2ywnnx3qj081sc5pn9_
    vqr0000gn/T/build7039970456896502625.fxbundler/macosx. Use them 
    to customize package.

<taskdef resource="com/sun/javafx/tools/ant/antlib.xml"
         uri="javafx:com.sun.javafx.tools.ant"
         classpath=".:path/to/sdk/lib/ant-javafx.jar"/>

Using base JDK at: /Library/Java/JavaVirtualMachines/jdk1.7.0_06.jdk
  Using default package resource [Bundle config file] (add
      package/macosx/Info.plist to the class path to customize)
Using custom package resource [icon] (loaded from
    package/macosx/DemoApp.icns on class path)
Creating app bundle: /tmp/test/TestPackage/bundles/DemoApp.app

7.3.4 カスタマイズのオプション

自己完結型アプリケーション・パッケージをカスタマイズするには、既存のJava Ant要素の多くが使用されます。 異なるパッケージには異なるパラメータ・セットが必要で、同じ要素が異なる役割を持つ場合があります。 表7-1に、カスタマイズ・オプションの大部分を紹介します。

7.3.5 基本パッケージのプラットフォーム固有のカスタマイズ

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

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

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

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

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

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

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

// Using javapackager tool
 javapackager ... -Bmac.signing-key-user-name="Jane Appleseed"

// Using Ant tasks
   <fx:deploy>
      //...
<fx:bundleArgument arg="mac.signing-key-user-name" value="Jane Appleseed"/>
      //...
    </fx:deploy>

7.3.6 自己完結型アプリケーションへの引数の受渡し

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

7.3.7 ファイルと自己完結型アプリケーションの関連付け

アプリケーションのファイルの関連付けを登録するように自己完結型アプリケーションのインストーラを設定できます。 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>

7.3.8 複数のエントリ・ポイントのサポート

自己完結型アプリケーションのパッケージを構築して、複数のエントリ・ポイントを持つ製品スイートをサポートできます。 各エントリ・ポイントには独自のショートカットまたはアイコンがあります。 <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>

表7-2 インストール可能なパッケージ形式

7.4.1 EXEパッケージ

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

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

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

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

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

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

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

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

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

カスタマイズのヒント:

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

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

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

  7.3.3項「ドロップイン・リソースを使用したパッケージのカスタマイズ」で説明されているように、ドロップイン技術を使用してイメージをカスタマイズできます。

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

• JavaFXアプリケーションでは、アイコンをアプリケーション・ステージに追加して、アイコンが実行時に設定されていることを確認します。 7.3.5項「基本パッケージのプラットフォーム固有のカスタマイズ」を参照してください。

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

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

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

  7.3.3項「ドロップイン・リソースを使用したパッケージのカスタマイズ」で説明されている技術を使用して、Windowsスクリプト・ファイルを指定します。

7.4.2 MSIパッケージ

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

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

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

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

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

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

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

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

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

• ProductCodeがランダムに生成されます。

  固定製品コードを使用するには、7.3.3項「ドロップイン・リソースを使用したパッケージのカスタマイズ」で説明されている技術を使用して、WiXテンプレート・ファイルをカスタマイズします。

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

起動ツール実行可能ファイルに署名するためなど、.msiファイルに自己完結型アプリケーション・フォルダをラップする前に、微調整することもできます。 詳細は、7.4.1項「EXEパッケージ」を参照してください。

MSIパッケージにカスタムUIを追加するには、第7.3.3項、「"ドロップ・イン・リソースを使用したパッケージのカスタマイズ。"項」で説明されている方法を使用して、Javaパッケージャで使用されるWiXテンプレート・ファイルをカスタマイズ 詳細は、「WiXドキュメント」を参照してください。

7.4.3 DMGパッケージ

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

図7-3 OS Xのデフォルト・インストーラの例

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

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

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

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

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

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

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

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

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ファイルを外部で準備し、7.3.3項「ドロップイン・リソースを使用したパッケージのカスタマイズ」で説明されている技術を使用してパッケージに追加します。

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

7.4.4 Linuxパッケージ

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

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

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

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

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

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

カスタマイズのヒント:

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

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

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

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

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

例7-8 <fx:deploy>タスクの例

<fx:deploy nativeBundles="all" width="600" height="400"
           outdir="${basedir}/dist" outfile="NativeLibDemo">
    <fx:application name="NativeLib Demo" mainClass="${javafx.main.class}"/>
 
    <fx:resources>
        <!-- include application jars -->
        <fx:fileset dir="dist" includes="*.jar"/>       
        <fx:fileset dir="dist" includes="lib/*.jar"/>

        <!-- native libs for self-contained application -->
        <!-- assume they are stored as
                 native/windows/x86/JNativeHook.dll
                 native/linux/x86_64/libJNativeHook.so
                 .... -->
        <!-- ensure libraries are included as top level elements
                to get them on java.library.path -->
        <fx:fileset dir="${basedir}/native/${os.name}/${os.arch}"
                    type="data">
            <include name="*.dll"/>
            <include name="*.jnilib"/>
            <include name="*.so"/>
        </fx:fileset>
    </fx:resources>
 
    <!-- Custom JVM setup for application -->
    <fx:platform>
        <fx:jvmarg value="-Xmx1024m"/>
        <fx:jvmarg value="-verbose:jni"/>
        <property name="my.property" value="something"/>
    </fx:platform>
 
    <!-- request user level installation -->
    <fx:preferences install="false"/>
</fx:deploy>