8. Repeat

8.1 RepeatTemplate

批处理涉及重复性操作-作为简单的优化或作为工作的一部分。为了对重复进行策略化和通用化并为迭代器框架提供足够的信息,Spring Batch 具有RepeatOperations接口。 RepeatOperations界面如下所示:

public interface RepeatOperations {

    RepeatStatus iterate(RepeatCallback callback) throws RepeatException;

}

回调是一个简单的接口,允许您插入一些要重复的业务逻辑:

public interface RepeatCallback {

    RepeatStatus doInIteration(RepeatContext context) throws Exception;

}

回调将重复执行,直到实现决定迭代结束为止。这些接口中的返回值是一个枚举,可以是RepeatStatus.CONTINUABLERepeatStatus.FINISHEDRepeatStatus将有关是否还有更多工作要做的信息传达给重复操作的调用者。一般来说,RepeatOperations的实现应检查RepeatStatus并将其用作结束迭代的决定的一部分。任何希望向调用者发送 signal 的通知,它们都可以返回RepeatStatus.FINISHED

RepeatOperations最简单的通用实现是RepeatTemplate。可以这样使用:

RepeatTemplate template = new RepeatTemplate();

template.setCompletionPolicy(new FixedChunkSizeCompletionPolicy(2));

template.iterate(new RepeatCallback() {

    public ExitStatus doInIteration(RepeatContext context) {
        // Do stuff in batch...
        return ExitStatus.CONTINUABLE;
    }

});

在该示例中,我们返回RepeatStatus.CONTINUABLE以表明还有更多工作要做。如果回调函数想向调用者发出 signal,表示它没有其他工作要做,那么它也可以返回ExitStatus.FINISHED。某些迭代可以通过回调中完成的工作固有的考虑来终止,就迭代而言,其他迭代实际上是无限循环,并且将完成决策委托给外部策略,如上例所示。

8.1.1 RepeatContext

RepeatCallback的方法参数是RepeatContext。许多回调将仅忽略上下文,但如有必要,可以将其用作属性包,以在迭代过程中存储瞬态数据。 iterate方法返回后,上下文将不再存在。

如果正在进行嵌套嵌套,则RepeatContext将具有父上下文。父上下文有时对于存储需要在iterate的调用之间共享的数据很有用。例如,如果您要计算迭代中事件的发生次数并在后续调用中记住该事件,就属于这种情况。

8.1.2 RepeatStatus

RepeatStatus是 Spring Batch 用来表示处理是否完成的枚举。这些可能是RepeatStatus个值:

表 8.1. ExitStatus 属性

ValueDescription
CONTINUABLE还有更多工作要做。
FINISHED不再重复。

也可以使用RepeatStatus中的and()方法将RepeatStatus值与逻辑 AND 操作合并。这样做的结果是对可持续标志进行逻辑与。换句话说,如果任一状态为FINISHED,那么结果将为FINISHED

8.2 完成 Policy

RepeatTemplate内部,在iterate方法中循环的终止由CompletionPolicy确定,CompletionPolicy也是RepeatContext的工厂。 RepeatTemplate负责使用当前策略来创建RepeatContext并将其在迭代的每个阶段传递给RepeatCallback。回调完成其doInIteration之后,RepeatTemplate必须调用CompletionPolicy以要求其更新其状态(将存储在RepeatContext中)。然后,它询问策略迭代是否完成。

Spring Batch 提供了CompletionPolicy的一些简单通用实现。 SimpleCompletionPolicy只允许执行固定次数的次数(RepeatStatus.FINISHED可以随时强制提早完成)。

用户可能需要实施自己的完成策略以做出更复杂的决定。例如,一个阻止批处理作业在联机系统正在使用时执行的批处理窗口将需要自定义策略。

8.3 异常处理

如果RepeatCallback内抛出异常,则RepeatTemplate咨询ExceptionHandler,后者可以决定是否重新抛出该异常。

public interface ExceptionHandler {

    void handleException(RepeatContext context, Throwable throwable)
        throws RuntimeException;

}

一个常见的用例是计算给定类型的异常数,并在达到限制时失败。为此,Spring Batch 提供了SimpleLimitExceptionHandler和更灵活的RethrowOnThresholdExceptionHandlerSimpleLimitExceptionHandler具有 limit 属性和应与当前异常进行比较的异常类型-还对提供的类型的所有子类进行计数。给定类型的异常将被忽略,直到达到限制,然后重新抛出。其他类型的总是被抛弃。

SimpleLimitExceptionHandler的一个重要的可选属性是布尔标志useParent。默认情况下为 false,因此限制仅在当前RepeatContext中考虑。设置为 true 时,限制在嵌套迭代中跨兄弟上下文保留(例如,步骤中的一组块)。

8.4 Listeners

通常,能够接收更多的回调,以解决许多不同迭代中的交叉问题。为此,Spring Batch 提供了RepeatListener接口。 RepeatTemplate允许用户注册RepeatListener,并且将在迭代过程中向他们提供RepeatContextRepeatStatus的回调。

界面如下所示:

public interface RepeatListener {
    void before(RepeatContext context);
    void after(RepeatContext context, RepeatStatus result);
    void open(RepeatContext context);
    void onError(RepeatContext context, Throwable e);
    void close(RepeatContext context);
}

openclose回调在整个迭代之前和之后出现。 beforeafteronError适用于各个 RepeatCallback 调用。

请注意,当有多个侦听器时,它们在列表中,因此有一个 Sequences。在这种情况下,openbefore的调用 Sequences 相同,而afteronErrorclose的调用 Sequences 相反。

8.5 并行处理

RepeatOperations的实现不限于 Sequences 执行回调。某些实现能够并行执行其回调非常重要。为此,Spring Batch 提供了TaskExecutorRepeatTemplate,它使用 Spring TaskExecutor策略来运行RepeatCallback。默认是使用SynchronousTaskExecutor,它具有在同一线程中执行整个迭代的效果(与普通RepeatTemplate相同)。

8.6 声明式迭代

有时,您知道某些业务处理需要在每次发生时重复进行。典型的例子是优化消息管道-处理一批消息(如果它们频繁到达)比承担每条消息的单独事务处理的成本更有效。 Spring Batch 为此提供了一个 AOP 拦截器,该方法将方法调用包装在RepeatOperations中。 RepeatOperationsInterceptor执行拦截的方法,并根据提供的RepeatTemplate中的CompletionPolicy重复。

这是一个使用 Spring AOP 名称空间重复声明称为processMessage的服务的声明式迭代的示例(有关如何配置 AOP 拦截器的更多详细信息,请参见 Spring 用户指南):

<aop:config>
    <aop:pointcut id="transactional"
        expression="execution(* com..*Service.processMessage(..))" />
    <aop:advisor pointcut-ref="transactional"
        advice-ref="retryAdvice" order="-1"/>
</aop:config>

<bean id="retryAdvice" class="org.spr...RepeatOperationsInterceptor"/>

上面的示例在拦截器内部使用默认的RepeatTemplate。要更改策略,侦听器等,您只需要将RepeatTemplate的实例注入拦截器即可。

如果拦截的方法返回void,则拦截器将始终返回 ExitStatus.CONTINUABLE(因此,如果CompletionPolicy没有 endpoints,则存在无限循环的危险)。否则,它将返回ExitStatus.CONTINUABLE,直到截获方法的返回值为 null 为止,此时它将返回ExitStatus.FINISHED。因此,目标方法内部的业务逻辑可以通过返回null或引发由提供的RepeatTemplate中的ExceptionHandler抛出的异常来发出 signal,表明您无需进行其他工作。