Shafu - Asakusa Gradle Plug-in Helper for Eclipse -

Shafu (車夫) は、 Asakusa Framework のバッチアプリケーション開発をサポートするEclipseプラグインです。

Shafu は バッチアプリケーション開発にGradleを利用する際に、Eclipseから透過的にビルドツール上の操作を行えます。 Shafuを使うことで、ターミナル上でのビルドツールの操作が不要となり、Eclipse上でアプリケーション開発に必要なほとんどの作業を行うことができるようになります。

Shafu は Jinrikisha でセットアップしたEclipse環境ではもちろんのこと、単体でセットアップしたEclipse上での利用も可能です。

Note

Asakusa Frameworkが提供するGradle上のビルド機能についての詳細は、Asakusa Frameworkのドキュメント Asakusa Gradle Plugin利用ガイド を参照してください。

対応プラットフォーム

Shafuは以下のプラットフォームで動作を検証しています。

プラットフォーム	ソフトウェア	バージョン	備考
IDE	Eclipse	4.4.2
Java	Oracle JDK	JDK7	推奨環境
Java	Open JDK	JDK7	基本的な動作確認のみ
OS	Ubuntu Desktop (32bit/64bit)	14.04	推奨環境
OS	CentOS (32bit/64bit)	6.2
OS	MacOSX	10.9	[1]
OS	Windows	7 SP1 / 8.1

[1]	MacOSXでJDK6を利用する場合、Eclipse実行時の文字エンコーディングをUTF-8などの日本語を利用できる環境にする必要があります。 Eclipseの公式サイト などを参考に、 eclipse.ini ファイルの -vmargs 以降の行に -Dfile.encoding=UTF-8 の記述を追加してください。なおJinrikishaで構築した環境では環境変数 _JAVA_OPTIONS 経由で file.encoding が設定されるためこの設定は不要です。

インストール

Shafu は次のアップデートサイトを使用してインストールすることができます。

• http://www.asakusafw.com/eclipse/jinrikisha/updates/

インストール手順

Eclipse上でShafu のアップデートサイトを利用したインストール手順例を説明します。

1. Eclipseのメニューから Help ‣ Install New Software... を選択します。
2. Install ダイアログで Work with: の項目右の Add ボタンを押下します。
3. Add Repository ダイアログで Name: に任意の名前(例: Jinrikisha )、Location: に上記アップデートサイトのURLを入力して OK ボタンを押下します。
4. Install ダイアログに表示された [Jinrikisha (人力車)] カテゴリを展開して [Asakusa Gradle プラグインサポート] を選択し、 Next > ボタンを押下します。
5. 以降、画面の指示に従いインストールを進めます。Eclipseの再起動を促されたら Yes を選択します。
6. Eclipse再起動が完了したら、Javaパースペクティブを表示して Window ‣ Reset Perspective.. を選択してJavaパースペクティブを初期化します。

使い方

Shafu が提供する各機能の使い方を説明します。

Gradleプロジェクトをテンプレートから生成

オンライン上に公開されているAsakusa Frameworkのプロジェクトテンプレートや、ローカルに配置したプロジェクトテンプレートを利用して、Eclipse上に新規プロジェクトを作成することができます。

1. Javaパースペクティブ上のメインメニューなどから File ‣ New ‣ Gradleプロジェクトをテンプレートから生成 を選択します。
2. 新規プロジェクト情報ダイアログで、プロジェクト名などを入力します。
3. プロジェクトテンプレートの選択ダイアログで、オンラインまたはローカルのテンプレートファイルを指定します。URL入力ボックス右の 選択 ボタンを押すと、オンラインに公開されているプロジェクトテンプレートを一覧から選択することができます。
4. Finish ボタンを押すと選択したプロジェクトテンプレートを読み込み、Eclipseプロジェクトとして新規プロジェクトが作成されます。

Gradleプロジェクトのインポート

ローカルに配置したGradleベースのプロジェクトをEclipseワークスペース上にインポートすることができます。 単体のプロジェクトをインポートするほか、複数のプロジェクトから構成されるマルチプロジェクト構成のプロジェクトを一括してインポートすることもできます。

1. Javaパースペクティブ上のメインメニューなどから File ‣ Import を選択します。
2. インポート選択画面で Jinrikisha (人力車) ‣ Gradle プロジェクト を選択して Next > ボタンを押します。
3. プロジェクトディレクトリーの選択ダイアログで、ローカルに配置されているGradleプロジェクトのディレクトリーパスを選択して Next > ボタンを押します。
4. インポート対象のプロジェクト選択で、インポート対象のプロジェクトを選択して Finish ボタンを押します。

