Jakarta Batchに準拠したバッチプロジェクトの初期セットアップ¶

Jakarta Batchに準拠したバッチプロジェクトの初期セットアップでは以下を行う。

Jakarta Batchに準拠したバッチプロジェクトの生成
Jakarta Batchに準拠したバッチプロジェクトの動作確認

生成するプロジェクトの概要¶

本手順で生成するプロジェクトの概要は以下の通りである。

項目	説明
プロジェクト種別	Mavenプロジェクト
プロジェクト構成	単一プロジェクト構成
使用DB	H2 Database Engine(アプリケーションに組み込み)
生成するプロジェクトに含まれるもの	生成されたプロジェクトには以下が含まれる。 Jakarta Batchに準拠したバッチアプリケーション用の基本的な設定 batchlet方式による疎通確認用バッチアプリケーション chunk方式による疎通確認用バッチアプリケーション Mavenと連動して動作するツールの初期設定( nablarch-archetype-parent(親プロジェクト) を参照することによって取り込んでいる)。

他のプロジェクトとの関係、及びディレクトリ構成は、 Mavenアーキタイプの構成 を参照。

ブランクプロジェクト作成¶

Nablarchが提供するアーキタイプを使用してブランクプロジェクトを生成する。

mvnコマンドの実行¶

Maven Archetype Plugin(外部サイト、英語) を使用して、ブランクプロジェクトを生成する。

カレントディレクトリを、ブランクプロジェクトを作成したいディレクトリ(任意のディレクトリで可)に変更する。

その後、以下のコマンドを実行する。

mvn archetype:generate -DarchetypeGroupId=com.nablarch.archetype -DarchetypeArtifactId=nablarch-batch-ee-archetype -DarchetypeVersion=6u3

上記コマンドで使用されているNablarchのバージョンは 6u3 となっている。バージョンを変更したい場合は、以下のパラメータを変更すること。

設定値	説明
archetypeVersion	使用したいアーキタイプのバージョンを指定する。（Nablarch 6u2以降を指定すること）

プロジェクト情報の入力¶

上記コマンドを実行すると、以下の項目について入力を求められるので、生成されるブランクプロジェクトに関する情報を入力する。

入力項目	説明	設定例
groupId	グループID（通常はパッケージ名を入力）	`com.example`
artifactId	アーティファクトID	`myapp-batch-ee`
version	バージョン番号	`0.1.0`
package	パッケージ(通常はグループIDと同じ)	`com.example`

重要

項目groupIdおよびpackageは、Javaのパッケージ名にマッピングされる。よって、これらの入力値には、英小文字、数字、ドットを使用し、ハイフンは使用しないこと。

プロジェクト情報の入力が終わると、Y: :と表示される。

入力した内容をもとに、ひな形を生成する場合には「Y」を入力してください。

プロジェクト情報の入力をやり直したい場合には「N」を入力してください。

コマンドが正常終了した場合、ブランクプロジェクトがカレントディレクトリ配下に作成される。

疎通確認¶

自動テスト¶

アーキタイプから生成したプロジェクトには、以下のユニットテストが含まれている。

ユニットテストのクラス	テスト内容
SampleBatchletTest	データベース接続を伴うクラスのJUnitテスト。

ユニットテストを実行することで、ブランクプロジェクトの生成に成功していることを確認する。

以下のコマンドを実行する。

cd myapp-batch-ee
mvn test

実行に成功すると、以下のようなログがコンソールに出力される。

(中略)
[INFO] ---------------------< com.example:myapp-batch-ee >---------------------
[INFO] Building myapp-batch-ee 0.1.0
[INFO] --------------------------------[ jar ]---------------------------------
(中略)
[INFO] Results:
[INFO]
[INFO] Tests run: 1, Failures: 0, Errors: 0, Skipped: 0
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
(以下略)

起動テスト¶

生成したプロジェクトには、以下のバッチアプリケーションが組み込まれている。

ジョブID	内容
sample-chunk	chunk方式で実装されたサンプルアプリケーション。
sample-batchlet	batchlet方式で実装されたサンプルアプリケーション。

上記2つのバッチアプリケーションの動作確認を行うことで、ブランクプロジェクトの生成に成功していることを確認する。

バッチアプリケーションのビルド¶

まだ、生成したプロジェクトにカレントディレクトリを移動していない場合は移動する。

cd myapp-batch-ee

以下のコマンドを実行することで、バッチアプリケーションのビルドを行う。

mvn package

chunk方式のバッチアプリケーションの起動¶

chunk方式のバッチアプリケーションでは、SAMPLE_USERテーブルからデータを取り出し、編集してCSVファイルに出力する処理が実装されている。

以下のコマンドを実行する。

