TaskletStep

面向块的处理 不是在 Step 中处理的唯一方式。如果 Step 必须包含一个存储过程调用怎么办？您可以将调用实现为 ItemReader，并在过程完成后返回 null。但是，这样做有点不自然，因为需要一个空操作的 ItemWriter。Spring Batch 为此场景提供了 TaskletStep。

Tasklet 接口有一个方法 execute，它由 TaskletStep 重复调用，直到它返回 RepeatStatus.FINISHED 或抛出异常以指示失败。对 Tasklet 的每次调用都包装在事务中。Tasklet 实现者可能会调用存储过程、脚本或 SQL 更新语句。

  • Java

  • XML

要在 Java 中创建 TaskletStep，传递给构建器的 tasklet 方法的 bean 应该实现 Tasklet 接口。在构建 TaskletStep 时，不应调用 chunk。以下示例显示了一个简单的 tasklet

@Bean
public Step step1(JobRepository jobRepository, PlatformTransactionManager transactionManager) {
    return new StepBuilder("step1", jobRepository)
    			.tasklet(myTasklet(), transactionManager)
    			.build();
}

要在 XML 中创建 TaskletStep，<tasklet/> 元素的 ref 属性应该引用定义 Tasklet 对象的 bean。在 <tasklet/> 中不应使用 <chunk/> 元素。以下示例显示了一个简单的 tasklet

<step id="step1">
    <tasklet ref="myTasklet"/>
</step>
如果它实现了 StepListener 接口，则 TaskletStep 会自动将 tasklet 注册为 StepListener。

TaskletAdapter

与 ItemReader 和 ItemWriter 接口的其他适配器一样，Tasklet 接口包含一个允许将其自身适配到任何预先存在的类的实现：TaskletAdapter。一个可能有用处的示例是用于更新一组记录上的标志的现有 DAO。您可以使用 TaskletAdapter 调用此类，而无需为 Tasklet 接口编写适配器。

  • Java

  • XML

以下示例显示了如何在 Java 中定义 TaskletAdapter

Java 配置
@Bean
public MethodInvokingTaskletAdapter myTasklet() {
	MethodInvokingTaskletAdapter adapter = new MethodInvokingTaskletAdapter();

	adapter.setTargetObject(fooDao());
	adapter.setTargetMethod("updateFoo");

	return adapter;
}

以下示例显示了如何在 XML 中定义 TaskletAdapter

XML 配置
<bean id="myTasklet" class="o.s.b.core.step.tasklet.MethodInvokingTaskletAdapter">
    <property name="targetObject">
        <bean class="org.mycompany.FooDao"/>
    </property>
    <property name="targetMethod" value="updateFoo" />
</bean>

Tasklet 实现示例

许多批处理作业包含在主处理开始之前必须完成的步骤，以设置各种资源，或者在处理完成后清理这些资源。对于大量使用文件的作业，通常需要在成功将某些文件上传到另一个位置后在本地删除这些文件。以下示例（取自Spring Batch 示例项目）是一个具有此类责任的 Tasklet 实现

public class FileDeletingTasklet implements Tasklet, InitializingBean {

    private Resource directory;

    public RepeatStatus execute(StepContribution contribution,
                                ChunkContext chunkContext) throws Exception {
        File dir = directory.getFile();
        Assert.state(dir.isDirectory(), "The resource must be a directory");

        File[] files = dir.listFiles();
        for (int i = 0; i < files.length; i++) {
            boolean deleted = files[i].delete();
            if (!deleted) {
                throw new UnexpectedJobExecutionException("Could not delete file " +
                                                          files[i].getPath());
            }
        }
        return RepeatStatus.FINISHED;
    }

    public void setDirectoryResource(Resource directory) {
        this.directory = directory;
    }

    public void afterPropertiesSet() throws Exception {
        Assert.state(directory != null, "Directory must be set");
    }
}

前面的 tasklet 实现删除给定目录中的所有文件。需要注意的是，execute 方法只调用一次。剩下的就是从 step 中引用 tasklet。

  • Java

  • XML

以下示例显示了如何在 Java 中从 step 中引用 tasklet

Java 配置
@Bean
public Job taskletJob(JobRepository jobRepository, Step deleteFilesInDir) {
	return new JobBuilder("taskletJob", jobRepository)
				.start(deleteFilesInDir)
				.build();
}

@Bean
public Step deleteFilesInDir(JobRepository jobRepository, PlatformTransactionManager transactionManager) {
	return new StepBuilder("deleteFilesInDir", jobRepository)
				.tasklet(fileDeletingTasklet(), transactionManager)
				.build();
}

@Bean
public FileDeletingTasklet fileDeletingTasklet() {
	FileDeletingTasklet tasklet = new FileDeletingTasklet();

	tasklet.setDirectoryResource(new FileSystemResource("target/test-outputs/test-dir"));

	return tasklet;
}

以下示例显示了如何在 XML 中从 step 中引用 tasklet

XML 配置
<job id="taskletJob">
    <step id="deleteFilesInDir">
       <tasklet ref="fileDeletingTasklet"/>
    </step>
</job>

<beans:bean id="fileDeletingTasklet"
            class="org.springframework.batch.samples.tasklet.FileDeletingTasklet">
    <beans:property name="directoryResource">
        <beans:bean id="directory"
                    class="org.springframework.core.io.FileSystemResource">
            <beans:constructor-arg value="target/test-outputs/test-dir" />
        </beans:bean>
    </beans:property>
</beans:bean>