プロジェクトのビルド

プロジェクトのデータモデルクラスの生成やAsakusa DSLのコンパイルなど、Asakusa FrameworkがGradleを利用する各ビルド機能を実行することができます。

1. プロジェクトを選択してコンテキストメニュー(右クリックなどで表示されるメニュー)を表示します。
2. コンテキストメニューの Jinrikisha (人力車) を選択し、サブメニューとして表示される以下の各ビルド機能を選択します。

Jinrikisha (人力車) メニュー

メニュー名	説明	Gradleタスク [2]
タスク名を指定してビルド	任意のGradleタスクを入力して実行する	-
DMDLからデータモデルクラスを生成	DMDLスクリプトからデータモデルクラスを生成	compileDMDL
テストデータ・テンプレートを生成	DMDLスクリプトからTestDriverのテストデータを定義するExcelブックを生成する	generateTestbook
Asakusaバッチアプリケーションを生成	Asakusa DSLをバッチコンパイルして、バッチアプリケーションアーカイブファイルを生成する	jarBatchapp
Asakusaデプロイメントアーカイブを生成	Asakusa Frameworkの実行環境一式を含むデプロイメントアーカイブファイルを生成する	assemble
Asakusa開発環境の構成	Asakusa Frameworkの開発環境をセットアップするためのサブメニューを表示する	-
Eclipseプロジェクト情報を再構成	Eclipseのプロジェクト定義ファイルを再作成する [3]	eclipse

Asakusa開発環境の構成 サブメニュー

メニュー名	説明	Gradleタスク
Asakusa Frameworkのインストール	開発用のAsakusa Frameworkをインストールする	installAsakusafw

[2]	各メニューの選択時に実行されるAsakusa Gradle PluginのGradleタスクです。 詳しくはAsakusa Frameworkのドキュメント Asakusa Gradle Plugin利用ガイド を参照してください。

[3]	Asakusa Frameworkのバージョンアップやアプリケーションライブラリの追加などで、Eclipseプロジェクトのクラスパス情報を更新する場合に使用します。

設定

Eclipseの設定画面からShafuの設定を変更することができます。

1. メニューバーから Window ‣ Preferences を選択します。
2. Eclipse設定画面のサイドメニューから Jinrikisha (人力車) を選択します。

Jinrikisha (人力車) ページ

基本

Gradleのログレベルやバージョン、オフラインモードの設定など、Gradleの動作に関する設定を行います。

プロジェクト

Gradleのプロジェクトビルド時に使用するプロジェクトプロパティーを設定することができます。

Java VM

Gradleのビルドで使用するJava VMやJavaプロセスに対するシステムプロパティーを指定します。

Asakusa Framework ページ

テンプレートカタログURL

Gradleプロジェクトをテンプレートから生成 でプロジェクトテンプレートを選択する際に使用する、プロジェクトテンプレートの一覧を定義したテンプレートカタログファイルを指定します。 デフォルトでは Asakusa Frameworkが公開しているリリースバージョンの一覧を含むテンプレートカタログが指定されています。

Tip

Asakusa Frameworkが公開しているテスト用のバージョン (スナップショットビルドやRC版）を使用したい場合は、テンプレートカタログURLを以下のURLに変更します。

http://www.asakusafw.com/download/gradle-plugin/template-catalog-develop.txt

拡張機能

テスト時にエミュレーションモードを有効にする

Gradleプロジェクトをテンプレートから生成 を使った新規プロジェクトの作成時やプロジェクトに対して Eclipseプロジェクト情報を再構成 を実行した場合に、プロジェクトに対してエミュレーションモード [4] を利用する設定を追加します。

[4]	エミュレーションモードについては、Asakusa Frameworkのドキュメント エミュレーションモードによるアプリケーションテスト を参照してください。

現在の設定

現在の環境の設定に関する情報を表示します。この画面から各項目の値を編集することはできません。

フレームワークのインストール先 (ASAKUSA_HOME)

現在の環境で設定されている環境変数 ASAKUSA_HOME の値を表示します。

Hadoopコマンドの場所

現在の環境で使用するHadoopコマンドのパスを表示します。

ネットワークプロキシの設定

オンラインとの接続にプロキシサーバを経由する必要がある場合は、Eclipseのプロキシ設定画面でプロキシの設定を行います。

1. メインメニューから Window ‣ Preferences を選択します。
2. プリファレンス画面のサイドメニューから General ‣ Network Connections を選択します。
3. プロキシ設定画面で、 Active Provider: を Manual に変更し、 Proxy entries や Proxy bypass の内容を編集して OK ボタンを押します。

リソース

• ソースリポジトリ (GitHub)