アーキテクチャ概要¶

バッチアプリケーションの構成
バッチの種類
バッチアプリケーションの処理の流れ
バッチアプリケーションで使用するリスナー
最小のリスナー構成
リスナーの指定方法

バッチアプリケーションの構成 ¶

Jakarta Batch(外部サイト、英語) に準拠したバッチアプリケーションを実行するためには、 Jakarta Batch(外部サイト、英語) の実装が必要となる。実装は、主に以下の2つから選択することになるが、ドキュメントが豊富であること及びMaven Centralからライブラリを取得出来る手軽さから jBeret(外部サイト、英語) の使用を推奨する。

以下に構成を示す。

../../../../_images/jsr352-configuration-diagram.png

重要

JobContext及びStepContextの一時領域( TransientUserData )を使用することはグローバル領域に値を保持することと同義となるため、アプリケーション側で使用してはならない。

なお、StepContextの一時領域については、 StepScoped でステップ内で値を共有をするために使用しているため、アプリケーション側ではStepContextの一時領域は使用できない。

補足

Jakarta Batchに準拠したバッチアプリケーションのアーキテクチャは、Jakarta Batch(外部サイト、英語)で定められた構成に準拠しているため、Nablarchアプリケーションフレームワークのアーキテクチャに記載されているような、ハンドラを用いたアーキテクチャとは異なっている。

Jakarta Batchに準拠したバッチアプリケーションでは、ハンドラで行われるような横断的な処理（ログ出力やトランザクション制御等）は、 Jakarta Batch(外部サイト、英語)で規定されているリスナーを用いることで実現されている。

ただし、リスナーは既定のタイミングで起動されるものであり、入力、出力に対して直接処理を行うものではない点がハンドラとは異なっている。このためリスナーでは、ハンドラで実現されているような入力値のフィルタ処理や変換処理などを行うことはできない。

バッチの種類 ¶

Jakarta Batch(外部サイト、英語) では、バッチの実装方法として Batchlet と Chunk の2種類の方法がある。どちらのタイプを使用するのが適切かは、以下を参照しバッチごとに判断すること。

Batchlet

タスク指向の場合にBatchletタイプのバッチを実装する。

例えば、外部システムからのファイル取得や、SQL1つで処理が完結するような処理が該当する。

Chunk: ファイルやデータベースなどの入力データソースからレコードを読み込み業務処理を実行する場合にChunkタイプのバッチを実装する。

バッチアプリケーションの処理の流れ ¶

Batchlet ¶

Batchletタイプのバッチアプリケーションの処理の流れを以下に示す。

Jakarta BatchのBatch RuntimeからBatchletステップ実行前のコールバック処理として NablarchStepListenerExecutor が呼び出される。
Batchletステップ実行前のリスナーを順次実行する。
Jakarta BatchのBatch Runtimeから Batchlet が実行される。
Batchlet では業務ロジックを実行する。(Batchletの責務配置は、 Batchletの責務配置を参照)
Jakarta BatchのBatch RuntimeからBatchletステップ実行後のコールバック処理として NablarchStepListenerExecutor が呼び出される。
Batchletステップ実行後のリスナーを順次実行する。(No2とは逆順に実行する)

Chunk ¶

Chunkタイプのバッチアプリケーションの処理の流れを以下に示す。

Jakarta BatchのBatch RuntimeからChunkステップ実行前のコールバック処理として NablarchStepListenerExecutor が呼び出される。
Chunkステップ実行前のリスナーを順次実行する。
Jakarta BatchのBatch RuntimeからChunkステップの ItemReader が実行される。
ItemReader では、入力データソースからデータを読み込む。
Jakarta BatchのBatch RuntimeからChunkステップの ItemProcessor が実行される。
ItemProcessor は、 Form や Entity を使って業務ロジックを実行する。
※データーベースに対するデータの書き込みや更新はここでは実施しない。
Jakarta BatchのBatch Runtimeから ItemWriter 実行前のコールバック処理として NablarchItemWriteListenerExecutor が呼び出される。
ItemWriter 実行前のリスナーを順次実行する。
Jakarta BatchのBatch RuntimeからChunkステップの ItemWriter が実行される。
ItemWriter では、テーブルへの登録(更新、削除)やファイル出力処理などの結果反映処理を行う。
Jakarta BatchのBatch Runtimeから ItemWriter 実行後のコールバック処理として NablarchItemWriteListenerExecutor が呼び出される。
ItemWriter 実行後のリスナーを順次実行する。(No7とは逆順で実行する)
Jakarta BatchのBatch RuntimeからChunkステップ実行後のコールバック処理として NablarchStepListenerExecutor が呼び出される。
Chunkステップ実行後のリスナーを順次実行する。(No2とは逆順に実行する)

