クラス JobOperatorTestUtils

java.lang.ObjectSE
org.springframework.batch.test.JobLauncherTestUtils
org.springframework.batch.test.JobOperatorTestUtils
public class JobOperatorTestUtils extends JobLauncherTestUtils

バッチジョブをテストするためのユーティリティクラスです。AbstractJob 全体を開始するメソッドを提供し、ジョブ内のすべてのステップを実行することなく、個々のステップのエンドツーエンドテストを可能にします。このユーティリティを使用するテストクラスは、Spring Test フレームワークの一部として ApplicationContext にインスタンスを設定できます。テストコンテキストには、バッチインフラストラクチャ Bean（JobRepository と JobOperator）とテスト対象ジョブが含まれている必要があります。テスト対象ジョブはこのユーティリティに自動的に接続されます。

このクラスは、SimpleJob、FlowJob から Step を個別に実行する機能も提供します。Job 内で Step を単独で起動することで、ジョブ内のすべてのステップを実行することなく、個々のステップのエンドツーエンドテストを実行できます。

シグネチャーに JobParameters を含まないメソッドを使用すると、long 型の乱数を batch.random という名前でパラメーターとして持つメソッドが作成されることに注意してください。これにより、パラメーターが指定されていない場合でも、メソッドを再開できるようになります。

導入:
6.0
作成者:
Mahmoud Ben Hassine

  • フィールドの詳細

    • JOB_NAME

      public static final StringSE JOB_NAME
      個別にテストした場合のステップを囲むシングルステップジョブの名前
      関連事項:

    • jobOperator

      protected JobOperator jobOperator

  • コンストラクターの詳細

    • JobOperatorTestUtils

      public JobOperatorTestUtils(JobOperator jobOperator, JobRepository jobRepository)
      提供されたジョブリポジトリとジョブオペレーターを使用して、JobOperatorTestUtils の新しいインスタンスを作成します。
      パラメーター:
      jobOperator - ジョブとステップを開始するために使用する
      jobRepository - ジョブメタデータにアクセスするために使用する

  • メソッドの詳細

    • setJob

      public void setJob(Job job)
      このユーティリティで操作できるジョブを設定します。
      オーバーライド:
      クラス JobLauncherTestUtils の setJob 
      パラメーター:
      job - テストするジョブ

    • getJob

      public Job getJob()
      このユーティリティで操作できるジョブを取得します。
      オーバーライド:
      クラス JobLauncherTestUtils の getJob 
      戻り値:
      テスト対象のジョブ

    • setJobOperator

      public void setJobOperator(JobOperator jobOperator)
      このユーティリティで使用するジョブオペレータを設定します。
      パラメーター:
      jobOperator - ジョブとステップを開始するために使用するジョブ演算子

    • getJobOperator

      public JobOperator getJobOperator()
      このユーティリティで使用されるジョブオペレータを取得します。
      戻り値:
      ジョブオペレーター

    • setJobRepository

      public void setJobRepository(JobRepository jobRepository)
      このユーティリティで使用するジョブリポジトリを設定します。
      オーバーライド:
      クラス JobLauncherTestUtils の setJobRepository 
      パラメーター:
      jobRepository - ジョブメタデータにアクセスするために使用するジョブリポジトリ

    • getJobRepository

      public JobRepository getJobRepository()
      このユーティリティで使用されるジョブリポジトリを取得します。
      オーバーライド:
      クラス JobLauncherTestUtils の getJobRepository 
      戻り値:
      ジョブリポジトリ

    • startJob

      public JobExecution startJob() throws ExceptionSE
      一意のランダムジョブパラメーターのセットを使用して、すべてのステップを含むジョブ全体を開始します。
      戻り値:
      JobExecution。これにより、テストで終了ステータスを検証できます。
      例外:
      ExceptionSE - ジョブの起動中にエラーが発生した場合にスローされます。

    • startJob

      public JobExecution startJob(JobParameters jobParameters) throws ExceptionSE
      提供されたジョブパラメーターセットを使用して、すべてのステップを含むジョブ全体を開始します。
      パラメーター:
      jobParameters - JobParameters のインスタンス。
      戻り値:
      JobExecution。これにより、テストで終了ステータスを検証できます。
      例外:
      ExceptionSE - ジョブの起動中にエラーが発生した場合にスローされます。

    • startStep

      public JobExecution startStep(StringSE stepName)
      指定されたステップのみを、SimpleJob 型の単一ステップジョブ JOB_NAME 内で開始します。JobParameters の一意の集合が自動的に生成されます。指定された名前のステップが存在しない場合は、IllegalStateException がスローされます。
      パラメーター:
      stepName - 起動するステップの名前
      戻り値:
      JobExecution

    • startStep

      public JobExecution startStep(StringSE stepName, JobParameters jobParameters, ExecutionContext jobExecutionContext)
      挿入されたジョブからステップを抽出し、それを囲む SimpleJob 型のシングルステップジョブ JOB_NAME で開始します。指定された名前のステップが存在しない場合は、IllegalStateException がスローされます。
      パラメーター:
      stepName - 開始するステップの名前
      jobParameters - スタート時に使用する JobParameters
      jobExecutionContext - ステップを開始する前にジョブ ExecutionContext に値がロードされる ExecutionContext。
      戻り値:
      JobExecution

    • startStep

      public JobExecution startStep(Step step)
      指定されたステップのみを、SimpleJob 型の単一ステップジョブ StepRunner.JOB_NAME 内で、一意のジョブパラメーターセットを使用して開始します。指定された名前のステップが存在しない場合は、IllegalStateException がスローされます。
      パラメーター:
      step - 始めるためのステップ
      戻り値:
      JobExecution

    • startStep

      public JobExecution startStep(Step step, JobParameters jobParameters, ExecutionContext jobExecutionContext)
      SimpleJob 型の単一ステップジョブ StepRunner.JOB_NAME 内の指定されたステップのみを開始します。指定された名前のステップが存在しない場合は、IllegalStateException がスローされます。
      パラメーター:
      step - 始めるためのステップ
      jobParameters - スタート時に使用する JobParameters
      jobExecutionContext - ステップを開始する前にジョブ ExecutionContext に値がロードされる ExecutionContext。
      戻り値:
      JobExecution

    • getUniqueJobParameters

      public JobParameters getUniqueJobParameters()
      オーバーライド:
      クラス JobLauncherTestUtils の getUniqueJobParameters 
      戻り値:
      ジョブインスタンスが一意になることを保証するために、型 long の乱数を持つ batch.random という名前の 1 つのパラメーターのみを含む新しい JobParameters オブジェクト。

    • getUniqueJobParametersBuilder

      public JobParametersBuilder getUniqueJobParametersBuilder()
      オーバーライド:
      クラス JobLauncherTestUtils の getUniqueJobParametersBuilder 
      戻り値:
      ジョブインスタンスが一意になることを保証するために、型 long の乱数を持つ batch.random という名前の 1 つのパラメーターのみを含む新しい JobParametersBuilder オブジェクト。

Copyright © 2026 Spring. All rights reserved.