配置作业

有多种 Job 接口的实现。但是，这些实现隐藏在提供的构建器（用于 Java 配置）或 XML 命名空间（用于基于 XML 的配置）之后。以下示例显示了 Java 和 XML 配置

  • Java

  • XML

@Bean
public Job footballJob(JobRepository jobRepository) {
    return new JobBuilder("footballJob", jobRepository)
                     .start(playerLoad())
                     .next(gameLoad())
                     .next(playerSummarization())
                     .build();
}

一个 Job（以及通常其中的任何 Step）需要一个 JobRepository。JobRepository 的配置通过 Java 配置 处理。

前面的示例说明了一个由三个 Step 实例组成的 Job。与作业相关的构建器还可以包含其他元素，这些元素有助于并行化（Split）、声明式流程控制（Decision）和流程定义的外部化（Flow）。

有多种 Job 接口的实现。但是，命名空间隐藏了配置中的差异。它只有三个必需的依赖项：名称、JobRepository 和 Step 实例列表。以下示例创建一个 footballJob

<job id="footballJob">
    <step id="playerload"          parent="s1" next="gameLoad"/>
    <step id="gameLoad"            parent="s2" next="playerSummarization"/>
    <step id="playerSummarization" parent="s3"/>
</job>

前面的示例使用父 Bean 定义来创建步骤。有关在内联声明特定步骤详细信息时更多选项，请参阅关于 步骤配置 的部分。XML 命名空间默认为引用 id 为 jobRepository 的存储库，这是一个合理的默认值。但是，您可以显式覆盖此默认值

<job id="footballJob" job-repository="specialRepository">
    <step id="playerload"          parent="s1" next="gameLoad"/>
    <step id="gameLoad"            parent="s3" next="playerSummarization"/>
    <step id="playerSummarization" parent="s3"/>
</job>

除了步骤之外，作业配置还可以包含其他元素，这些元素有助于并行化（<split>）、声明式流程控制（<decision>）和流程定义的外部化（<flow/>）。

可重启性

执行批处理作业时一个关键问题涉及到 Job 在重新启动时的行为。如果对于特定的 JobInstance 已经存在 JobExecution，则启动 Job 被认为是“重新启动”。理想情况下，所有作业都应该能够从中断的地方开始，但有些情况下这是不可能的。在这种情况下，完全由开发人员确保创建一个新的 JobInstance。但是，Spring Batch 确实提供了一些帮助。如果 Job 永远不应该重新启动，而应该始终作为新 JobInstance 的一部分运行，则可以将 restartable 属性设置为 false。

  • Java

  • XML

以下示例显示了如何在 Java 中将 restartable 字段设置为 false

Java 配置
@Bean
public Job footballJob(JobRepository jobRepository) {
    return new JobBuilder("footballJob", jobRepository)
                     .preventRestart()
                     ...
                     .build();
}

以下示例显示了如何在 XML 中将 restartable 字段设置为 false

XML 配置
<job id="footballJob" restartable="false">
    ...
</job>

换句话说，将 restartable 设置为 false 表示“此 Job 不支持再次启动”。重新启动不可重启的 Job 会导致抛出 JobRestartException。以下 Junit 代码会导致抛出异常

Job job = new SimpleJob();
job.setRestartable(false);

JobParameters jobParameters = new JobParameters();

JobExecution firstExecution = jobRepository.createJobExecution(job, jobParameters);
jobRepository.saveOrUpdate(firstExecution);

try {
    jobRepository.createJobExecution(job, jobParameters);
    fail();
}
catch (JobRestartException e) {
    // expected
}

第一次尝试为不可重启的作业创建 JobExecution 不会出现问题。但是，第二次尝试会抛出 JobRestartException。

拦截作业执行

在 Job 执行过程中，在生命周期的各个事件中获得通知以便运行自定义代码可能很有用。SimpleJob 通过在适当的时间调用 JobListener 来实现这一点

public interface JobExecutionListener {

    void beforeJob(JobExecution jobExecution);

    void afterJob(JobExecution jobExecution);
}

您可以通过在作业上设置监听器将 JobListeners 添加到 SimpleJob 中。

  • Java

  • XML

以下示例显示了如何将监听器方法添加到 Java 作业定义中

Java 配置
@Bean
public Job footballJob(JobRepository jobRepository) {
    return new JobBuilder("footballJob", jobRepository)
                     .listener(sampleListener())
                     ...
                     .build();
}

以下示例显示了如何将监听器元素添加到 XML 作业定义中

XML 配置
<job id="footballJob">
    <step id="playerload"          parent="s1" next="gameLoad"/>
    <step id="gameLoad"            parent="s2" next="playerSummarization"/>
    <step id="playerSummarization" parent="s3"/>
    <listeners>
        <listener ref="sampleListener"/>
    </listeners>
</job>

请注意，无论 Job 成功还是失败，都会调用 afterJob 方法。如果需要确定成功或失败，可以从 JobExecution 中获取该信息

public void afterJob(JobExecution jobExecution){
    if (jobExecution.getStatus() == BatchStatus.COMPLETED ) {
        //job success
    }
    else if (jobExecution.getStatus() == BatchStatus.FAILED) {
        //job failure
    }
}

与此接口相对应的注释是

  • @BeforeJob

  • @AfterJob

从父作业继承

如果一组作业共享类似但并不完全相同的配置，则定义一个“父”Job 可能会有所帮助，具体 Job 实例可以从中继承属性。类似于 Java 中的类继承，“子”Job 将其元素和属性与父元素的元素和属性组合在一起。

在以下示例中，baseJob 是一个抽象的 Job 定义，它仅定义了一个监听器列表。Job（job1）是一个具体的定义，它继承了 baseJob 的监听器列表，并将其与自己的监听器列表合并，从而生成一个包含两个监听器和一个 Step（step1）的 Job。

<job id="baseJob" abstract="true">
    <listeners>
        <listener ref="listenerOne"/>
    <listeners>
</job>

<job id="job1" parent="baseJob">
    <step id="step1" parent="standaloneStep"/>

    <listeners merge="true">
        <listener ref="listenerTwo"/>
    <listeners>
</job>

有关详细信息，请参阅关于 从父步骤继承 的部分。

JobParametersValidator

在 XML 命名空间中声明或使用 AbstractJob 的任何子类声明的作业可以选择在运行时为作业参数声明一个验证器。例如，当您需要断言作业已启动并包含所有必需参数时，这非常有用。您可以使用 DefaultJobParametersValidator 来约束简单必需参数和可选参数的组合。对于更复杂的约束，您可以自己实现接口。

  • Java

  • XML

验证器的配置通过 Java 生成器支持

@Bean
public Job job1(JobRepository jobRepository) {
    return new JobBuilder("job1", jobRepository)
                     .validator(parametersValidator())
                     ...
                     .build();
}

验证器的配置通过 XML 命名空间支持，作为作业的子元素，如下例所示

<job id="job1" parent="baseJob3">
    <step id="step1" parent="standaloneStep"/>
    <validator ref="parametersValidator"/>
</job>

您可以将验证器指定为引用（如前所述）或作为 beans 命名空间中的嵌套 Bean 定义。