项目处理

ItemReader 和 ItemWriter 接口对于它们各自的任务都非常有用，但如果您想在写入之前插入业务逻辑怎么办？对于读和写，一个选项是使用复合（composite）模式：创建一个包含另一个 ItemWriter 的 ItemWriter，或创建一个包含另一个 ItemReader 的 ItemReader。以下代码显示了一个示例

public class CompositeItemWriter<T> implements ItemWriter<T> {

    ItemWriter<T> itemWriter;

    public CompositeItemWriter(ItemWriter<T> itemWriter) {
        this.itemWriter = itemWriter;
    }

    public void write(Chunk<? extends T> items) throws Exception {
        //Add business logic here
       itemWriter.write(items);
    }

    public void setDelegate(ItemWriter<T> itemWriter){
        this.itemWriter = itemWriter;
    }
}

前面的类包含另一个 ItemWriter，在提供了某些业务逻辑后，它将委托给后者。这种模式也很容易用于 ItemReader，或许可以根据主 ItemReader 提供的输入获取更多参考数据。如果您需要自己控制对 write 的调用，它也很有用。但是，如果您只想在实际写入项目之前“转换”传递给写入的项目，则无需自己进行 write。您只需修改该项目即可。对于这种情况，Spring Batch 提供了 ItemProcessor 接口，如下面的接口定义所示

public interface ItemProcessor<I, O> {

    O process(I item) throws Exception;
}

ItemProcessor 很简单。给定一个对象，转换它并返回另一个对象。提供的对象类型可能相同，也可能不同。重点是业务逻辑可以应用于该过程，并且完全由开发人员创建该逻辑。ItemProcessor 可以直接装配到 step 中。例如，假设 ItemReader 提供了一个类型为 Foo 的类，并且在写入之前需要将其转换为类型为 Bar 的类。以下示例显示了一个执行转换的 ItemProcessor

public class Foo {}

public class Bar {
    public Bar(Foo foo) {}
}

public class FooProcessor implements ItemProcessor<Foo, Bar> {
    public Bar process(Foo foo) throws Exception {
        //Perform simple transformation, convert a Foo to a Bar
        return new Bar(foo);
    }
}

public class BarWriter implements ItemWriter<Bar> {
    public void write(Chunk<? extends Bar> bars) throws Exception {
        //write bars
    }
}

在前面的示例中，有一个名为 Foo 的类，一个名为 Bar 的类，以及一个符合 ItemProcessor 接口的名为 FooProcessor 的类。转换很简单，但此处可以进行任何类型的转换。BarWriter 写入 Bar 对象，如果提供了任何其他类型，则会抛出异常。同样，如果提供的不是 Foo，则 FooProcessor 会抛出异常。然后可以将 FooProcessor 注入到 Step 中，如下面的示例所示

Java
XML

Java 配置

@Bean
public Job ioSampleJob(JobRepository jobRepository, Step step1) {
	return new JobBuilder("ioSampleJob", jobRepository)
				.start(step1)
				.build();
}

@Bean
public Step step1(JobRepository jobRepository, PlatformTransactionManager transactionManager) {
	return new StepBuilder("step1", jobRepository)
				.<Foo, Bar>chunk(2, transactionManager)
				.reader(fooReader())
				.processor(fooProcessor())
				.writer(barWriter())
				.build();
}

XML 配置

<job id="ioSampleJob">
    <step name="step1">
        <tasklet>
            <chunk reader="fooReader" processor="fooProcessor" writer="barWriter"
                   commit-interval="2"/>
        </tasklet>
    </step>
</job>

ItemProcessor 与 ItemReader 或 ItemWriter 的区别在于 ItemProcessor 对于 Step 是可选的。

链接 ItemProcessor

在许多场景中，执行单个转换非常有用，但如果您想将多个 ItemProcessor 实现“链接”在一起怎么办？您可以通过使用前面提到的复合模式来实现。为了更新前面的单个转换示例，Foo 被转换为 Bar，然后再转换为 Foobar 并写入，如下面的示例所示

public class Foo {}

public class Bar {
    public Bar(Foo foo) {}
}

public class Foobar {
    public Foobar(Bar bar) {}
}

public class FooProcessor implements ItemProcessor<Foo, Bar> {
    public Bar process(Foo foo) throws Exception {
        //Perform simple transformation, convert a Foo to a Bar
        return new Bar(foo);
    }
}

public class BarProcessor implements ItemProcessor<Bar, Foobar> {
    public Foobar process(Bar bar) throws Exception {
        return new Foobar(bar);
    }
}

public class FoobarWriter implements ItemWriter<Foobar>{
    public void write(Chunk<? extends Foobar> items) throws Exception {
        //write items
    }
}

可以将 FooProcessor 和 BarProcessor “链接”在一起，以得到结果 Foobar，如下例所示

CompositeItemProcessor<Foo,Foobar> compositeProcessor =
                                      new CompositeItemProcessor<Foo,Foobar>();
List itemProcessors = new ArrayList();
itemProcessors.add(new FooProcessor());
itemProcessors.add(new BarProcessor());
compositeProcessor.setDelegates(itemProcessors);

就像前面的示例一样，您可以将复合处理器配置到 Step 中

Java
XML

