配置一个用于重启的Step

在“配置和运行作业”部分中，讨论了重新启动Job。重新启动对步骤有许多影响，因此可能需要一些特定的配置。

设置启动限制

在许多情况下，您可能需要控制Step可以启动的次数。例如，您可能需要配置一个特定的Step，使其只运行一次，因为它会使某些资源失效，这些资源必须在再次运行之前手动修复。这可以在步骤级别进行配置，因为不同的步骤可能具有不同的要求。一个只能执行一次的Step可以作为同一个Job的一部分存在，而另一个Step可以无限次运行。

  • Java

  • XML

以下代码片段显示了在 Java 中配置启动限制的示例

Java 配置
@Bean
public Step step1(JobRepository jobRepository, PlatformTransactionManager transactionManager) {
	return new StepBuilder("step1", jobRepository)
				.<String, String>chunk(10, transactionManager)
				.reader(itemReader())
				.writer(itemWriter())
				.startLimit(1)
				.build();
}

以下代码片段显示了在 XML 中配置启动限制的示例

XML 配置
<step id="step1">
    <tasklet start-limit="1">
        <chunk reader="itemReader" writer="itemWriter" commit-interval="10"/>
    </tasklet>
</step>

前面的示例中显示的步骤只能运行一次。尝试再次运行它会导致抛出StartLimitExceededException异常。请注意，启动限制的默认值为Integer.MAX_VALUE。

重新启动已完成的Step

对于可重启作业，可能存在一个或多个步骤，无论它们第一次是否成功，都应该始终运行。例如，验证步骤或清理资源以进行处理的Step。在重启作业的正常处理过程中，任何状态为COMPLETED（表示已成功完成）的步骤都会被跳过。将allow-start-if-complete设置为true会覆盖此设置，以便该步骤始终运行。

  • Java

  • XML

以下代码片段显示了如何在 Java 中定义可重启作业

Java 配置
@Bean
public Step step1(JobRepository jobRepository, PlatformTransactionManager transactionManager) {
	return new StepBuilder("step1", jobRepository)
				.<String, String>chunk(10, transactionManager)
				.reader(itemReader())
				.writer(itemWriter())
				.allowStartIfComplete(true)
				.build();
}

以下代码片段显示了如何在 XML 中定义可重启作业

XML 配置
<step id="step1">
    <tasklet allow-start-if-complete="true">
        <chunk reader="itemReader" writer="itemWriter" commit-interval="10"/>
    </tasklet>
</step>

Step重启配置示例

  • Java

  • XML

以下 Java 示例显示了如何配置作业以具有可重启的步骤

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

@Bean
public Step playerLoad(JobRepository jobRepository, PlatformTransactionManager transactionManager) {
	return new StepBuilder("playerLoad", jobRepository)
			.<String, String>chunk(10, transactionManager)
			.reader(playerFileItemReader())
			.writer(playerWriter())
			.build();
}

@Bean
public Step gameLoad(JobRepository jobRepository, PlatformTransactionManager transactionManager) {
	return new StepBuilder("gameLoad", jobRepository)
			.allowStartIfComplete(true)
			.<String, String>chunk(10, transactionManager)
			.reader(gameFileItemReader())
			.writer(gameWriter())
			.build();
}

@Bean
public Step playerSummarization(JobRepository jobRepository, PlatformTransactionManager transactionManager) {
	return new StepBuilder("playerSummarization", jobRepository)
			.startLimit(2)
			.<String, String>chunk(10, transactionManager)
			.reader(playerSummarizationSource())
			.writer(summaryWriter())
			.build();
}

以下 XML 示例显示了如何配置作业以具有可重启的步骤

XML 配置
<job id="footballJob" restartable="true">
    <step id="playerload" next="gameLoad">
        <tasklet>
            <chunk reader="playerFileItemReader" writer="playerWriter"
                   commit-interval="10" />
        </tasklet>
    </step>
    <step id="gameLoad" next="playerSummarization">
        <tasklet allow-start-if-complete="true">
            <chunk reader="gameFileItemReader" writer="gameWriter"
                   commit-interval="10"/>
        </tasklet>
    </step>
    <step id="playerSummarization">
        <tasklet start-limit="2">
            <chunk reader="playerSummarizationSource" writer="summaryWriter"
                   commit-interval="10"/>
        </tasklet>
    </step>
</job>

以下示例配置用于加载足球比赛信息并进行汇总的作业。它包含三个步骤：playerLoad、gameLoad 和 playerSummarization。playerLoad 步骤从平面文件中加载球员信息，而 gameLoad 步骤则对比赛执行相同的操作。最后一步 playerSummarization 根据提供的比赛对每个球员的统计数据进行汇总。假设 playerLoad 加载的文件只需要加载一次，但 gameLoad 可以加载特定目录中的所有比赛文件，并在成功加载到数据库后将其删除。因此，playerLoad 步骤没有额外的配置。它可以启动任意次数，如果已完成则跳过。然而，gameLoad 步骤需要在每次运行时执行，以防自上次运行以来添加了额外的文件。它将 allow-start-if-complete 设置为 true 以始终启动。（假设比赛加载到的数据库表上有一个处理指示器，以确保汇总步骤可以正确找到新比赛）。汇总步骤是作业中最重要的一步，配置为启动限制为 2。这很有用，因为如果步骤持续失败，则会向控制作业执行的操作员返回一个新的退出代码，并且在进行手动干预之前，它无法再次启动。

此作业提供本文档的示例，与示例项目中的 footballJob 不同。

本节的其余部分描述了 footballJob 示例的三个运行中的每个运行情况。

运行 1

  1. playerLoad 运行并成功完成，向 PLAYERS 表添加了 400 名球员。

  2. gameLoad 运行并处理了 11 个比赛数据文件，将其内容加载到 GAMES 表中。

  3. playerSummarization 开始处理，并在 5 分钟后失败。

运行 2

  1. playerLoad 不会运行，因为它已经成功完成，并且 allow-start-if-complete 为 false（默认值）。

  2. gameLoad 再次运行并处理了另外 2 个文件，将其内容也加载到 GAMES 表中（带有处理指示器，表明它们尚未处理）。

  3. playerSummarization 开始处理所有剩余的比赛数据（使用处理指示器进行过滤），并在 30 分钟后再次失败。

运行 3

  1. playerLoad 不会运行，因为它已经成功完成，并且 allow-start-if-complete 为 false（默认值）。

  2. gameLoad 再次运行并处理了另外 2 个文件，将其内容也加载到 GAMES 表中（带有处理指示器，表明它们尚未处理）。

  3. playerSummarization 未启动，作业立即被终止，因为这是 playerSummarization 的第三次执行，而其限制只有 2。要么必须提高限制，要么必须将 Job 作为新的 JobInstance 执行。