java畑

findComponet + Cashed Component

2006-12-09T20:37:00.000+09:00

はじめに

前回の記事では、findComponentをみてみました。
GUI上のコンポーネントのアクセスを、検索し使用するという方法がfindComponentでした。
ビルダーツールでコンポーネントで配置し、コンポーネントのプロパティに名前を設定します。検索する条件は名前のついたコンポーネントです。《意味のあるコンポーネントには名前がついている》というルールにしたがい、findComponentは対象となるコンポーネントをみつけだします。

図1 find foo

その際のGUI上のコンポーネントのアクセスをfindComponentで統一させしまうと、使用するたびに検索してしまうことです。

解決方法

単純な解決方法は、見つけ出したコンポーネントを連想配列(Map)に格納してしまうことです。
Mapには、キーに《コンポーネントの名前》、値にコンポーネントを格納します。
図２

下記はユーテリティメソッドの実装です。

toMapメソッド

    public static Map<String, Component> toMap(Component[] components) {
       Map<String, Component> map = new HashMap<String, Component>();
       for (Component component : components) {
           map.put(component.getName(), component);
       }
       return map;
   }

この実装ですと、同じ名前を設定しているコンポーネントが複数ある場合は、正しく動作しません。
つぎに、単純にキーを複数もてるMapを採用してみます。ひとつのキーで複数の値を扱うためにorg.apache.commons.collections.map.MultiValueMap(参考文献)を採用してみます。MultiValueMapは値が一つでもListに値を格納してから返すので若干使いづらいかもしれません。

MultiValueMap採用版

//import org.apache.commons.collections.map.MultiValueMap;
   public static <T extends Component> Map<String, List<T>> toMap(
           Component[] components) {
       Map<String, List<T>> map = new HashMap<String, List<T>>();
       MultiValueMap multiValueMap = MultiValueMap.decorate(map);
       for (Component component : components) {
           multiValueMap.put(component.getName(), component);
       }
       return multiValueMap;
   }

参考文献(書籍、ハイパーリンク)

MultiValueMapはjakarta commonsのコレクション操作のためのライブラリに含まれています。

findComponent

2006-10-07T02:08:00.000+09:00

はじめに

好みの問題かもしれませんが、ドラッグアンドドロップでGUIを作成するツールで生成できるソースコードにイベントを受信して動作するxxxListenerを記述したくありません。もしくは、生成されたソースコードの中に、外部のオブジェクトにバインドさせるコードを記述したくありません。ひょっとして、筆者がGUIビルダー(参考文献)が期待している習熟度に達していないのかもしれません。

何故そう思うのか、理由を考えてみました。まず、第一にGUIビルダーで部品を配置しながら、振る舞いの記述を意識するのは結構辛いということ。もうひとつの理由は、UIオブジェクトに他のオブジェクトへの関心を埋め込みたくないからだということでした。ようするにマウスの操作だけでうまくできたソースコードに直接手でロジックを記述したくなく、UIオブジェクトにどうやって他のオブジェクトの参照を渡すか、もしくは他のオブジェクトの参照を取得するかをUIオブジェクトを作成中に考えたくないという訳です。

UIオブジェクトの再利用性を高めるためには、オブジェクト同士の関心の矢印を一方向に保つのがよいと思います。

図1 関心の方向

最初の解決方法

では関心の方向を一方向で保つためには、どういった方法があるでしょうか。
デザインされたUIには手でロジックを記述しないという方法をとることに注力してみます。
Eclipse プラグインのVisual Editorでは配置したオブジェクトはgetterメソッドが自動生成されます。
例えば下記のようにです。

生成されたgetterメソッド

    private JButton getJButton() {
       if (jButton == null) {
           jButton = new JButton();
       }
       return jButton;
   }

デフォルトではアクセス修飾子がprivateなので外部からアクセスできませんので、これをpublicにすると定義したUIクラスの外部から配置したオブジェクトにアクセスできるようになります。

この方法の欠点は部品(bean)を作成して他の部品の上に配置していくような作りにした場合、目的となるオブジェクトにアクセスするためのコード記述が長くなります(例 a.getB().getC().getD();)。

図２ beanのうえにbeanを配置

別の解決方法

ところで、javaでは、GUIオブジェクトはjava.awt.Componentから成り立っています。Componentはjava.awt.Container上に配置されることによって利用されます。
Container上に配置されたComponentにアクセスする方法は、findComponentAt、getComponent、getComponents等のメソッドを使用してアクセスすることが可能です。Containerは配置された全てのComponentにComponent[] getComponents()を使用してアクセスできます。このデフォルトで用意された機能を利用して目的のオブジェクトにアクセスする方法を考えてみましょう。Componentはnameをフィールドとしてもちますが、このプロパティをオブジェクトを特定するために使用できそうです。

