Eclipse 4 (e4) Tutorial: Part 2 Application Model and Views #Java

アプリケーションモデルからビュー実装へ

このチュートリアルシリーズは、RCP 2.0として知られている Eclipse4　アプリケーションプラットフォームのコア概念を紹介します。e4で革新されたことの一つは、アプリケーションモデルとビューなどのパーツ実装を分離したことです。このチュートリアルの最初のパートでは、アプリケーションモデルの概要に加えて、エディタもしくはAPIを使って、異なる方法でモデルを変更する方法を紹介します。アプリケーションモデルを使って、個々のビューを実装することなしにアプリケーションの基本設計を定義し、テストできます。チュートリアルの２番目のパートでは、欠けている部分であるビューの実装方法を説明します。これまでは、アプリケーションモデルの中のその部分に対して、プレースホルダのみを生成してきました。

ビューなしのアプリケーションモデル？

ぱっと見て、なぜ、Eclipse4は、アプリケーションモデルとUIコンポーネント実装を明確に分離することを促しているのかについて、戸惑うかもしれません。これは、ある部分が他の部分なしには意味をなさない場合、特にそう感じるでしょう。Eclipse 3.xやその他のフレームワークでは、ビューなどのUIコンポーネント実装は、所定のインタフェースを実装していく必要があります。このアプローチは、ビューを生成するために開発者が実装しなければならないメソッドを正確に定義しています。しかし、このアプローチは、UIコンポーネント実装の再利用性を制限してしまいます。

この問題についてのよく知られた例として、Eclipse 3.xにおけるビューとエディタ間の相違を上げることができます。それらを実装するには、異なるインタフェースが必要となります。もし、あなたがビューをエディタとして再利用したい場合は、リファクタリングしなければなりません。逆の場合も同様です。もう一つの例は、ダイアログの中でビューを再利用しようとする場合です。最後の例は、RCPアプリケーションを、他のコンテキスト、例えば、モバイルデバイス（RAP mobile / Tabris参照）で動かす場合、ワークベンチのデザインは、小さな画面に合うように変更される必要があります。そのため、UIコンポーネントをモジュール化し独立して実装することが、Eclipse4の１つのゴールとなります。エディターやビューのようなフレームワーククラスに結び付かない、小さく、独立したパーツからなる UI構成物は様々なコンテキストで再利用されることが可能です。

アプリケーションモデルなしのビュー？

アプリケーションモデルとビューの実装のモジュール性を示すために、このチュートリアルの最初のパートでは、実装なしにアプリケーションモデルを生成することから始めました。e4ツールを使うことで、空のアプリケーションモデルを視覚化することさえ可能となります。アプリケーションモデルを実装で満たす前に、その反対、言うなればアプリケーションモデルなしに SWTを使ったビューを実装することを示そうと思います。Eclipse4のモジュールベースのUI開発の例を示すために、正確なワークベンチのデザインを知る前に、アプリケーションのパーツを開発してみましょう。

Eclipse4では、ビューは与えられたインタフェースを実装するといったようなことは不要です。そのかわり、ビューは、ワークベンチが提供する必要があるパラメータを定義します。簡単な例を１つあげると、SWTビューは、親コンポジットを必要とします。その上にSWTビューが配置されます。アノテーション“@Inject”は、Eclipse4フレームワークによって、「注入」されるべきビューのパラメータを決めるために後で使われます。依存性注入のさらなる詳細は、この連載の将来のチュートリアルで触れます。

次のコード例は、SWTの最も簡単な "Hello World!” です。　

public class ExampleView {
   @Inject
   public ExampleView(Composite parent) {
      Label label = new Label(parent, SWT.NONE);
      label.setText("Hello World!");
   }
}

アプリケーションモデルを使うと、このビューは、アプリケーションの中でワークベンチの一部として後で表示できます。ビューのようなものの、高い再利用性やテスト容易性を示すために、最初は、ワークベンチなしにビューを使用してみましょう。次のコード例では、SWTを使うだけで、“HelloWorld”を開く方法をお見せします。特筆すべきことは、プレーンなJavaプログラムだということです。これを実行するのに必要なものは、関連するSWTライブラリだけです。このことから、そのビューはどこででも再利用できます。例えば、ダイアログ、ウィザード、Eclipse ワークベンチの外ででも。

public static void main(String[] args) {
   Display display = new Display();
   Shell shell = new Shell(display);
   shell.setLayout(new FillLayout());
   new ExampleView(shell);
   shell.open();
   while( !shell.isDisposed() ) {
      if( ! display.readAndDispatch() ) {
         display.sleep();
      }
   }
}

このスクリーンショットは、プレーンなJavaプログラムから起動された Hello Worldアプリケーションが走っていることを表しています。

再結合

