拦截步骤执行 (Intercepting Step Execution) | Spring Batch5.2.0-M1中文文档|Spring官方文档|SpringBoot 教程|Spring中文网

此版本仍在开发中，尚未被视为稳定版本。对于最新的稳定版本，请使用 Spring Batch 文档 5.1.2！spring-doc.cn

与一样，在执行 a 过程中有许多事件，其中 a 用户可能需要执行某些功能。例如，要写出到平面需要页脚的文件，则需要在有已完成，以便可以写入页脚。这可以通过许多 scoped 侦听器之一来实现。JobStepItemWriterStepStepspring-doc.cn

您可以应用实现（但不是该接口）的扩展之一的任何类本身，因为它是空的）执行到遍历元素的单步执行。该元素在 step、tasklet 或 chunk 声明中有效。我们建议您在其函数适用的级别声明侦听器或者，如果它是多功能的（例如和），在应用它的最精细级别声明它。StepListenerlistenerslistenersStepExecutionListenerItemReadListenerspring-doc.cn

Javaspring-doc.cn
XMLspring-doc.cn

以下示例显示了在 Java 中应用于块级别的侦听器：spring-doc.cn

Java 配置

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

以下示例显示了在 XML 中的块级别应用的侦听器：spring-doc.cn

XML 配置

<step id="step1">
    <tasklet>
        <chunk reader="reader" writer="writer" commit-interval="10"/>
        <listeners>
            <listener ref="chunkListener"/>
        </listeners>
    </tasklet>
</step>

如果，或本身实现其中一个接口，则使用 namespace 元素或其中一个工厂。仅此适用于直接注入 .如果侦听器嵌套在另一个组件，您需要显式注册它（如前面使用 Step 注册 ItemStream 中所述）。ItemReaderItemWriterItemProcessorStepListenerStep<step>*StepFactoryBeanStepspring-doc.cn

除了接口之外，还提供了注释来寻址同样的担忧。普通的旧 Java 对象可以具有带有这些注释的方法，这些注释是然后转换为相应的类型。注释块组件的自定义实现，例如 OR 或。注释由 XML 解析器分析元素以及使用 builder 中的方法注册，因此您需要做的所有事情是使用 XML 命名空间或生成器将侦听器注册到步骤。StepListenerStepListenerItemReaderItemWriterTasklet<listener/>listenerspring-doc.cn

`StepExecutionListener`

StepExecutionListener表示执行的最通用侦听器。它允许在 a 开始之前和结束之后通知 a 是否结束 normally 或 failed，如下例所示：StepStepspring-doc.cn

public interface StepExecutionListener extends StepListener {

    void beforeStep(StepExecution stepExecution);

    ExitStatus afterStep(StepExecution stepExecution);

}

ExitStatus的返回类型为，以便侦听器有机会修改在完成 .afterStepStepspring-doc.cn

与此接口对应的注解是：spring-doc.cn

@BeforeStepspring-doc.cn
@AfterStepspring-doc.cn

`ChunkListener`

“块”定义为在事务范围内处理的项目。提交 transaction 在每个提交间隔提交一个 chunk。您可以使用 to 在 chunk 开始处理之前或 chunk 完成后执行逻辑成功，如下面的接口定义所示：ChunkListenerspring-doc.cn

public interface ChunkListener extends StepListener {

    void beforeChunk(ChunkContext context);
    void afterChunk(ChunkContext context);
    void afterChunkError(ChunkContext context);

}

beforeChunk 方法在事务启动之后但在读取开始之前调用在 .相反，在 chunk 被已提交（如果有回滚，则根本不提交）。ItemReaderafterChunkspring-doc.cn

与此接口对应的注解是：spring-doc.cn

@BeforeChunkspring-doc.cn
@AfterChunkspring-doc.cn
@AfterChunkErrorspring-doc.cn

当没有 chunk 声明时，您可以应用 a。的负责调用，因此它适用于非面向项的 tasklet 以及（它在 tasklet 之前和之后调用）。ChunkListenerTaskletStepChunkListenerspring-doc.cn