Java 配置

@Bean
public Job ioSampleJob(JobRepository jobRepository, Step step1) {
	return new JobBuilder("ioSampleJob", jobRepository)
				.start(step1)
				.build();
}

@Bean
public Step step1(JobRepository jobRepository, PlatformTransactionManager transactionManager) {
	return new StepBuilder("step1", jobRepository)
				.<Foo, Foobar>chunk(2, transactionManager)
				.reader(fooReader())
				.processor(compositeProcessor())
				.writer(foobarWriter())
				.build();
}

@Bean
public CompositeItemProcessor compositeProcessor() {
	List<ItemProcessor> delegates = new ArrayList<>(2);
	delegates.add(new FooProcessor());
	delegates.add(new BarProcessor());

	CompositeItemProcessor processor = new CompositeItemProcessor();

	processor.setDelegates(delegates);

	return processor;
}

XML 配置

<job id="ioSampleJob">
    <step name="step1">
        <tasklet>
            <chunk reader="fooReader" processor="compositeItemProcessor" writer="foobarWriter"
                   commit-interval="2"/>
        </tasklet>
    </step>
</job>

<bean id="compositeItemProcessor"
      class="org.springframework.batch.item.support.CompositeItemProcessor">
    <property name="delegates">
        <list>
            <bean class="..FooProcessor" />
            <bean class="..BarProcessor" />
        </list>
    </property>
</bean>

过滤记录

项目处理器的典型用途之一是在记录传递给 ItemWriter 之前将其过滤掉。过滤是与跳过不同的动作。跳过表示记录无效，而过滤表示记录不应写入。

例如，考虑一个批处理 Job，它读取包含三种不同类型记录的文件：要插入的记录、要更新的记录和要删除的记录。如果系统不支持记录删除，我们就不希望将任何可删除的记录发送到 ItemWriter。但是，由于这些记录实际上并非坏记录，因此我们希望将其过滤掉，而不是跳过它们。结果是，ItemWriter 只会收到可插入和可更新的记录。

要过滤记录，可以从 ItemProcessor 返回 null。框架会检测到结果为 null，并避免将该项目添加到传递给 ItemWriter 的记录列表中。从 ItemProcessor 抛出异常会导致跳过。

验证输入

ItemReaders 和 ItemWriters 章节讨论了多种解析输入的方法。每个主要实现都会在格式不“良好”时抛出异常。如果缺少数据范围，FixedLengthTokenizer 会抛出异常。类似地，尝试访问 RowMapper 或 FieldSetMapper 中不存在或格式与预期不同的索引会导致抛出异常。所有这些类型的异常都在 read 返回之前抛出。但是，它们不解决返回的项目是否有效的问题。例如，如果其中一个字段是年龄，它不能为负。它可以正确解析，因为它存在并且是一个数字，但不会导致异常。由于已经存在大量的验证框架，Spring Batch 不会尝试再提供一个。相反，它提供了一个简单的接口，称为 Validator，您可以使用任意数量的框架来实现它，如下面的接口定义所示

public interface Validator<T> {

    void validate(T value) throws ValidationException;

}

契约是如果对象无效，则 validate 方法会抛出异常；如果对象有效，则正常返回。Spring Batch 提供了一个 ValidatingItemProcessor，如下面的 Bean 定义所示

Java
XML

Java 配置

@Bean
public ValidatingItemProcessor itemProcessor() {
	ValidatingItemProcessor processor = new ValidatingItemProcessor();

	processor.setValidator(validator());

	return processor;
}

@Bean
public SpringValidator validator() {
	SpringValidator validator = new SpringValidator();

	validator.setValidator(new TradeValidator());

	return validator;
}

XML 配置

<bean class="org.springframework.batch.item.validator.ValidatingItemProcessor">
    <property name="validator" ref="validator" />
</bean>

<bean id="validator" class="org.springframework.batch.item.validator.SpringValidator">
	<property name="validator">
		<bean class="org.springframework.batch.samples.domain.trade.internal.validator.TradeValidator"/>
	</property>
</bean>

您还可以使用 BeanValidatingItemProcessor 来验证使用 Bean Validation API (JSR-303) 注解的项目。例如，考虑以下类型 Person

class Person {

    @NotEmpty
    private String name;

    public Person(String name) {
     this.name = name;
    }

    public String getName() {
     return name;
    }

    public void setName(String name) {
     this.name = name;
    }

}

您可以通过在应用程序上下文中声明一个 BeanValidatingItemProcessor bean，并将其注册为面向 chunk 的 step 中的处理器来验证项目

@Bean
public BeanValidatingItemProcessor<Person> beanValidatingItemProcessor() throws Exception {
    BeanValidatingItemProcessor<Person> beanValidatingItemProcessor = new BeanValidatingItemProcessor<>();
    beanValidatingItemProcessor.setFilter(true);

    return beanValidatingItemProcessor;
}

容错

当一个 chunk 回滚时，在读取期间缓存的项目可能会被重新处理。如果一个 step 配置为容错（通常通过使用跳过或重试处理），则使用的任何 ItemProcessor 都应以幂等的方式实现。通常，这将包括不对 ItemProcessor 的输入项目执行任何更改，并且仅更新作为结果的实例。