Item processing

物料处理

ItemReader 和 ItemWriter 接口对于它们特定的任务都非常有用,但是如果你想在写入之前插入业务逻辑怎么办?两者都有一个选择读取和写入是使用复合模式:创建一个ItemWriter包含 另一个ItemWriterItemReader包含另一个ItemReader. 以下代码显示了一个示例:spring-doc.cadn.net.cn

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

    ItemWriter<T> itemWriter;

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

    public void write(List<? 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接口,如下图所示接口定义:spring-doc.cadn.net.cn

public interface ItemProcessor<I, O> {

    O process(I item) throws Exception;
}

ItemProcessor很简单。给定一个对象,转换它并返回另一个对象。 这 提供的对象可能属于同一类型,也可能不是同一类型。关键是业务逻辑可以在流程中应用,并且完全由开发人员来创建它 逻辑。 一ItemProcessor可以直接连接到一个步骤中。例如,假设ItemReader提供类型Foo并且需要将其转换为类型Bar在写出之前。以下示例显示了ItemProcessor执行转换:spring-doc.cadn.net.cn

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(List<? extends Bar> bars) throws Exception {
        //write bars
    }
}

在前面的示例中,有一个类Foo,一个类Bar和类FooProcessor遵守ItemProcessor接口。 转换是简单,但任何类型的转换都可以在这里完成。 这BarWriterBar对象,如果提供了任何其他类型,则抛出异常。同样,FooProcessor抛出异常,如果有任何异常,但Foo被提供。 这FooProcessor然后可以注入到Step,如以下示例所示:spring-doc.cadn.net.cn

XML 配置
<job id="ioSampleJob">
    <step name="step1">
        <tasklet>
            <chunk reader="fooReader" processor="fooProcessor" writer="barWriter"
                   commit-interval="2"/>
        </tasklet>
    </step>
</job>
Java 配置
@Bean
public Job ioSampleJob() {
	return this.jobBuilderFactory.get("ioSampleJob")
				.start(step1())
				.build();
}

@Bean
public Step step1() {
	return this.stepBuilderFactory.get("step1")
				.<Foo, Bar>chunk(2)
				.reader(fooReader())
				.processor(fooProcessor())
				.writer(barWriter())
				.build();
}

之间的区别ItemProcessorItemReaderItemWriter那是一个ItemProcessor对于Step.spring-doc.cadn.net.cn

链接 ItemProcessors

执行单个转换在许多情况下都很有用,但如果您想将将多个转换“链接在一起ItemProcessor实现? 这可以使用前面提到的复合模式来实现。要更新前面的单个转换,例如,Foo转换为Bar,将其转换为Foobar并写出,如以下示例所示:spring-doc.cadn.net.cn

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(List<? extends Foobar> items) throws Exception {
        //write items
    }
}

一个FooProcessorBarProcessor可以“链接”在一起以给出结果Foobar,如以下示例所示:spring-doc.cadn.net.cn

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

与前面的示例一样,复合处理器可以配置到Step:spring-doc.cadn.net.cn

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>
Java 配置
@Bean
public Job ioSampleJob() {
	return this.jobBuilderFactory.get("ioSampleJob")
				.start(step1())
				.build();
}

@Bean
public Step step1() {
	return this.stepBuilderFactory.get("step1")
				.<Foo, Foobar>chunk(2)
				.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;
}

过滤记录

项目处理器的一个典型用途是在将记录传递给 这ItemWriter. 过滤是不同于跳过的作。跳过表示记录无效,而过滤只是表示记录不应无效 写。spring-doc.cadn.net.cn

例如,考虑一个批处理作业,它读取包含三种不同类型的记录的文件:要插入的记录、要更新的记录和要删除的记录。如果系统不支持记录删除,那么我们不希望将任何“删除”记录发送到 这ItemWriter. 但是,由于这些记录实际上并不是坏记录,因此我们希望过滤掉它们,而不是跳过它们。因此,ItemWriter将仅接收“插入”和“更新”记录。spring-doc.cadn.net.cn

若要筛选记录,可以返回nullItemProcessor. 框架检测到结果是null并避免将该项添加到传递到 这ItemWriter. 像往常一样,从ItemProcessor结果为 跳。spring-doc.cadn.net.cn

验证输入

ItemReaders 和 ItemWriters 一章中,解析输入的多种方法 讨论。 如果每个主要实现不是“格式正确”的,则会抛出一个异常。 这FixedLengthTokenizer如果缺少数据范围,则引发异常。 同样地 尝试访问RowMapperFieldSetMapper不存在或的格式与预期的格式不同,会导致抛出异常。所有这些类型的异常在之前抛出read返回。 但是,它们没有解决返回的项目是否有效的问题。例如,如果其中一个字段是年龄,它显然不能为负数。它可能会正确解析,因为它存在并且是一个数字,但它不会导致异常。由于已经有过多的验证框架,Spring Batch 不会尝试提供另一个。相反,它提供了一个简单的接口,称为Validator,可以由任意数量的框架实现,如以下接口定义所示:spring-doc.cadn.net.cn

public interface Validator<T> {

    void validate(T value) throws ValidationException;

}

合同是validate如果对象无效,方法会抛出异常如果对象有效,则正常返回。Spring Batch 提供了一个开箱即用的ValidatingItemProcessor,如以下 bean 定义所示:spring-doc.cadn.net.cn

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.sample.domain.trade.internal.validator.TradeValidator"/>
	</property>
</bean>
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;
}

您还可以使用BeanValidatingItemProcessor验证标注的项Bean Validation API (JSR-303) 注解。例如,给定以下类型Person:spring-doc.cadn.net.cn

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;
    }

}

您可以通过声明BeanValidatingItemProcessorbean 在你的应用程序上下文中,并在面向块的步骤中将其注册为处理器:spring-doc.cadn.net.cn

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

    return beanValidatingItemProcessor;
}

容错

回滚区块时,在读取过程中缓存的项目可能会被重新处理。如果将步骤配置为容错(通常通过使用 skip 或retry 处理),则任何ItemProcessorused 应该以一种 幂等。 通常,这将包括对输入项执行不更改 这ItemProcessor并且仅更新实例,即结果。spring-doc.cadn.net.cn