アクセスしたいUIオブジェクト(Component)には、名前を付けるというのはルール（契約）とします。

下記のようなユーティリティメソッドを用意します。

ユーティリティメソッド:getAllComponentsIfNamePrepared

    public static Component[] getAllComponentsIfNamePrepared(Container container) {
       List<Component> arrayList = new ArrayList<Component>();

       Component[] components = container.getComponents();
       for (Component component : components) {
 
           if (component instanceof Container) {
               List<Component> list = Arrays
                       .asList(getAllComponentsIfNamePrepared((Container) component));

               if (!list.isEmpty()) {
                   arrayList.addAll(list);
               }

           }

           if (component.getName() != null && 0 < component.getName().length())
               arrayList.add(component);
       }

       Object[] objects = arrayList.toArray();
       int size = objects.length;
       Component[] returnComponents = new Component[size];
       System.arraycopy(objects, 0, returnComponents, 0, size);
       return returnComponents;
   }

このユーティリティメソッドは、Containerに含まれるをComponentを調べ、名前をもつComponentを配列にして返します。含まれるComponentがContainerであった場合には再帰的にgetAllComponentsIfNamePreparedを呼び出します。

次に特定の名前をもつComponentを探すユーティリティメソッドです。

ユーティリティメソッド:findComponent


public static Component findComponent(String name, Container container) {
       Component[] components = getAllComponentsIfNamePrepared(container);
       for (Component component : components) {
           if (component.getName() != null
                   && component.getName().equals(name)) {
               return component;
           }
       }

       return null;
   }

指定された名前と合致したComponentを返します。

実際に使用してみます。UI部分をNetBeansで作成してみます。

図３ NetBeans画面 nameの設定
作成した画面のJButton,JTextFieldに名前を設定します。

UI部分を呼び出すコードです。このサンプルコードは、ボタンをクリックしたら所定のテキストフィールドをの文字を書き換えるというものです。

テストクラス:Main


import java.awt.Component;
import java.awt.Container;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

import javax.swing.JButton;
import javax.swing.JFrame;
import javax.swing.JTextField;

public class Main {

   public static void main(String[] args) {
       java.awt.EventQueue.invokeLater(new Runnable() {
           public void run() {
               final JFrame frame = new NewJFrame();
               // JButtonを探しだす
               JButton button = (JButton) findComponent("my.button", frame);
               button.addActionListener(new ActionListener() {

                   public void actionPerformed(ActionEvent e) {
                       // JTextFieldを探しだす
                       JTextField textField = (JTextField)findComponent("my.text7", frame);
                       textField.setText("success");
                   }

               });
               frame.setVisible(true);
           }
       });
   }

   public static Component[] getAllComponentsIfNamePrepared(Container container) {
       List<Component> arrayList = new ArrayList<Component>();

       Component[] components = container.getComponents();
       for (Component component : components) {
           if (component instanceof Container) {
               List<Component> list = Arrays
                       .asList(getAllComponentsIfNamePrepared((Container) component));
               if (!list.isEmpty()) {
                   arrayList.addAll(list);
               }
           }
           if (component.getName() != null && 0 < component.getName().length())
               arrayList.add(component);
       }
       Object[] objects = arrayList.toArray();
       int size = objects.length;
       Component[] returnComponents = new Component[size];
       System.arraycopy(objects, 0, returnComponents, 0, size);
       return returnComponents;
   }

   public static Component findComponent(String name, Container container) {
       Component[] components = getAllComponentsIfNamePrepared(container);
       for (Component component : components) {
           if (component.getName() != null && component.getName().equals(name)) {
               return component;
           }
       }
       return null;
   }
}

動画１:一連の実行までの流れ、NetBeansでデザインし、コーディングはeclipseで行っている

まとめ

別の解決方法でしめした方法は、工夫次第ではいろいろな発展のさせ方があります。Componentの名前に名前規則をもたせることによって、正規表現等を利用して、取得したオブジェクトを選別することができます。またComponentの型によって選別する方法とあわせて使用すると手軽にComponentを絞り込むことができます。この方法は既にやられているオープンソースプロジェクトもあります(参考文献)。こういった方法は特に、ライブラリ、フレームワークを使用せずとも実装できます。

他のアイデアとしては、XPathのようなパス定義してみる。例えば、Containerから配置されたComponentを取得する場合container[@name='mycomponent']のような記述を利用する。Jakarta projectにあるJXPath(参考文献)はXPathの記述をXMLだけでなく、beanの取得に適用しています。

参考文献(書籍、ハイパーリンク)