mvn exec:java -Dexec.mainClass=nablarch.fw.batch.ee.Main -Dexec.args="'sample-chunk'"

起動に成功すると、以下のようなログが ./progress.log に出力される。

2020-04-28 10:39:46.955 -INFO- progress [null] boot_proc = [] proc_sys = [batch-ee] req_id = [null] usr_id = [null] start job. job name: [sample-chunk]
2020-04-28 10:39:46.974 -INFO- progress [null] boot_proc = [] proc_sys = [batch-ee] req_id = [null] usr_id = [null] start step. job name: [sample-chunk] step name: [step1]
2020-04-28 10:39:47.202 -INFO- progress [null] boot_proc = [] proc_sys = [batch-ee] req_id = [null] usr_id = [null] job name: [sample-chunk] step name: [step1] input count: [10]
2020-04-28 10:39:47.235 -INFO- progress [null] boot_proc = [] proc_sys = [batch-ee] req_id = [null] usr_id = [null] job name: [sample-chunk] step name: [step1] total tps: [156.25] current tps: [156.25] estimated end time: [2020/04/28 10:39:47.235] remaining count: [5]
2020-04-28 10:39:47.244 -INFO- progress [null] boot_proc = [] proc_sys = [batch-ee] req_id = [null] usr_id = [null] job name: [sample-chunk] step name: [step1] total tps: [243.90] current tps: [625.00] estimated end time: [2020/04/28 10:39:47.243] remaining count: [0]
2020-04-28 10:39:47.257 -INFO- progress [null] boot_proc = [] proc_sys = [batch-ee] req_id = [null] usr_id = [null] finish step. job name: [sample-chunk] step name: [step1] step status: [COMPLETED]
2020-04-28 10:39:47.263 -INFO- progress [null] boot_proc = [] proc_sys = [batch-ee] req_id = [null] usr_id = [null] finish job. job name: [sample-chunk]

また、testdata/output/outputdata.csvに以下のデータが出力される。

ユーザID,氏名
1,名部楽 一郎
2,名部楽 二郎
3,名部楽 三郎
4,名部楽 四朗
5,名部楽 五郎
6,名部楽 六郎
7,名部楽 七郎
8,名部楽 八郎
9,名部楽 九郎
10,名部楽 十郎

補足

testdata/output/outputdata.csvはUTF-8で出力される。 testdata/output/outputdata.csvの内容を確認する際、Excelで開くと化けて表示されるため、テキストエディタで開くこと。

batchlet方式のバッチアプリケーションの起動¶

batchlet方式のバッチアプリケーションでは、SAMPLE_USERテーブルのデータを削除する処理が実装されている。

以下のコマンドを実行する。

mvn exec:java -Dexec.mainClass=nablarch.fw.batch.ee.Main -Dexec.args="'sample-batchlet'"

実行に成功すると、以下のようなログが ./progress.log に出力される。

2020-04-28 10:35:27.002 -INFO- progress [null] boot_proc = [] proc_sys = [batch-ee] req_id = [null] usr_id = [null] start job. job name: [sample-batchlet]
2020-04-28 10:35:27.011 -INFO- progress [null] boot_proc = [] proc_sys = [batch-ee] req_id = [null] usr_id = [null] start step. job name: [sample-batchlet] step name: [step1]
2020-04-28 10:35:27.247 -INFO- progress [null] boot_proc = [] proc_sys = [batch-ee] req_id = [null] usr_id = [null] finish step. job name: [sample-batchlet] step name: [step1] step status: [SUCCESS]
2020-04-28 10:35:27.255 -INFO- progress [null] boot_proc = [] proc_sys = [batch-ee] req_id = [null] usr_id = [null] finish job. job name: [sample-batchlet]

補足

このbatchletはSAMPLE_USERテーブルのデータの全件削除を行っている。削除したデータを復元したい場合は、プロジェクトの構成を参考に「SAMPLE.mv.db.org」を「SAMPLE.mv.db」にコピーすること。

疎通確認になぜか失敗する場合¶

原因は分からないが疎通確認に失敗する場合、どこかで手順を誤っている可能性がある。

原因が分からない場合は、ブランクプロジェクト作成からやり直してみること。

データベースに関する設定を行う¶

ブランクプロジェクトは、初期状態ではH2 Database Engineを使用するように設定されている。使用するRDBMSを変更する場合は、使用するRDBMSの変更手順を参照して設定すること。

またER図からのDDL生成や実行、Entityクラスの自動生成を行うにはgsp-dba-maven-pluginの初期設定および実行を行う。詳細は gsp-dba-maven-plugin(DBA作業支援ツール)の初期設定方法を参照。

補足¶

H2のデータの確認方法や、ブランクプロジェクトに組み込まれているツールに関しては、 初期セットアップ手順　補足事項 を参照すること。