A 不是为了引发检查异常而设计的。错误必须在 implementation 否则该步骤将终止。ChunkListenerspring-doc.cn

`ItemReadListener`

在之前讨论跳过逻辑时，提到对跳过的记录，以便以后可以处理它们。在读取错误的情况下，这可以通过来完成，如下面的接口定义显示：ItemReaderListenerspring-doc.cn

public interface ItemReadListener<T> extends StepListener {

    void beforeRead();
    void afterRead(T item);
    void onReadError(Exception ex);

}

在每次调用之前调用该方法以读取 .该方法在每次成功调用 read 后调用，并将项目传递给那被读了。如果在读取时出错，则调用该方法。提供遇到的异常，以便可以记录它。beforeReadItemReaderafterReadonReadErrorspring-doc.cn

与此接口对应的注解是：spring-doc.cn

@BeforeReadspring-doc.cn
@AfterReadspring-doc.cn
@OnReadErrorspring-doc.cn

`ItemProcessListener`

与一样，项目的处理可以被 “监听” ，因为以下接口定义显示：ItemReadListenerspring-doc.cn

public interface ItemProcessListener<T, S> extends StepListener {

    void beforeProcess(T item);
    void afterProcess(T item, S result);
    void onProcessError(T item, Exception e);

}

该方法在和之前被调用已递出要处理的项目。该方法在商品已成功处理。如果在处理时出错，则调用该方法。遇到的异常以及尝试处理，以便可以记录它们。beforeProcessprocessItemProcessorafterProcessonProcessErrorspring-doc.cn

与此接口对应的注解是：spring-doc.cn

@BeforeProcessspring-doc.cn
@AfterProcessspring-doc.cn
@OnProcessErrorspring-doc.cn

`ItemWriteListener`

您可以使用，作为接口定义如下：ItemWriteListenerspring-doc.cn

public interface ItemWriteListener<S> extends StepListener {

    void beforeWrite(List<? extends S> items);
    void afterWrite(List<? extends S> items);
    void onWriteError(Exception exception, List<? extends S> items);

}

该方法在之前被调用，并被传递给写入的项目列表。该方法在项目完成后调用已成功写入，但在提交与 chunk 的处理关联的事务之前。如果在写入时出现错误，则调用该方法。遇到的异常和尝试写入的项为提供，以便可以记录它们。beforeWritewriteItemWriterafterWriteonWriteErrorspring-doc.cn

与此接口对应的注解是：spring-doc.cn

@BeforeWritespring-doc.cn
@AfterWritespring-doc.cn
@OnWriteErrorspring-doc.cn

`SkipListener`

ItemReadListener、和都提供机制收到错误通知，但没有通知你记录实际上已被跳。，即使重试某个项，也会调用成功的。因此，有一个单独的接口用于跟踪跳过的项目，如以下接口定义显示：ItemProcessListenerItemWriteListeneronWriteErrorspring-doc.cn

public interface SkipListener<T,S> extends StepListener {

    void onSkipInRead(Throwable t);
    void onSkipInProcess(T item, Throwable t);
    void onSkipInWrite(S item, Throwable t);

}

onSkipInRead每当读取时跳过项时调用。需要注意的是回滚可能会导致同一项目多次注册为 skipped。在写入时跳过项时调用。因为该项目具有已成功读取（且未跳过），它还将项目本身作为论点。onSkipInWritespring-doc.cn

与此接口对应的注解是：spring-doc.cn

@OnSkipInReadspring-doc.cn
@OnSkipInWritespring-doc.cn
@OnSkipInProcessspring-doc.cn

SkipListeners 和事务

a 最常见的用例之一是注销跳过的项目，因此另一个批处理过程甚至人工过程可用于评估和修复导致 SKIP 的问题。因为在很多情况下，原始交易可以回滚，Spring Batch 做出两个保证：SkipListenerspring-doc.cn

适当的 skip 方法（取决于错误发生的时间）只调用一次每件。spring-doc.cn
总是在提交事务之前调用 the。这是要确保侦听器调用的任何事务资源不会被失败。SkipListenerItemWriterspring-doc.cn