elipseのVEプラグインはコンパクトなGUIビルダーではないでしょうか。
NetBeans標準搭載されているLayoutManagerは今後のjdkに標準になるようです。swingのGUIビルダーとして使いやすいです。
jakarta project JXPathXPath記述でXML以外の他のモデル(Java beans)にアクセスする方法を提供しています。
Programmer's Friendjavaプログラマのための使いやすいクラスを提供しています。org.pf.swing.SwintgUtilのfindComponentは今回の記事と同じ発想です。
quicklunch goodies使用されているサンプルコードの一部を入手できます。subversionで管理されています。

ResourceInjector

2006-09-16T02:32:00.000+09:00

Fuse(参考文献)というオープンソースプロジェクトで開発されているResourceInjectorを使用して、JDK1.5で導入されたアノテーションと、UIコンポーネントでの設定情報の外部にだす方法をみていきたいと思います。

アノテーションについて

JDK1.5以降とそれ以前のjavaのバージョンとの間には深い溝があるようにみえます。
JDK1.5から導入されたアノテーションの機能は、それ以前のJavaの開発と大きくスタイルが変わっていることをあわらしています。現在のたいていのjava開発はアプリケーションサーバ、フレームワークありきで進められますが、アノテーションはそれらの外部のツールによって読み取られ処理が行われます。

JDK1.5から導入されたジェネリックは正直面食らいました。というのも、javaソースをみた場合に、C++で書かれたコードなのか？と一瞬区別がつかなかったからです。JDK1.5の導入は開発者に学習を強制するように思えます。単に、APIが増えたというレベルではなく、言語仕様、文法レベルでの変更があるからです。それ以前と同じコーディングスタイルで、開発は可能ですが、苦痛を感じます。

FuseのResourceInjectorとは

FuseはGUIプログラミングのための依存性の注入を使用した軽量なラブラリです。
javaのGUIプログラミングでは、一般的に、コンポーネントの内部で各種リソースをロードするコードを記述していましたが、ResourceInjectorを使用することによって、その記述を省略することができます。

何故、ResourceInjector？かといいますと、SwingLabsのデモプロジェクトAerith(参考文献)をハックしていて、ResourceInjectorが使用されているのに気がついたことからです。Aerithは今的なデモプロジェクトです。Web2.0時代にマッチしています。Flickr API(参考文献)を利用してWebサービスからのデータの取得を行い、フェードイン、フェードアウトなどのエフェクトを使用していたり、リッチなクライアントを表現しています。内部ではjogl(参考文献)を使用していたりとこれからくるJavaクライアントの方向性をしめしていると思います。

ResourceInjectorとアノテーションを組み合わせたコード

具体的にResourceInjectorとアノテーションを組み合わせたコードをみていきます。
ここでは、UIコンポーネント使用せずに単純なデータクラスを使用します。

プロパティファイルに定義した値をResourceInjectorを使用して適用します。

data.properties


Data.string1=just test
Data.color1=#777777
Data.font1=Default-BOLD-14

フィールド変数に@InjectedResourceというアノテーションをつけます。

Data.java


package sample_using_fuse;

import java.awt.Color;
import java.awt.Font;

import org.apache.commons.lang.builder.ReflectionToStringBuilder;
import org.jdesktop.fuse.InjectedResource;

public class Data {
@InjectedResource
Color color1;
@InjectedResource
Font font1;
@InjectedResource
String string1;

public String toString() {
 return ReflectionToStringBuilder.toString(this);
}
}

テスト実行クラスです。
実行するとプロパティファイルに定義した内容がDataクラスに適用されていることがわかります。ResourceIndectorにSwingModlueを渡すことによって、Color、Fontが変換されています。

TestMainForData.java


package sample_using_fuse;

import org.jdesktop.fuse.ResourceInjector;
import org.jdesktop.fuse.swing.SwingModule;

public abstract class TestMainForData {

public static void main(String[] args) {
 
 Data data = new Data();
 ResourceInjector.addModule(new SwingModule());
        ResourceInjector.get().load(Data.class,
                "/sample_using_fuse/data.properties");
        ResourceInjector.get().inject(data);
       
        System.out.println(data);
}

}

まとめ

実際にはResourceInjectorをUIコンポーネントに使用する際には、工夫が必要となるでしょう。JDK1.5から導入されたアノテーションをクライアントサイドに適用するという試みは、もっとなされてよいでしょう。

参考文献(書籍、ハイパーリンク)

SwingLabsプロジェクトホームページ
aerithjava.netに開設されているプロジェクトページ
Fusejava.netに開設されているプロジェクトページ
APIFuseのResourceInjectorのjavadocです。
ResouceInjectorの紹介記事簡潔に説明されています。
flickr海外で運営されている写真アップロードサイト、yahoo.comのアカウントが必要です。
Java2 Standard Edition 5.0 Tiger書籍、簡潔にJDK1.5から導入された機能等をまとめられています。
quicklunch goodies使用されているサンプルコードを入手できます。subversionで管理されています。