Asakusa Framework スタートガイド

この文書では、Asakusa Frameworkをはじめて利用するユーザー向けに、Asakusa Frameworkを使ったバッチアプリケーションの開発、実行方法を簡単に説明します。

See also

本書より詳しい入門向けドキュメントとして、 Asakusa Framework チュートリアル ではサンプルアプリケーションを作成しながらフレームワークの基本的な使い方や開発の流れを説明しています。

開発環境の準備

前提環境

Asakusa Frameworkを開発環境で利用するためには、開発環境に以下がセットアップされている必要があります。

ソフトウェア バージョン 備考
JDK JDK 8 JREは利用不可
Eclipse 4.4.2 以上を推奨 Shafuを利用する場合に使用

Attention

Asakusa Frameworkのバッチアプリケーションのコンパイルやテストの実行にはJDKが必要です。 JREのみがインストールされている環境では利用できません。

環境変数の設定

Asakusa Frameworkを開発環境で利用するには、以下の環境変数が必要です。

変数名
ASAKUSA_HOME Asakusa Frameworkのインストールディレクトリを指定
JAVA_HOME JDKのインストールディレクトリを指定
PATH JDKのコマンドパスを追加: ${JAVA_HOME}/bin

Asakusa Frameworkの開発支援ツール

Asakusa Frameworkを使ったバッチアプリケーションの開発は、基本的にJavaを利用したアプリケーションの開発になりますが、いくつかの点でAsakusa Framework固有の環境設定やビルドに関する知識が必要になります。

そのため、Asakusa Frameworkではアプリケーションの開発をサポートするいくつかのツールを提供しています。

Shafu

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

Asakusa Frameworkではアプリケーションのビルドに Gradle というビルドシステムを利用しますが、 Shafuを使うことで、Gradleに関する詳細な知識がなくてもAsakusa Frameworkの基本的な開発作業が行えるようになります。 また、コマンドライン上でのGradleの操作が不要となり、Eclipse上でアプリケーション開発に必要なほとんどの作業を行うことができるようになります。

なお、このスタートガイドではコマンドライン上でGradleを利用する手順と、Shafuを利用する手順の両方を記載します。

Jinrikisha

Jinrikisha (人力車) は、 Asakusa Framework の開発環境を手軽に構築するためのインストーラパッケージです。

Jinrikishaは新規のLinux環境上にAsakusa Framework専用の開発環境を簡単にセットアップすることを主な目的としています。 JDKやEclipseといった基本的なツールのセットアップに加えて、ローカル環境でHadoopやSparkを利用したバッチアプリケーションを実行できるようにするための設定も行うため、 Hadoopクラスターなどの運用環境にデプロイする前にバッチアプリケーションの疎通確認や検証を行うといった用途に適しています。

このスタートガイドではJinrikishaの利用は前提ではありませんが、開発したアプリケーションをローカルで実行したい場合はJinrikishaを使って環境をセットアップすると便利です。

Shafuのセットアップ

Shafuを利用する場合、以下の手順例を参考にしてEclipse上にインストールしてください。

See also

Shafuについては、 Shafuのドキュメント も参考にしてください。

Shafuのインストール

ShafuはEclipseプラグインとして公開されており、一般的なEclipseプラグインと同様にインストールを行います。

以下、Eclipse上でのインストール手順例です。

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

Attention

Shafuのインストール後にJavaパースペクティブの初期化を行わないと、Shafuのメニューが表示されないことがあります。

EclipseのJDK登録

Eclipse経由で実行するJavaにJREが設定されている場合、これをJDKに変更します。

  1. Eclipseの設定画面から Java ‣ Installed JREs を選択します。
  2. Installed JREs ダイアログにJDK以外のJava定義が表示されている場合 (例えば jre8 のような項目が表示されている場合)、これら項目を削除します。 削除する項目を選択して、 Remove ボタンを押下します。
  3. JDKを追加します。 Installed JREs ダイアログで Add ボタンを押下します。
  4. JRE Type ダイアログで Standard VM を選択し、 Next > ボタンを押下します。
  5. JRE Definition ダイアログで JRE home: の項目右の Directory... ボタンを押下し、JDKのフォルダを指定します。
  6. JRE Definition ダイアログの各項目にインストールしたJDKの情報が設定されたことを確認して Finish ボタンを押下します。
  7. Installed JREs ダイアログに追加したJDKの項目が表示されるので、その項目の Name 欄に表示されているチェックボックスを ON にします。JDKの項目が jdk1.8.0_XX (default) のような表示になれば設定完了です。