※No3からNo10は、入力データソースのデータが終わるまで繰り返し実行される。

Chunkステップの責務配置については、 Chunkの責務配置を参照

例外(エラー含む)発生時の処理の流れ ¶

バッチ実行中に例外が発生した場合、Nablarchでは例外の捕捉は行わずJakarta Batchの実装側で例外ハンドリングを行う方針としている。これは、Jakarta Batchに準拠したバッチアプリケーション特有の振る舞いであり、他の基盤( Webアプリケーションや Nablarchバッチアプリケーションなど)とは異なる振る舞いである点に注意すること。

補足

Jakarta Batchに準拠したバッチアプリケーションがこのようなアーキテクチャを採用した理由は以下の通り。

Jakarta Batchに準拠したバッチアプリケーションは、Jakarta Batch上でNablarchを使用するためのコンポーネントのみの提供であり、実行制御自体はJakarta Batch実装によって行われる。このため、Nablarchにより全ての例外を捕捉し処理を行うことは不可能であり、例外制御がNablarchとJakarta Batchで分散することで設計などが複雑化するのを防ぐためこのような方針としている。

例外発生時のバッチの状態 ¶

上述したように、例外発生時の制御は全てJakarta Batchの実装が行う。このため、例外発生時のバッチの状態(batch statusやexit status)については、 Jakarta Batch(外部サイト、英語) の仕様を参照すること。また、例外の種類に応じたリトライや継続有無などもジョブ定義に従った動作となる。ジョブ定義の詳細は、 Jakarta Batch(外部サイト、英語) の仕様を参照すること。

例外発生後のJavaプロセスから戻されるリターンコードについては、障害監視を参照。

ログ出力 ¶

Jakarta Batchの実装で補足された例外の情報は、Jakarta Batchの実装によりログ出力される。ログの設定(フォーマットや出力先などの設定)は、Jakarta Batch実装が使用しているロギングフレームワークのマニュアルなどを参照して行うこと。

なお、アプリケーションで明示的に出力するエラーログ等をJakarta Batchと同じログファイルに出力したい場合には、 logアダプタを使用してJakarta Batchの実装とロギングフレームワークを統一することで対応できる。

バッチアプリケーションで使用するリスナー ¶

Jakarta Batch(外部サイト、英語) に準拠したバッチアプリケーションでは、 Jakarta Batch(外部サイト、英語) の仕様で定められているリスナーを使用してNablarchのハンドラ相当のことを実現する。

標準では、以下のリスナーを提供してる。

ジョブレベルリスナー

ジョブの起動及び終了直前にコールバックされるリスナー

ステップレベルリスナー

ステップの実行前及び実行後にコールバックされるリスナー

ItemWriterレベルのリスナー

ItemWriter の実行前及び実行後にコールバックされるリスナー

Chunkの進捗ログを出力するリスナー(非推奨) (進捗ログで出力される内容を使用して進捗ログを出力すること)
トランザクションを制御するリスナー

補足

Jakarta Batch(外部サイト、英語) で規定されているリスナーは、複数設定した場合の実行順を保証しないことが仕様上明記されている。このため、Nablarchでは以下の点に対応することで、リスナーを指定した順で実行出来るよう対応している。

各レベルのリスナーには、リスナーの実行順を保証するリスナーのみを設定する
リスナーの実行順を保証するリスナーは、システムリポジトリからリスナーリストを取得し、定義順にリスナーを実行する。

実際のリスナーの定義方法は、リスナーの指定方法を参照。

最小のリスナー構成 ¶

最小のリスナー構成を以下に示す。この構成でプロジェクト要件を満たすことができない場合は、リスナーの追加などにより対応すること。

ジョブレベルの最小リスナー構成¶
No.	リスナー	ジョブ起動直前の処理	ジョブ終了直前の処理
1	ジョブの起動、終了ログを出力するリスナー	起動するジョブ名をログに出力する。	ジョブ名称とバッチステータスをログに出力する。

ステップレベルの最小リスナー構成¶
No.	リスナー	ステップ実行前の処理	ステップ実行後の処理
1	ステップの開始、終了ログを出力するリスナー	実行するステップ名称をログに出力する。	ステップ名称とステップステータスをログに出力する。
2	データベースへ接続するリスナー	DB接続を取得する。	DB接続を解放する。
3	トランザクションを制御するリスナー	トランザクションを開始する。	トランザクションを終了(commit or rollback)する。

