Javaでxfyコンポーネントを開発するときの環境設定

Javaでxfyコンポーネントを作成するときは、Java 2 Platform Standard Edition (J2SE) 5.0の開発環境J2SE Development Kit (JDK) 5.0 以上が必要です。また、統合開発環境として、Eclipse 3.1.0以上を使用することをおすすめします。この文書では、JDK 5.0 Update 6とEclipse 3.1.0を使用して説明します。

なお、このチュートリアルでは、xfyユーザーエージェントとして、xfy Basic Editionに含まれるxfy Clientを使用します。xfy Clientは、C:\Program Files\Justsystems\xfy Basic Editionフォルダにインストールされているものとします。

この文書は、以下に挙げた項目に対してある程度の知識がある方を読者に想定しています。

• Javaプログラミング
• Eclipseの使用方法

xfyコンポーネントを作成するのに必要なのは、次のファイルです。

Javaのソースコード

xfyコンポーネントのプログラムコードを記述した、Javaソースファイルです。この文書では、Javaによるxfyコンポーネントのプログラムコード作成方法は説明しません。別途用意されているxfyコンポーネントの開発に関する文書を参照してください。

プラグインマニフェストファイル

xfyコンポーネントの構成情報を記述するXMLファイルです。記述方法は、「プラグインマニフェストファイルリファレンス」をご覧ください。なお、xfy Developer's Toolkitでは、プラグインマニフェストファイルを作成・編集するために、Plug-in Manifestコンポーネントが提供されています。

Antビルドスクリプトファイル

作成したxfyコンポーネントのプログラムコードをコンパイルしたり、コンパイルされたclassファイルからJARファイルを作成したりするための手順や設定が記述されたファイルです。Javaで作成したxfyコンポーネントを実行するには、Antビルドスクリプトを実行して、xfyコンポーネントのJARファイルを作成する必要があります。また、Javaのプログラムコードを変更したときにも、Antビルドスクリプトを実行してxfyコンポーネントのJARファイルを更新する必要があります。
Antビルドスクリプトを作成するときは、下記のAntビルドスクリプトを元に、環境に合わせて修正してください。

<?xml version="1.0" standalone="yes" ?>
<!--
    Sampleコンポーネント用ビルドファイル
    -->
<project name="Sample" default="all" basedir=".">

    <!-- コンポーネント名 -->
    <property name="component.name"   value="Sample" />
    <!-- ベンダ名 -->
    <property name="component.vendor" value="com.example" />
    <!-- 使用JDKのバージョン -->
    <property name="component.jdk"    value="1.5" />
    <!-- xfy の場所 -->
    <property name="xfy.home"         value="C:/Program Files/Justsystems/xfy Basic Edition" />

    <target name="all" description="bin以下にすでにクラスファイルがあると仮定してjarを作成します">
        <antcall target="copyResource" />
        <antcall target="compile" />
        <antcall target="jar" />
    </target>

    <target name="copyResource" description="src 以下の java ファイル以外を bin 以下に配置します">
        <copy todir="bin">
            <fileset dir="src" excludes="**/*.java"/>
        </copy>
    </target>

    <target name="compile" description="src 以下の java ファイルを bin 以下に配置します">
        <javac
            srcdir="src"
            destdir="bin"
            debug="on"
            debuglevel="lines,vars,source"
            target="${component.jdk}"
            source="${component.jdk}">
            <classpath>
                <fileset dir="${xfy.home}/bin">
                    <include name="xfyCore.jar" />
                    <include name="common/com.xfy/Categories.jar"/>
                </fileset>
            </classpath>
        </javac>
    </target>

    <target name="jar" description="bin 以下を jar にまとめます">
        <mkdir dir="dist"/>
        <jar jarfile="dist/${component.name}.jar" basedir="bin" />
    </target>

    <target name="clean" description="bin, jar ファイルを削除します">
        <delete dir="bin" includeemptydirs="true"/>
        <delete>
            <fileset dir=".">
                <include name="dist/${component.name}.jar" />
            </fileset>
        </delete>
    </target>
</project>