Attention

Asakusa Frameworkのバッチアプリケーションのコンパイルやテストの実行にはJDKを使用する必要があります。 JREを使用することはできないため、必ず上記の設定を確認してください。

環境変数の確認

Eclipse上で環境変数 ASAKUSA_HOME が有効になっていることを確認します。

  1. Eclipseの設定画面から Jinrikisha (人力車) ‣ Asakusa Framework を選択します。
  2. フレームワークのインストール先 (ASAKUSA_HOME) に環境変数 ASAKUSA_HOME で設定したフォルダが表示されていることを確認します。

正しく表示されていない場合、環境の設定を確認してください。

アプリケーション開発の準備

アプリケーションプロジェクトの作成

バッチアプリケーションの開発をはじめるには、まずAsakusa Frameworkアプリケーション開発用のプロジェクトを作成します。

アプリケーションプロジェクトを作成するには、オンライン上に公開されているAsakusa Frameworkのプロジェクトテンプレートを利用すると便利です。 このプロジェクトテンプレートにはプロジェクトで利用するビルドツール(Gradle)の設定や実行環境、および開発環境で利用する設定ファイルなどが含まれます。

プロジェクトテンプレートは、以下リンクからダウンロードします。

プロジェクトテンプレートのダウンロード
プロジェクトテンプレート 説明
asakusa-spark-template-0.9.1.tar.gz Asakusa on Spark を利用するプロジェクトテンプレート
asakusa-m3bp-template-0.9.1.tar.gz Asakusa on M3BP を利用するプロジェクトテンプレート
asakusa-mapreduce-template-0.9.1.tar.gz Asakusa on MapReduce を利用するプロジェクトテンプレート

コマンドライン上から作成する場合、上記のURLに公開されているプロジェクトテンプレートのアーカイブを展開します。 以下は Asakusa on Spark 用のプロジェクトテンプレートを展開する例です。

cd <work-dir>
curl -OL http://www.asakusafw.com/download/gradle-plugin/asakusa-spark-template-0.9.1.tar.gz
tar xf asakusa-spark-template-0.9.1.tar.gz
mv asakusa-spark-template my-batchapp
cd my-batchapp

Shafuを導入した開発環境では、オンライン上に公開されているAsakusa Frameworkのプロジェクトテンプレートカタログを利用して、テンプレートプロジェクトをベースに新規プロジェクトを作成することができます。

  1. Javaパースペクティブ上のメニューバーから File ‣ New ‣ Gradleプロジェクトをテンプレートから生成 を選択します。

  2. 新規プロジェクト情報 ダイアログで、プロジェクト名などを入力します。

  3. テンプレートからプロジェクトを作成 ダイアログで URLを指定してプロジェクトテンプレートをダウンロードする が選択状態になっていることを確認して、画面右の 選択 ボタンを押下します。

  4. プロジェクトテンプレート ダイアログにオンラインに公開されている、利用可能なプロジェクトテンプレートの一覧が表示されます。

    • Asakusa on Spark を利用するプロジェクトテンプレートを利用する場合は、以下を選択します。
      • Asakusa Project Template <Spark> - <version>
    • Asakusa on M3BP を利用するプロジェクトテンプレートを利用する場合は、以下を選択します。
      • Asakusa Project Template <M3BP> - <version>
    • Asakusa on MapReduce を利用するプロジェクトテンプレートを利用する場合は、以下を選択します。
      • Asakusa Project Template <MapReduce> - <version>
  5. Finish ボタンを押すと選択したプロジェクトテンプレートを読み込み、Eclipseプロジェクトとして新規プロジェクトが作成されます。

Asakusa Frameworkのインストール