これまでのところ、アプリケーションモデルとビュ実装をお互いに分離して、生成およびテストしてきました。いよいよ、両方のパーツを一緒にする時がやって来ました。これをやるには、アプリケーションモデルの中で、ワークベンチ内のビューを表す"Part"要素を加えます。このパーツは、ビュー実装とリンクされます。e4ツールで生成されるe4テンプレートアプリケーション(Eclipse4 チュートリアルパート１のインストールの章参照)を使うと、例えば、パーツは、パーツスタック内に生成されます。

このスクリーンショットを見るとわかるように、パーツは、ビューやエディタの置き場所として、アプリケーションモデルに追加されます。

パーツをビュー実装にリンクするために、そのビューのクラスをクラスURIの形式で指定する必要があります。アプリケーションを開始するとき、Eclipse4は、ワークベンチ内にパーツを生成し、リンクされたビューは初期化されます。ビューによって必要とされるパラメータは、現在のコンテキストから取得され、ビューに注入されます。例えば、Eclipse4はパーツのコンテント領域をビューに対するコンポジットの親として使います。それゆえ、パーツの中にビューを置くという言い方が適切だと感じていただけると思います。

図：パーツはクラスURIを用いてビュー実装にリンクされる

他の分離について（ハンドラ―を追加すること）

次のステップのために、我々のアプリケーションにいくつかのふるまいを加えたいと思います。そのため、ハンドラを実装します。それは、アプリケーションのツールバー上のボタンによってトリガされます。UIコンポーネントの実装と同様に、Eclipse4　は、フレームワークとハンドラの実装をきれいに分離することができるようになっています。これによって、再利用性とテスト容易性を向上させています。具体例を示すために、ハンドラをアプリケーションモデルへの統合とは独立して、実装・テストし、前の章と同じワークフローで進めてみます。そのあとのステップで、統合します。

Eclipse4でUIコンポーネントが動作する方法に沿って、ハンドラ―も所定のインタフェースを実装する必要はありません。かわりに、必要なパラメタを定義します。これは、必要最小限にパラメタ数を減らし、ハンドラのテストも簡単にします。次のコード例は、“Hello World!”ダイアログを開くといった、とても基本的なハンドラの実装をお見せします。ハンドラがダイアログを開くために必要なパラメータは、シェル、たった一つです。“@Execute”アノテーションを使うことで、ハンドラはEclipse4フレームワークに、そのメソッドが実行対象であることを知らせます。加えて、このアノテーションは、“@Inject”と同様の効果を持っています。どういった意味かと言いますと、execute()メソッドに必要なパラメータは、シェルの場合と同様にフレームワークによって注入されます。ここで例としているハンドラは、状態を持っていないため、execute()メソッドstaticメソッドとしています。

public class MyHandler {
 
   @Execute
   public static void execute(Shell shell){
      MessageDialog.openInformation(shell, "", "Hello World!");
   }
 
}

Eclipse4のハンドラは、本当に使うパラメータだけを要求すればよいので、テストや、再利用、そして連結することがとても簡単になります。次のコード例は、実装されたハンドラをテストする簡単なJavaプログラムを示します。これらのテストは、JUnitの中でも記述できます。

public static void main(String[] args) {
   Display display = new Display();
   Shell shell = new Shell(display);
   shell.open();
   MyHandler.execute(shell);
   while( !shell.isDisposed() ) {
      if( ! display.readAndDispatch() ) {
         display.sleep();
      }
   }
}

ツールバー上のボタンとハンドラを統合するには、アプリケーションモデルの他の要素が必要です。ハンドラを統合する最も簡単な方法は、“Direct ToolItem”を使用することです。（図参照）パーツと同様に、ハンドラの実装は、クラスURIを設定することによってモデルと結合されます。ツールアイテムを例題アプリケーションで表示するために、ラベルやアイコンを設定することも必要です。

図：アプリケーションのツールバー上で"Direct ToolItem"を生成する

“Direct ToolItem”を使うことは、ハンドラとツールバー上のアイテムを統合をもっとも速く行う手段です。しかし、再利用性を最大限に高めるためには、コマンドを使用することをお勧めします。これを行うには、単純にアプリケーションモデルのルートレベルにハンドラとコマンドを作成するだけです。ハンドラは実装ではなく、コマンドに結び付けられます。（図参照）直接実装に結び付ける“Direct ToolItem”を使用する代わりに、“Handled ToolItem” は、コマンドに結び付けられます。このような方法で、コマンドは、アプリケーション内で再利用されます。その例として、キーバインディングはハンドラの実行をトリガするために用いられます。

図：ハンドラはコマンドと同様に実装にも結びつけられる

まとめ

Eclipse4におけるUI実装では、必要なパラメータを定義します。このアプローチは、最小のインタフェースと実装によって、テストと再利用を大変容易にします。このチュートリアルは、アプリケーションモデル上の対応する要素なしに、ビューやハンドラを生成してテストする方法を示しました。次回は、アプリケーションモデルの拡張とモジュール化、つまり、複数のプラグインからビューやハンドラを提供する方法について述べていきます。