なお、Eclipseで上記のAntビルドスクリプトのターゲット「clean」を実行した直後にデフォルトターゲット「all」を実行すると、エラーが発生します。これを回避するにはEclipseの環境設定を変更する必要があります。「4.3. EclipseのJDKの設定」の設定手順に基づいて、Eclipseの環境を設定してください。

「4.1. 必要なファイルの作成」で作成したファイルを、xfyプラグインの内部構造に合わせた形式でJARファイルとして圧縮すると、xfyプラグインJARファイルを作成できます。xfyプラグインの内部構造について、詳しくは「xfyプラグイン情報仕様」の「xfyプラグインの内部構造」をご覧ください。

「4.1. 必要なファイルの作成」で示したAntビルドスクリプトをそのまま使用する場合は、作成したファイルを次のように配置してAntビルドスクリプトを実行すると、xfyプラグインJARファイルを作成できます。

xfy-sample                : プロジェクト
    +- src                   : ソースフォルダ
    |   +- com               : Javaのソースコード群
    |   |   +- example
    |   |       +- sample
    |   |          *.java
    |   +- manifest.xml      : マニフェストファイル
    +- build.xml             : Antビルドスクリプト

Antビルドスクリプトを実行したら、以下の場所にxfyプラグインJARファイルが作成されます。

xfy-sample
    +- dist
        +- Sample.jar        : 作成されたxfyプラグインJARファイル

プロジェクトディレクトリの下にあるdistフォルダは、Antによって作成されます。そのため、Eclipseでxfy-sampleプロジェクトの「更新」を行うまでは、distフォルダは表示されません。

作成したxfyプラグインJARファイルは、xfyユーザーエージェントの実行環境にインポートして、xfyユーザーエージェントを再起動することで使用できるようになります。

Windows XPにJDKとJREをインストールした場合、Eclipseの標準の設定のままで「4.1. 必要なファイルの作成」で示したAntビルドスクリプトを実行すると<javac>タスクでエラーが発生することがあります。これはEclipseではデフォルトのJavaの実行環境としてJREを使用するため、JDKのjavac.exeへのパスが設定されていないためです。この節では、「3. プロジェクトの作成」で作成したプロジェクトのJava実行環境としてJDKを指定する手順を説明します。

1. EclipseのJavaパースペクティブの［パッケージ・エクスプローラー］で「xfy-sample」を選択します。
2. ［Project - Properties］を選択します。
   ［Properties for xfy-sample］ダイアログボックスが表示されます。
   
3. ダイアログボックスの左側にあるツリーで、［Java Build Path］を選択します。
4. ダイアログボックスの右側の［Libraries］シートを選択します。
5. ［JARs and class folders on the build path］で「JRE System Library [jre1.5.0_06]」を選択します。
   
6. ［Edit］をクリックします。
   ［Edit Library］ダイアログボックスが表示されます。
7. ［Alternate JRE］を選択して、［Installed JREs］をクリックします。
   
   ［Preferences］ダイアログボックスが表示されます。
   
8. ［Add］をクリックします。
   ［Add JRE］ダイアログボックスが表示されます。
9. ［JRE name］に［jdk1.5.0_06］と入力します。
   
10. ［JRE home directory］の右側にある［Browse］をクリックします。
    フォルダを選択するダイアログボックスが表示されます。
11. JDK 5.0 Update 6をインストールしたフォルダを選択します。
    JDKを標準の設定でインストールした場合、選択するフォルダは「C:\Program Files\Java\jdk1.5.0_06」です。
12. ［OK］をクリックします。
    ［Add JRE］ダイアログボックスに戻ります。
    
13. ［OK］をクリックします。
    ［Preferences］ダイアログボックスに戻ります。
14. ［Installed JREs］で、「jdk1.5.0_06」の左端にあるチェックボックスをオンにします。
15. ［OK］をクリックします。
    ［Edit Library］ダイアログボックスに戻ります。
16. ［Alternate JRE］に「jdk1.5.0_06」が表示されていることを確認して、［Finish］をクリックします。
    ［Properties for xfy-sample］ダイアログボックスに戻ります。
    
17. ［OK］をクリックします。
18. Antビルドスクリプトが正常に動作することを確認します。