次に、開発環境用のAsakusa Frameworkをインストールします。これはアプリケーションのテスト時などに利用します。

コマンドライン上からインストールする場合、Gradleの installAsakusafw タスクを実行します。 プロジェクト上でタスクを実行するには、以下のように gradlew コマンドにタスク名を指定して実行します。

./gradlew installAsakusafw

Shafuを導入した開発環境では、EclipseのメニューからAsakusa Frameworkのインストールを実行します。

  1. Javaパースペクティブ上のプロジェクトを選択してコンテキストメニュー(右クリックなどで表示されるメニュー)を表示します。
  2. コンテキストメニューから Jinrikisha (人力車) ‣ Asakusa開発環境の構成 ‣ Asakusa Frameworkのインストール を選択します。

インストールが成功した場合、コンソールに以下のように表示され、環境変数 ASAKUSA_HOME で指定したフォルダ配下にAsakusa Frameworkがインストールされます。

...
:installAsakusafw
Asakusa Framework is successfully installed: /home/asakusa/asakusa

BUILD SUCCESSFUL

Total time: 4.352 secs

Next Step

ここまでの手順で、Asakusa Framework上でバッチアプリケーションの開発を行う準備が整いました。

次のステップとして、 開発の流れ では実際にアプリケーションの開発を行うための、Asakusa Frameworkを使ったアプリケーション開発の流れを紹介しています。

また Asakusa Framework チュートリアル では、サンプルアプリケーションを作成しながらフレームワークの基本的な使い方や開発の流れを説明しています。

このスタートガイドの以降の説明では、公開されているサンプルアプリケーションを使ってバッチアプリケーションを実行する手順を紹介しています。

サンプルアプリケーションの実行

ここでは、Asakusa Frameworkのサンプルアプリケーションを使って、Spark環境上でバッチアプリケーションを実行する手順を簡単に説明します。

Spark環境はあらかじめ準備されているものとします。 また、入出力ファイルの配置にはHadoopファイルシステムを利用するため、Hadoop環境も合わせて準備されているものとします。

サンプルアプリケーションの概要

Asakusa Frameworkの サンプルプログラム集 (GitHub) ではいくつかのサンプルアプリケーションが公開されています。 その中から、ここでは examle-basic-spark ディレクトリ配下に含まれるサンプルアプリケーション「カテゴリー別売上金額集計バッチ」を使います。

カテゴリー別売上金額集計バッチは、売上トランザクションデータと、商品マスタ、店舗マスタを入力として、エラーチェックを行った後、売上データを商品マスタのカテゴリ毎に集計するアプリケーションです。

バッチアプリケーションの入力データ取得と出力データ生成には、Asakusa Frameworkの「Direct I/O」と呼ばれるコンポーネントを利用しています。 Direct I/Oを利用して、Hadoopファイルシステム上のCSVファイルに対して入出力を行います。

サンプルアプリケーションプロジェクトの作成

サンプルプログラム集 (GitHub) に公開されているプロジェクトを開発環境に取り込みます。

コマンドライン上でプロジェクトを作成する場合、GitHub上に公開されているサンプルアプリケーションのアーカイブを展開します。

cd <work-dir>
curl -OL https://github.com/asakusafw/asakusafw-examples/archive/0.9.1.tar.gz
tar xf 0.9.1.tar.gz
cd asakusafw-examples-0.9.1/example-basic-spark

Shafuを導入した開発環境では、オンライン上に公開されているAsakusa Frameworkのプロジェクトテンプレートカタログを利用して、サンプルアプリケーションのプロジェクトをEclipse上に取り込みます。

  1. Javaパースペクティブ上のメニューバーから File ‣ New ‣ Gradleプロジェクトをテンプレートから生成 を選択します。

  2. 新規プロジェクト情報 ダイアログで、プロジェクト名などを入力します。

  3. テンプレートからプロジェクトを作成 ダイアログで URLを指定してプロジェクトテンプレートをダウンロードする が選択状態になっていることを確認して、画面右の 選択 ボタンを押下します。

  4. プロジェクトテンプレート ダイアログにオンラインに公開されている、利用可能なプロジェクトテンプレートの一覧が表示されます。ここでは以下を選択します。
    • Asakusa Example Projects - 0.9.1
  5. Finish ボタンを押すと選択したプロジェクトテンプレートを読み込み、Eclipseプロジェクトとして新規プロジェクトが作成されます。

  6. テンプレートからプロジェクトを作成 ダイアログで example-basic-spark を選択して OK ボタンを押下します。

