Rich Internet Application のロード動作のカスタマイズ
RIA のロード動作
Java Rich Internet Application (RIA) は、インターネット経由でダウンロードされてエンドユーザーに表示されます。ダウンロードの速度は、RIA の JAR ファイルのサイズ、外部のあらゆる依存関係、インターネット接続の速度など、さまざまな条件によって変わる可能性があります。
RIA がダウンロードされている間はデフォルトで、RIA ソフトウェア (Java Plug-in および Java Web Start ソフトウェア) によって標準の進捗インジケータ (回転する Java ロゴや進捗バーなど) が表示されます。エンドユーザーは、大きなサイズのダウンロードに遭遇すると我慢できなくなる可能性があります。Java SE 6 update 18 と Java SE 6 update 21 リリースでの RIA ソフトウェアテクノロジの改善点を活用すれば、創造的で魅力的な意味のある RIA ロード動作を提供することで、エンドユーザーの注意を持続させることができます。RIA のロード動作をカスタマイズするには、次に説明するようにいくつかの方法があります。
- スプラッシュ画面を提供する
- カスタマイズされたロード進捗インジケータを作成する
- RIA ダウンロードの進捗と RIA 固有のデータのロードの進捗を反映させるために 1 つの進捗インジケータを活用する
また、クライアントマシン上の古いバージョンの Java Runtime Environment (JRE) ソフトウェアに対応できるように、上の複数のオプションを組み合わせることもできます。
注:特定のカスタマイズオプションは、アプレットまたは Java Web Start アプリケーションに固有のものです。このトピックではそのような場合を明確にします。
RIA のロード処理
このセクションでは RIA のロード処理について説明します。
RIA ソフトウェアは、RIA をダウンロード、検証、および実行するための一連の手順を開始します。RIA ロード処理は大まかに次の各段階に分けることができます。これらの段階の間、RIA ソフトウェアはさまざまなレベルの進捗関連フィードバックを提供します。
- 初期化 – RIA ソフトウェアはこの段階で、RIA の起動に必要なリソースの評価を実行します。RIA のダウンロード、検証、および実行に必要となる作業量は、この時点では不明です。
- ロードと検証 – RIA ソフトウェアは、必要なリソース (JAR ファイル) をインターネット経由で必要に応じてダウンロードします。RIA が以前にキャッシュされていた場合、RIA ソフトウェアはローカルキャッシュからリソースをロードします。RIA ソフトウェアはリソースを検証します。リソースのロード処理および検証処理の間、決定性フィードバックが RIA ソフトウェアによって伝達されます。決定性フィードバックは、RIA ソフトウェアによって完了率が計算されて伝達されることを意味します。
- RIA の実行 – RIA ソフトウェアはこの段階で RIA を実行します。RIA は完全に機能する状態になりました。RIA はこの時点で、アプリケーション固有のデータをロードできます。
カスタマイズのオプション
スプラッシュ画面の追加
RIA のロード動作をカスタマイズするもっとも単純な方法は、スプラッシュ画面を提供することです。スプラッシュ画面に表示すべきイメージを指定します。RIA 自体への変更は一切不要です。RIA ソフトウェアは、RIA のロード中はスプラッシュ画面を表示し、RIA のリソースのダウンロードと検証が完了するとその画面を隠します。詳細は、次のトピックを参照してください。
- Java チュートリアルのアプレットのスプラッシュ画面の作成に関するトピック (例の確認)
- Java Web Start の FAQ と JNLP ファイルの構文 (Java Web Start アプリケーションのスプラッシュ画面の追加に関する情報)
カスタマイズされたロード進捗インジケータの実装
デフォルトのロード進捗インジケータを、RIA のロード状況に関する定期的なフィードバックを提供するカスタム実装で置き換えることができます。矩形のボックスや Swing JProgressBar コンポーネントの使用にこだわらないでください。RIA や Web サイトにとって意味のある、カスタマイズされたロード進捗インジケータを開発できます。ロード進捗インジケータでは、RIA のバックグラウンドでのロード中にエンドユーザーの興味や注意を持続させるため、視覚的な方法や視覚的でない方法を使用できます。
詳細な手順と例については、Java チュートリアルの「Customizing the Loading Experience」トピックを参照してください。ロード進捗インジケータのスクリーンショットをいくつか次に示します。
Java Web Start アプリケーションのデフォルトのロード進捗インジケータ
Java Web Start アプリケーションのカスタマイズされたロード進捗インジケータ
Reversi JavaFX アプレットのカスタマイズされたロード進捗インジケータ (ロードが進むにつれて黒の石が白に変わる)
次の各機能により、JNLP テクノロジを使って配備された RIA で、ロード進捗インジケータのさまざまなカスタマイズが可能となります。
- カスタマイズされたロード進捗インジケータは、決定性または非決定性のフィードバックを提供できます。
- カスタマイズされたロード進捗インジケータは、進捗を伝えるための視覚的な手掛かりや視覚的でない手掛かりを提供できます。
- アプレットと Java Web Start アプリケーションをサポートする単一のロード進捗インジケータを開発できます。
- 複数のロード進捗インジケータを Java Network Launch Protocol (JNLP) 拡張として定義できます。RIA のメイン JNLP ファイルに指定されたロード進捗インジケータが存在する場合、そのインジケータが優先されます。非決定性の動作を避けるために、どの拡張を表示すべきかを指定するようにしてください。
- カスタマイズされたロード進捗インジケータは、アプリケーション固有のデータをロードする際の進捗を表示するためにも活用できます。たとえば、アプリケーションの初期データをロードする Web サービスが RIA によって呼び出される場合、RIA ダウンロードのステータスを示すために 0 - 75% の進捗範囲を使用し、アプリケーションデータを取得する Web サービス呼び出しの進捗を示すために 76% - 100% の範囲を使用できます。
- アプレットのロード進捗インジケータは次の処理を実行できます。
- java.applet.AppletStub クラスのインスタンスへの参照を受け取れます。このため、ロード進捗インジケータのコードから java.applet.AppletContext オブジェクトにアクセスして、アプレットのパラメータを取得できます。
- アプレットの親 Web ページ内の JavaScript コードを呼び出せます。ウィンドウへの参照は、次に示す方法で取得できます。
JSObject window = JSObject.getWindow(null); window.call("someJavaScriptFunction", args);
次のいくつかの段落では、ロード進捗インジケータの実装に関する技術的な詳細について説明します。
javax.jnlp.DownloadServiceListener インタフェース
ロード進捗インジケータクラスは javax.jnlp.DownloadServiceListener インタフェースを実装すべきです。
ロード進捗インジケータクラスのコンストラクタ
ロード進捗インジケータクラス内で次のコンストラクタを指定します。RIA ソフトウェアは、クライアントマシン上の JRE ソフトウェアの機能に応じて適切なコンストラクタを呼び出します。すべてのリソースが最新であれば、RIA ソフトウェアはロード進捗インジケータクラスをインスタンス化しない場合もあります。
- パラメータを 1 つも持たないコンストラクタ – Java Web Start アプリケーションのロード進捗インジケータクラスではこのコンストラクタを指定すべきです。アプレットのロード進捗インジケータクラス内でもこのコンストラクタを指定できます。RIA ソフトウェアがこのコンストラクタを呼び出すと、
javax.swing.JFrameオブジェクトなどのトップレベルウィンドウ内に、ロード進捗インジケータの UI が表示されます。 - 1 つのパラメータを持つコンストラクタ – このコンストラクタは
java.lang.Object型のパラメータを 1 つ持ちます。このObject引数はjava.awt.Containerクラスのインスタンスに型キャストできます。このコンストラクタはアプレットのロード進捗インジケータに関連しています。RIA ソフトウェア (この場合は Java Plug-in ソフトウェア) がこのコンストラクタを呼び出すと、ロード進捗インジケータの UI がアプレットのコンテナに表示されます。 - 2 つのパラメータを持つコンストラクタ – このコンストラクタは
java.lang.Object型のパラメータを 2 つ持ちます。最初のObject引数はjava.awt.Containerクラスのインスタンスに型キャストできます。2 番目のObject引数はjava.applet.AppletStubクラスのインスタンスに型キャストできます。RIA ソフトウェア (この場合は Java Plug-in ソフトウェア) がこのコンストラクタを呼び出すと、ロード進捗インジケータの UI がアプレットのコンテナに表示されます。ロード進捗インジケータは、java.applet.AppletContextオブジェクトにアクセスして自身をさらにカスタマイズできます。このコンストラクタはアプレットのロード進捗インジケータに関連しています。2 つのパラメータを持つコンストラクタを指定するときは、古いバージョンのクライアント JRE ソフトウェアに対応できるように、単一パラメータのコンストラクタも指定することをお勧めします。2 つのパラメータを持つコンストラクタが呼び出されるのは、クライアント JRE ソフトウェアのバージョンが Java SE 6 update 21 以上の場合だけです。
javax.jnlp.DownloadServiceListener インタフェースのメソッド
ロード進捗インジケータクラスは、インタフェースの次の各メソッドを実装することで、最新の進捗情報の受信と伝達を行えるようにすべきです。
progress(URL url, String version, long readSoFar, long total, int overallPercent)upgradingArchive(java.net.URL url, java.lang.String version, int patchPercent, int overallPercent)validating(java.net.URL url, java.lang.String version, long entry, long total, int overallPercent)– ロード進捗インジケータクラスがインスタンス化される際には常に、値 100 がoverallPercentに指定されてこのメソッドが呼び出されます。
これらのメソッドで受け取った overallPercent の値に基づいて、ロード進捗インジケータ内の進捗情報を更新します。
JNLP ファイル内でのカスタム進捗インジケータの指定
ロード進捗インジケータを指定するには、RIA の Java Network Launch Protocol (JNLP) ファイル内に次の情報を含めます。
- ロード進捗インジケータクラスがどの JAR ファイルに含まれているかを示す
download="progress"属性 - ロード進捗インジケータクラスの完全修飾名を含む
progress-class属性。この属性は、RIA やロード進捗インジケータの配備方法に応じて<applet-desc>、<application-desc>、<component-desc>のいずれかの一部として定義できます。
アプレットのサンプル JNLP ファイルを次に示します。
<jnlp spec="1.0+" codebase="" href="">
...
<resources>
...
<jar href="MyApplet.jar" main="true" />
<jar href="CustomProgressIndicator.jar" download="progress" />
</resources>
<applet-desc
name="MyFavoriteApplet"
main-class="myAppletPackage.MyFavoriteApplet"
progress-class="myCustomProgressPackage.MyCustomProgressIndicator"
width="600"
height="200">
</applet-desc>
...
</jnlp>
RIA ソフトウェアが進捗を伝える方法
RIA ソフトウェアは次のようにして進捗情報を伝えます。
- RIA ソフトウェアは必要に応じてロード進捗インジケータをインスタンス化します。すべてのリソースがキャッシュ済みで最新の状態になっている場合、ロード進捗インジケータがまったくインスタンス化されないことがあります。
- RIA ソフトウェアは
progress、upgradingArchive、validatingメソッドを何回か呼び出しますが、その際、overallPercentには前回よりも大きな値が指定されます。 - リソースがすでにキャッシュ済みかつ検証済みの場合、RIA ソフトウェアは、単純にコンストラクタを呼び出したあとで 100% 完了メッセージを送信することがあります。
- RIA ソフトウェアは常に 100% 完了メッセージをロード進捗インジケータに送信します。
ベストプラクティスおよびヒント
- RIA のロード動作をカスタマイズするアプローチを決定する際には、古いバージョンのクライアント JRE ソフトウェアの機能を考慮してください。次に説明するように、クライアント JRE ソフトウェアの機能やその他の条件に応じて、複雑さが少しずつ異なる一連の実装を提供できます。
- クライアント JRE ソフトウェアのバージョンが Java SE 6 update 10 以上である場合にアプレット用に表示可能なスプラッシュ画面を指定します。
- クライアント JRE ソフトウェアのバージョンが Java SE 6 update 18 以上である場合に表示可能な、カスタマイズされたロード進捗インジケータを指定します。
- RIA の一部または全部がキャッシュされている場合はスプラッシュ画面やロード画面がまったく表示されない可能性がある、という事実を考慮してください。
- カスタマイズされたロード進捗インジケータを開発する際には、次の各項目を考慮してください。
- ロード進捗インジケータの JAR ファイルのサイズを小さく保ちます。RIA リソースが並行してダウンロードされます。ロード進捗インジケータの JAR ファイルのサイズが大きいと、そのダウンロードがほかのリソースとほぼ同じ時期に終了する可能性があります。この場合、ロード進捗インジケータが非常に短い時間しか表示されなかったり、まったく表示されなかったりする可能性があります。
- ロード進捗インジケータで必要になるリソースの量を制限します。ImageIO やサービス検索は、ほかのリソースがダウンロードされる原因となる可能性があるため、使用しないでください。
- ロード進捗インジケータは、Java Web Start アプリケーション自体と同じトップレベルウィンドウを使用できます。この場合、アプリケーションのコンストラクタ呼び出し時に使用されるリソースの量を制限してください。代わりにアプリケーションの
mainメソッド内でリソース検索を指定してください。 - ロード進捗インジケータをアプレットの UI に組み込むことができます。この場合、
javax.swing.JPanelオブジェクトなどのトップレベルコンテナを作成し、それを前述のsurfaceContainerオブジェクトに追加します。アプレットのリソースのダウンロードが完了したら、トップレベルコンテナをsurfaceContainerオブジェクトから削除し、それをアプレット自体に追加します。 - 署名付き RIA では署名付きのロード進捗インジケータ実装が最適である可能性があります。この場合、早期にセキュリティー警告が表示されて受け入れられると、そのあとは追加の割り込みなしで進捗を更新できます。
リソース
- 詳細な手順と例については、Java チュートリアルの「Customizing the Loading Experience」トピック。
- クライアント JRE の機能 - クイックリファレンス