ItemWriter レベルの最小リスナー構成¶
No.	リスナー	ItemWriter 実行前の処理	ItemWriter 実行後の処理
1	トランザクションを制御するリスナー [1]		トランザクションを終了(commit or rollback)する。

[1]	ItemWriter レベルのリスナーで行うトランザクション制御は、ステップレベルで開始されたトランザクションに対して行う。

リスナーの指定方法 ¶

各レベルに対してリスナーリストを定義する方法について説明する。

リスナーリストを定義するには、以下の手順が必要になる。

Jakarta Batch(外部サイト、英語) で規定されているジョブ定義を表すxmlファイルに、リスナーの実行順を保証するリスナーを設定する。
コンポーネント設定ファイルにリスナーリストの設定をする。

ジョブ定義ファイルへの設定

<job id="chunk-integration-test" xmlns="https://jakarta.ee/xml/ns/jakartaee" version="2.0">
  <listeners>
    <!-- ジョブレベルのリスナー -->
    <listener ref="nablarchJobListenerExecutor" />
  </listeners>

  <step id="myStep">
    <listeners>
      <!-- ステップレベルのリスナー -->
      <listener ref="nablarchStepListenerExecutor" />
      <!-- ItemWriterレベルのリスナー -->
      <listener ref="nablarchItemWriteListenerExecutor" />
    </listeners>

    <chunk item-count="10">
      <reader ref="stringReader">
        <properties>
          <property name="max" value="25" />
        </properties>
      </reader>
      <processor ref="createEntityProcessor" />
      <writer ref="batchOutputWriter" />
    </chunk>
  </step>
</job>

コンポーネント設定ファイルへの設定

<!-- デフォルトのジョブレベルのリスナーリスト -->
<list name="jobListeners">
  <component class="nablarch.fw.batch.ee.listener.job.JobProgressLogListener" />
  <component class="nablarch.fw.batch.ee.listener.job.DuplicateJobRunningCheckListener">
    <property name="duplicateProcessChecker" ref="duplicateProcessChecker" />
  </component>
</list>

<!-- デフォルトのステップレベルのリスナーリスト -->
<list name="stepListeners">
  <component class="nablarch.fw.batch.ee.listener.step.StepProgressLogListener" />
  <component class="nablarch.fw.batch.ee.listener.step.DbConnectionManagementListener">
    <property name="dbConnectionManagementHandler">
      <component class="nablarch.common.handler.DbConnectionManagementHandler" />
    </property>
  </component>
  <component class="nablarch.fw.batch.ee.listener.step.StepTransactionManagementListener" />
</list>

<!-- デフォルトのItemWriterレベルのリスナーリスト -->
<list name="itemWriteListeners">
  <component
      class="nablarch.fw.batch.ee.listener.chunk.ChunkProgressLogListener" />
  <component
      class="nablarch.fw.batch.ee.listener.chunk.ItemWriteTransactionManagementListener" />
</list>

<!-- デフォルトのジョブレベルのリスナーリストの上書き -->
<list name="sample-job.jobListeners">
  <component class="nablarch.fw.batch.ee.listener.job.JobProgressLogListener" />
</list>

<!-- デフォルトのステップレベルのリスナーリストの上書き -->
<!-- 本設定は「sample-step」ステップの実行時に適用される -->
<list name="sample-job.sample-step.stepListeners">
  <component class="nablarch.fw.batch.ee.listener.step.StepProgressLogListener" />
</list>

ポイント

デフォルトのジョブレベルのリスナーリストのコンポーネント名は、 jobListeners とする。
デフォルトのステップレベルのリスナーリストのコンポーネント名は、 stepListeners とする。
デフォルトのItemWriterレベルのリスナーリストのコンポーネント名は、 itemWriteListeners とする。
デフォルトのリスナーリスト定義を上書きする場合は、コンポーネント名を「ジョブ名称 + ”.” + 上書き対象のコンポーネント名」とする。
例えば、「sample-job」でジョブレベルの定義を上書きする場合は、コンポーネント名を sample-job.jobListeners としてリスナーリストを定義する。
特定のステップでデフォルトのリスナーリスト定義を上書きする場合は、コンポーネント名を「ジョブ名称 + ”.” + ステップ名称 + ”.” + 上書き対象のコンポーネント名」とする。
例えば、「sample-job」で定義されている「sample-step」で、デフォルトのステップレベルのリスナーリスト定義を上書きする場合は、コンポーネント名を sample-job.sample-step.stepListeners としてリスナーリストを定義する。
特定のステップで上書き出来るリスナーリストは、ステップレベルとItemWriterレベルのリスナーリストのみである。