Spring Batch 条件处理流

Spring Batch 条件处理流

Spring Batch的job有多个步骤组成：读、处理、写步骤。如果job中步骤有多个路径，类似与if语句，一般称为条件流程。本文介绍两种方式创建Spring Batch条件流程。

1. 结束状态和批处理状态(Exit & Batch Status)

使用Spring Batch框架指定条件步骤时，需要步骤或job的结束状态。因此需要理解步骤或job的批状态和结束状态之间的差异。

• BatchStatus 是一个枚举状态，表示step/job的状态，在Batch框架内部使用，枚举值包括: ABANDONED, COMPLETED, FAILED, STARTED, STARTING, STOPPED, STOPPING, UNKNOWN
• ExitStatus 是step状态，当步骤执行完成时用于条件化决定流向

缺省情况下，job和步骤的ExitStatus与BatchStatus一样。我们也可以设置自定义ExitStatus驱动流程。

2. 条件流程

假设应用场景有IOT设备发送度量信息，设备度量信息是整数数组，如果度量信息包含负数则需要发送通知信息。也就是说检测到负数度量值则发送通知。

2.1 ExitStatus

重要提示，需要使用步骤的ExitStatus驱动条件流程。为了设置步骤的结束状态，需要使用StepExecution 对象的setExitStatus 方法。因此，需要创建ItemProcessor 并继承ItemListenerSupport，并获取步骤StepExecution 。

当发现负数时我们设置步骤的结束状态。在批处理job中基于数据决定结束状态，我们能使用ItemProcessor。现在看下NumberInfoClassifier类中的需要的三个方法：

public class NumberInfoClassifier extends ItemListenerSupport<NumberInfo, Integer>
  implements ItemProcessor<NumberInfo, Integer> {
 
    private StepExecution stepExecution;
 
    @BeforeStep
    public void beforeStep(StepExecution stepExecution) {
        this.stepExecution = stepExecution;
        this.stepExecution.setExitStatus(new ExitStatus(QUIET));
    }
 
    @Override
    public Integer process(NumberInfo numberInfo) throws Exception {
        return Integer.valueOf(numberInfo.getNumber());
    }
 
    @Override
    public void afterProcess(NumberInfo item, Integer result) {
        super.afterProcess(item, result);
        if (item.isPositive()) {
            stepExecution.setExitStatus(new ExitStatus(NOTIFY));
        }
    }
}

注：上面使用ItemProcessor 设置ExitStatus ，其实在ItemReader 或 ItemWriter也能轻松设置状态。最终当我们创建job，我们告诉JobBuilderFactory发送步骤的带有结束状态的通知：

public class NotifierTasklet implements Tasklet {
    @Override
    public RepeatStatus execute(StepContribution stepContribution, ChunkContext chunkContext) throws Exception {
        System.err.println("[" + chunkContext.getStepContext().getJobName() + "] contains interesting data!!");
        return RepeatStatus.FINISHED;
    }
}

public Step numberGeneratorStep(StepBuilderFactory sbf, int[] values, String prepend) {
    return sbf.get("Number generator")
        .<NumberInfo, Integer> chunk(1)
        .reader(new NumberInfoGenerator(values))
        .processor(new NumberInfoClassifier())
        .writer(new PrependingStdoutWriter<>(prepend))
        .build();
}

@Bean
@Qualifier("NotificationStep")
public Step notificationStep(StepBuilderFactory sbf) {
    return sbf.get("Notify step")
        .tasklet(new NotifierTasklet())
        .build();
}

jobBuilderFactory.get("Number generator - second dataset")
    .start(dataProviderStep)
    .on("NOTIFY").to(notificationStep)
    .end()
    .build();

另外当我们有多个结束代码的条件分支时，可以在job中增加from和on方法：

jobBuilderFactory.get("Number generator - second dataset")
    .start(dataProviderStep)
    .on("NOTIFY").to(notificationStep)
    .from(step).on("LOG_ERROR").to(errorLoggingStep)
    .end()
    .build();

现在任何时候ItemProcessor 遇到负数，则job流程转向notificationStep，这里仅在控制台打印信息：

Second Dataset Processor 11
Second Dataset Processor -2
Second Dataset Processor -3
[Number generator - second dataset] contains interesting data!!

如数据集没有负数，则看不到通知消息：

Second Dataset Processor -1
Second Dataset Processor -2
Second Dataset Processor -3

2.2 JobExecutionDecider实现可编程分支

除了上述方法，我们也可以实现JobExecutionDecider 决定流程流向，如果我们有外部因素决定执行流程时非常有用。使用这个方法首先需要修改ItemProcessor，删除ItemListenerSupport 接口和@BeforeStep方法：

public class NumberInfoClassifierWithDecider extends ItemListenerSupport<NumberInfo, Integer>
  implements ItemProcessor<NumberInfo, Integer> {
 
    @Override
    public Integer process(NumberInfo numberInfo) throws Exception {
        return Integer.valueOf(numberInfo.getNumber());
    }
}

接下来创建决策类决定步骤的通知状态：

public class NumberInfoDecider implements JobExecutionDecider {
 
    private boolean shouldNotify() {
        return true;
    }
 
    @Override
    public FlowExecutionStatus decide(JobExecution jobExecution, StepExecution stepExecution) {
        if (shouldNotify()) {
            return new FlowExecutionStatus(NOTIFY);
        } else {
            return new FlowExecutionStatus(QUIET);
        }
    }
}

然后我们设置job在流程中使用决策：

jobBuilderFactory.get("Number generator - third dataset")
    .start(dataProviderStep)
    .next(new NumberInfoDecider()).on("NOTIFY").to(notificationStep)
    .end()
    .build();

3. 总结

本文我们介绍了两种方式实现条件流程。通过ExitStatus 控制流程，另一种是通过自定义JobExecutionDecider控制流程。参考文档：https://www.baeldung.com/spring-batch-conditional-flow