サンプルアプリケーションのビルド

Asakusa Frameworkの開発環境で作成したバッチアプリケーションを運用環境(Hadoopクラスターなど)で実行するには、コンパイル済みのバッチアプリケーションとAsakusa Framework本体の実行モジュールをあわせて運用環境にデプロイします。 そのためにまず、開発環境上でデプロイに必要なモジュールを全て含めた「デプロイメントアーカイブ」と呼ばれるパッケージファイルを生成します。

コマンドライン上でデプロイメントアーカイブを生成するには、Gradleの assemble タスクを実行します。

./gradlew assemble

Shafuを導入した開発環境では、コンテキストメニューから Jinrikisha (人力車) ‣ Asakusaデプロイメントアーカイブを生成 を選択します。

このコマンドの実行によって、アプリケーションプロジェクトに対して以下の処理が実行されます。

  • データモデル定義DSL(DMDL)から、データモデルクラスを生成
  • Asakusa DSLとデータモデル定義DSLから、HadoopやSparkなどの各処理系で実行可能なプログラム群を生成
  • アプリケーションを実行環境に配置するためのデプロイメントアーカイブファイルを生成

デプロイメントアーカイブファイルはプロジェクトの build ディレクトリ配下に asakusafw-example-basic-spark.tar.gz というファイル名で生成されます。

サンプルアプリケーションのデプロイ

サンプルアプリケーションのビルド で作成したデプロイメントアーカイブファイルを運用環境にデプロイします。

通常、デプロイ対象となるノードはHadoopやSparkのクライアントモジュールがインストールされているノードを選択します。

以降の手順を行う前に、デプロイメントアーカイブファイル asakusafw-example-basic-spark.tar.gz をデプロイ対象となるノードに転送しておいてください。

環境変数の設定

運用環境上でAsakusa Frameworkを配置しバッチアプリケーションを実行するためのOSユーザーに対して、以下の環境変数を設定します。

  • JAVA_HOME: Javaのインストールパス
  • SPARK_CMD: spark-submit コマンドのパス
  • ASAKUSA_HOME: Asakusa Frameworkのインストールパス

以下は環境変数の設定例です。

export JAVA_HOME=/usr/lib/jvm/java-8-oracle
export SPARK_CMD=/opt/spark/bin/spark-submit
export ASAKUSA_HOME=$HOME/asakusa

デプロイメントアーカイブの展開

サンプルアプリケーションのビルド で作成したデプロイメントアーカイブファイル asakusafw-example-basic-spark.tar.gz を配置し、 $ASAKUSA_HOME 配下にデプロイメントアーカイブを展開します。 展開後、 $ASAKUSA_HOME 配下の *.sh に実行権限を追加します。

mkdir -p "$ASAKUSA_HOME"
cd "$ASAKUSA_HOME"
tar -xzf /path/to/asakusafw-example-basic-spark.tar.gz
find "$ASAKUSA_HOME" -name "*.sh" | xargs chmod u+x

サンプルデータの配置

サンプルアプリケーションの構成では、 $ASAKUSA_HOME/example-dataset ディレクトリ以下にテスト用の入力データが用意されています。 これらのファイルをHadoopファイルシステム上のDirect I/Oの入出力ディレクトリ(デフォルトの設定では target/testing/directio 配下) にコピーします。

Warning

Direct I/Oの出力ディレクトリはバッチアプリケーション実行時に初期化されます。 既存のディレクトリを利用する場合、このパスに重要なデータがないことを実行前に確認してください。

以下は、サンプルデータをHadoopファイルシステムに配置する手順の例です。

