DataSpide SDK とEclipse開発環境構築
DataSpiderSDKに付属されているサンプルソースは、ビルドツールとしてAntを採用しています。
SDKマニュアル(コンポーネントSDK 開発ガイド※)の第5章アダプタの作成の説明欄にコマンドラインからantコマンドにより、clean、build、inatallの手順が記載されています。
テキストエディタで編集しコマンドラインからビルドを実行、テスト実施後インストールという一連の操作は可能であるが利便性を考慮しEclipseを使用して開発を行いたいものです。
今回は、今後SDK開発を行うにあたり、DataSpiderSDKに付属されているサンプルソースを利用し、Eclipseを使用したビルド環境を構築します。さらにSDKのビルドからDataSpiderへのインストールまでを紹介したいと思います。
セットアップする環境
当ページでは以下の環境を前提に進めています。
Windows 10 64bit
開発環境の構築
DataSpider Servista(製品版もしくは体験版)のインストール
DataSpiderをまだ入手されていない方は、以下のページからダウンロードおよびインストールを済ませましょう。
【DataSpider Servistaの体験版とは】
https://base.terrasky.co.jp/articles/MWULp
Eclipseのダウンロード
SDK開発ではJava8が必要です。Eclipseの種類によりJava8が付属しているため、以下のEclipseバージョンをダウンロードします。
ダウンロードしたEclipseにJava8が付属しているため、Ecliseを展開後、その下のJava8までのパスを環境変数に登録します。
具体的には以下を参照:
1. Eclipseページを開き、最新のEclipseを選択します。
https://mergedoc.osdn.jp/
4. 任意のフォルダに展開します。
Antビルドツールのダウンロード
Java8に対応したバージョンをダウンロードします。
ダウンロードしたAntを展開後、その下のAnt¥binまでのパスを環境変数に登録します。
1. Antページを開きます。
https://ant.apache.org/bindownload.cgi
2. 画面を少し下方向にスクロールし、Java8対応のバージョンをクリックします。クリックするとダウンロードが開始されます。
3. 任意のフォルダに展開します。
各環境変数の設定
JAVA_HOME、ANT_HOME、PATHにそれぞれ必要なパスを登録※ します。
登録内容は以下。
※ パスの登録(環境変数)についてはこちらの記事を参照:
https://proengineer.internous.co.jp/content/columnfeature/5205
-
PATH
%JAVA_HOME%\bin、%ANT_HOME%\binを登録します。
DataSpiderSDKのダウンロード
こちらは、前回の記事を参照:
https://qiita.com/dataspider-fan/items/eb850b6e185b9fffdd33
以上で、開発に必要なツール類が揃いました。
SDKのファイルの中身
SDKの展開
ダウンロードしたSDK DSS_SDK_42.zipを以下のフォルダに展開します。
フォルダ構成
- dev
開発に必要なjarファイル、定義ファイルが格納されています。
今後、SDKによるアダプタがの開発は、このフォルダ下にソースコードを配置して行います。 - doc
SDKマニュアルが格納されています。 - sample
DataSpiderが提供するサンプルソースコードが格納されています。
Hello World AdapterサンプルコードのEclipseプロジェクトへの登録
これからやることの整理
SDKを展開したsamplesフォルダ下に数種類のソースコードが格納されています。
この中から、「Hello World Adapter」というアダプタをdev下にコピーし、Eclipseのプロジェクトに読み込ませビルドします。
この時点でアダプタのjarファイルが生成されます。
ビルド後、DataSpiderにjarファイルをインストールし、DataSpiderのスクリプトから実行し動作を確認します。
なお、今回インストールまで行う「Hello World Adapter」は、スクリプトの実行時にデバッグ欄に「Hello World !」を出力するアダプタです。
Hello World Adapterの登録
1. sampleフォルダ下あるHello World Adapterフォルダをdevフォルダ下にコピーします。
なお、Hello World Adapterサンプルプログラムの詳細は、「5.1. Hello World Adapter の作成」を参照ください。
2. build.xmlを開きプロジェクト名を変更します。
赤ライン「DataSpiderServistaAdapter SDK」部分を緑ライン「hello_world_adapter」に変更:
<?xml version="1.0" encoding="Shift_JIS"?>
- <project name="DataSpiderServistaAdapter SDK" default="jar" basedir=".">
+ <project name="hello_world_adapter" default="jar" basedir=".">
<taskdef file="../ant_custom.properties" classpath="../ant_custom.jar" />
<import file="../build.xml"/>
<!-- init -->
<target name="init.basename">
<basename property="module" file="${basedir}"/>
</target>
</project>
3.Eclipseを起動します。
Eclipseは管理者権限で起動します。
ビルドしたHello World AdapterをDataSpider下のライブラリパスにコピーする際に管理者権限が必要となります。
Eclipseの起動時に表示されるワークスペースのパスに上記SDKのdevフォルダを指定します。
4.ファイルメニューから新規 > その他を選択します。
既存AntビルドファイルからのJavaプロジェクトを選択します。
参照ボタンをクリックします。
先ほどコピーしたhello_world_adapterフォルダ下のbuild.xmlを選択します。
完了ボタンをクリックします。
5.ダイアログが閉じ、ツリー表示(プロジェクト・エクスプローラ部分)に画面が遷移します。
Eclipseへのプロジェクト登録は以上です。
Hello World Adapterのビルド
Javaバージョンの変更
左側ツリーからJava > インストール済みのJREをクリックし、Java8にチェックを入れます。
画面下の適用ボタンをクリックします。
続いて、左側ツリーからJava > コンパイラをクリックし、JDK準拠欄おリストボックスから1.8を選択します。
適用して閉じるボタンをクリックします。
Javaバージョンの変更は以上です。
ビルド実行
1. build.xmlを右クリックし、実行から1.Antビルドをクリックします。
2. 正常にビルドが完了すると、jarファイルが生成されます。
Buildfile: C:\DataSpiderSDKs\dev\hello_world_adapter\build.xml
init.basename:
init:
[echo] dataspider.home: C:\Program Files\DataSpiderServista
[echo] Implementation-Title: HelloWorldAdapter
[echo] display.name: Hello World Adapter
[echo] module.category: SAMPLE
[echo] module.label: HelloWorld
[echo] basedir: C:\DataSpiderSDKs\dev\hello_world_adapter
[echo] module: hello_world_adapter
assert:
prepare:
touch.module.props:
native2ascii_default:
native2ascii:
[echo] encoding: UTF-8
compile:
jar:
update.modules.props:
execute.custom:
BUILD SUCCESSFUL
Total time: 449 milliseconds
3. buildフォルダ下に、hello_world_adapter.jarファイルが出力されていることが確認できます。
ビルドは以上です。
Hello World Adapterのインストール
インストールは、DataSpider下のフォルダにjarファイルをコピーすれば完了です。
Antビルドツールのinstall設定にて、このコピー処理が行えます。その設定手順を説明します。
インストール時は、DataSpider_Servistaサービスを停止しておきます。
Antターゲットの設定とインストール実行
1. build.xmlを右クリックし、実行からファイルツールの構成をクリックします。
2. 実行するターゲットを検査欄からinstallをチェックをONにします。
3. 実行ボタンをクリックします。
Buildfile: C:\DataSpiderSDKs\dev\hello_world_adapter\build.xml
init.basename:
init:
[echo] dataspider.home: C:\Program Files\DataSpiderServista
[echo] Implementation-Title: HelloWorldAdapter
[echo] display.name: Hello World Adapter
[echo] module.category: SAMPLE
[echo] module.label: HelloWorld
[echo] basedir: C:\DataSpiderSDKs\dev\hello_world_adapter
[echo] module: hello_world_adapter
assert:
prepare:
touch.module.props:
native2ascii_default:
native2ascii:
[echo] encoding: UTF-8
compile:
jar:
update.modules.props:
execute.custom:
init.basename:
init:
[echo] dataspider.home: C:\Program Files\DataSpiderServista
[echo] Implementation-Title: HelloWorldAdapter
[echo] display.name: Hello World Adapter
[echo] module.category: SAMPLE
[echo] module.label: HelloWorld
[echo] basedir: C:\DataSpiderSDKs\dev\hello_world_adapter
[echo] module: hello_world_adapter
assert:
prepare:
touch.module.props:
native2ascii_default:
native2ascii:
[echo] encoding: UTF-8
compile:
jar:
update.modules.props:
execute.custom:
install:
[mkdir] Created dir: C:\Program Files\DataSpiderServista\server\plugin\data_processing\modules\hello_world_adapter
[mkdir] Created dir: C:\Program Files\DataSpiderServista\server\plugin\data_processing\modules\hello_world_adapter\META-INF
[copy] Copying 1 file to C:\Program Files\DataSpiderServista\server\plugin\data_processing\modules\hello_world_adapter
[copy] Copying 4 files to C:\Program Files\DataSpiderServista\server\plugin\data_processing\modules\hello_world_adapter\META-INF
BUILD SUCCESSFUL
Total time: 526 milliseconds
Antターゲットの設定とインストールは以上です。
DataSpiderからの実行
DataSpiderを起動し、hello_world_adapterアダプタが表示されることを確認後、スクリプトにhello_world_adapterアイコンを配置し、スクリプトを実行することによりhello_world_adapterで定義されたメッセージが出力されるまでを見てみましょう。
ビルドからインストールまで正常に完了すると以下の右下にSDKにて指定されたツールパレット(画面右側)にhello_world_adapterアダプタが読み取りアイコンとして表示されます。
hello_world_adapterをSAMPLEカテゴリに設定(デフォルトのまま変更無し)したため、SAMPLE下に表示されます。
アイコンを設置しスクリプトを実行すると、hello_world_adapterに定義されたメッセージが出力されます。
動作確認は以上です。
次回は
DataSpiderの製品コンセプトは、「ノンプログラミング/ノーコードでシステム間のデータやアプリケーションをつなぐ」と提唱しているということもあり、数年前からメディアでも取り上げられるようになったブロックチェーンと連携できるアダプタを開発したいと思います。
DataSpiderは英語版も提供されており、アダプタの多言語化を実装したいと思います。