hadoop fs -mkdir -p target/testing/directio
hadoop fs -put $ASAKUSA_HOME/example-dataset/master target/testing/directio/master
hadoop fs -put $ASAKUSA_HOME/example-dataset/sales target/testing/directio/sales

サンプルアプリケーションの実行

サンプルアプリケーションを実行します。

Asakusa Frameworkでは、バッチアプリケーションを実行するためのコマンドプログラムとして「YAESS」というツールが提供されています。 バッチアプリケーションを実行するには、$ASAKUSA_HOME/yaess/bin/yaess-batch.sh に実行するバッチのバッチIDとバッチ引数を指定します。

サンプルアプリケーション「カテゴリー別売上金額集計バッチ」は「 example.summarizeSales 」というバッチIDを持っています。 また、このバッチは引数に処理対象の売上日時( date )を指定し、この値に基づいて処理対象CSVファイルを特定します。

Sparkを利用するバッチアプリケーションは、Spark向けのバッチアプリケーションはバッチIDの接頭辞に spark. を付与して実行します。

$ASAKUSA_HOME/yaess/bin/yaess-batch.sh spark.example.summarizeSales -A date=2011-04-01

バッチの実行が成功すると、コマンドの標準出力の最終行に Finished: SUCCESS と出力されます。

...
2016/03/17 03:56:24 INFO  [YS-CORE-I01999] Finishing batch "spark.example.summarizeSales": batchId=spark.example.summarizeSales, elapsed=51,738ms
2016/03/17 03:56:24 INFO  [YS-BOOTSTRAP-I00999] Exiting YAESS: code=0, elapsed=51,790ms
Finished: SUCCESS

サンプルアプリケーション実行結果の確認

Asakusa FrameworkはDirect I/Oの入出力ディレクトリやファイルの一覧をリストアップするコマンド $ASAKUSA_HOME/directio/bin/list-file.sh を提供しています。 このコマンドを利用して、サンプルアプリケーションの出力結果を確認します。

ここでは、サンプルアプリケーションの出力結果ディレクトリ result 以下のすべてのファイルを、サブディレクトリ含めてリストするようコマンドを実行してみます。

$ASAKUSA_HOME/directio/bin/list-file.sh result "**/*"

上記のコマンドを実行すると、以下のような結果が表示されます。

Starting List Direct I/O Files:
...
hdfs://<host:port>/user/asakusa/target/testing/directio/result/category
hdfs://<host:port>/user/asakusa/target/testing/directio/result/error
hdfs://<host:port>/user/asakusa/target/testing/directio/result/category/result.csv
hdfs://<host:port>/user/asakusa/target/testing/directio/result/error/2011-04-01.csv

出力ファイルの一覧に対して、 hadoop fs -text コマンドを利用してファイル内容を確認します。

以下は 売上データの集計ファイル category/result.csv を表示する例です。

hadoop fs -text hdfs://<host:port>/user/asakusa/target/testing/directio/result/category/result.csv

指定したファイルの内容が表示されます。 売上データが商品マスタのカテゴリコード単位で集計され、売上合計の降順で整列されたCSVが出力されています。

category/result.csv
カテゴリコード,販売数量,売上合計
1600,28,5400
1300,12,1596
1401,15,1470

また、このバッチでは処理の中で不正なレコードをチェックして、該当したエラーレコードをまとめてファイル error/2011-04-01.csv に出力します。

hadoop fs -text hdfs://<host:port>/user/asakusa/target/testing/directio/result/error/2011-04-01.csv

エラーチェックに該当したレコードの一覧は以下のように出力されます。

error/2011-04-01.csv
ファイル名,日時,店舗コード,商品コード,メッセージ
hdfs://<host:port>/user/asakusa/target/testing/directio/sales/2011-04-01.csv,2011-04-01 19:00:00,9999,4922010001000,店舗不明
hdfs://<host:port>/user/asakusa/target/testing/directio/sales/2011-04-01.csv,2011-04-01 10:00:00,0001,9999999999999,商品不明
hdfs://<host:port>/user/asakusa/target/testing/directio/sales/2011-04-01.csv,1990-01-01 10:40:00,0001,4922010001000,商品不明