FlatFileItemWriter

写入平面文件与从文件读取具有相同的问题。一个步骤必须能够以事务方式写入分隔符或固定长度格式。

LineAggregator

正如 LineTokenizer 接口对于将项转换为 String 是必需的，文件写入也必须有一种方法将多个字段聚合为单个字符串以写入文件。在 Spring Batch 中，这就是 LineAggregator，其接口定义如下

public interface LineAggregator<T> {

    public String aggregate(T item);

}

LineAggregator 与 LineTokenizer 逻辑相反。LineTokenizer 接收 String 并返回 FieldSet，而 LineAggregator 接收 item 并返回 String。

PassThroughLineAggregator

LineAggregator 接口最基本的实现是 PassThroughLineAggregator，它假定对象已经是字符串，或者其字符串表示形式可用于写入，如以下代码所示

public class PassThroughLineAggregator<T> implements LineAggregator<T> {

    public String aggregate(T item) {
        return item.toString();
    }
}

如果需要直接控制字符串的创建，但又需要 FlatFileItemWriter 的优点（例如事务和重启支持），则上述实现非常有用。

简化文件写入示例

现在已经定义了 LineAggregator 接口及其最基本的实现 PassThroughLineAggregator，可以解释写入的基本流程

  1. 要写入的对象被传递给 LineAggregator 以获取 String。

  2. 返回的 String 被写入到配置的文件中。

FlatFileItemWriter 的以下摘录用代码表达了这一点

public void write(T item) throws Exception {
    write(lineAggregator.aggregate(item) + LINE_SEPARATOR);
}

  • Java

  • XML

在 Java 中，一个简单的配置示例可能如下所示

Java 配置
@Bean
public FlatFileItemWriter itemWriter() {
	return  new FlatFileItemWriterBuilder<Foo>()
           			.name("itemWriter")
           			.resource(new FileSystemResource("target/test-outputs/output.txt"))
           			.lineAggregator(new PassThroughLineAggregator<>())
           			.build();
}

在 XML 中，一个简单的配置示例可能如下所示

XML 配置
<bean id="itemWriter" class="org.spr...FlatFileItemWriter">
    <property name="resource" value="file:target/test-outputs/output.txt" />
    <property name="lineAggregator">
        <bean class="org.spr...PassThroughLineAggregator"/>
    </property>
</bean>

FieldExtractor

上述示例对于文件写入的最基本用途可能很有用。然而，FlatFileItemWriter 的大多数用户都有一个需要写入的域对象，因此必须将其转换为一行。在文件读取中，需要以下内容

  1. 从文件中读取一行。

  2. 将该行传递给 LineTokenizer#tokenize() 方法，以检索 FieldSet。

  3. 将标记化返回的 FieldSet 传递给 FieldSetMapper，返回 ItemReader#read() 方法的结果。

文件写入有类似但相反的步骤

  1. 将要写入的项传递给写入器。

  2. 将项目中的字段转换为数组。

  3. 将生成的数组聚合为一行。

由于框架无法知道对象中的哪些字段需要写入，因此必须编写 FieldExtractor 来完成将项转换为数组的任务，如以下接口定义所示

public interface FieldExtractor<T> {

    Object[] extract(T item);

}

FieldExtractor 接口的实现应该从提供的对象的字段创建数组，然后可以使用元素之间的分隔符或作为固定宽度行的一部分写入。

PassThroughFieldExtractor

在许多情况下，需要写入集合，例如数组、Collection 或 FieldSet。“提取”其中一种集合类型的数组非常简单。为此，将集合转换为数组。因此，在这种情况下应使用 PassThroughFieldExtractor。需要注意的是，如果传入的对象不是集合类型，则 PassThroughFieldExtractor 返回一个仅包含要提取的项的数组。

BeanWrapperFieldExtractor

与文件读取部分中描述的 BeanWrapperFieldSetMapper 一样，通常最好配置如何将域对象转换为对象数组，而不是自己编写转换。BeanWrapperFieldExtractor 提供了此功能，如以下示例所示

BeanWrapperFieldExtractor<Name> extractor = new BeanWrapperFieldExtractor<>();
extractor.setNames(new String[] { "first", "last", "born" });

String first = "Alan";
String last = "Turing";
int born = 1912;

Name n = new Name(first, last, born);
Object[] values = extractor.extract(n);

assertEquals(first, values[0]);
assertEquals(last, values[1]);
assertEquals(born, values[2]);

此提取器实现只有一个必需属性：要映射的字段名称。正如 BeanWrapperFieldSetMapper 需要字段名称来将 FieldSet 中的字段映射到所提供对象上的设置器一样，BeanWrapperFieldExtractor 需要名称来映射到获取器以创建对象数组。值得注意的是，名称的顺序决定了数组中字段的顺序。

分隔文件写入示例

最基本的平面文件格式是所有字段都由分隔符分隔的格式。这可以通过使用 DelimitedLineAggregator 来实现。以下示例写入一个表示客户账户信用的简单域对象

public class CustomerCredit {

    private int id;
    private String name;
    private BigDecimal credit;

    //getters and setters removed for clarity
}

由于正在使用域对象，因此必须提供 FieldExtractor 接口的实现，以及要使用的分隔符。

  • Java

  • XML

以下示例显示了如何在 Java 中使用带有分隔符的 FieldExtractor

Java 配置
@Bean
public FlatFileItemWriter<CustomerCredit> itemWriter(Resource outputResource) throws Exception {
	BeanWrapperFieldExtractor<CustomerCredit> fieldExtractor = new BeanWrapperFieldExtractor<>();
	fieldExtractor.setNames(new String[] {"name", "credit"});
	fieldExtractor.afterPropertiesSet();

	DelimitedLineAggregator<CustomerCredit> lineAggregator = new DelimitedLineAggregator<>();
	lineAggregator.setDelimiter(",");
	lineAggregator.setFieldExtractor(fieldExtractor);

	return new FlatFileItemWriterBuilder<CustomerCredit>()
				.name("customerCreditWriter")
				.resource(outputResource)
				.lineAggregator(lineAggregator)
				.build();
}

以下示例显示了如何在 XML 中使用带有分隔符的 FieldExtractor

XML 配置
<bean id="itemWriter" class="org.springframework.batch.infrastructure.item.file.FlatFileItemWriter">
    <property name="resource" ref="outputResource" />
    <property name="lineAggregator">
        <bean class="org.spr...DelimitedLineAggregator">
            <property name="delimiter" value=","/>
            <property name="fieldExtractor">
                <bean class="org.spr...BeanWrapperFieldExtractor">
                    <property name="names" value="name,credit"/>
                </bean>
            </property>
        </bean>
    </property>
</bean>

在前面的示例中，本章前面描述的 BeanWrapperFieldExtractor 用于将 CustomerCredit 中的名称和信用字段转换为对象数组，然后用逗号分隔每个字段写入。

  • Java

  • XML

也可以使用 FlatFileItemWriterBuilder.DelimitedBuilder 自动创建 BeanWrapperFieldExtractor 和 DelimitedLineAggregator，如以下示例所示

Java 配置
@Bean
public FlatFileItemWriter<CustomerCredit> itemWriter(Resource outputResource) throws Exception {
	return new FlatFileItemWriterBuilder<CustomerCredit>()
				.name("customerCreditWriter")
				.resource(outputResource)
				.delimited()
				.delimiter("|")
				.names(new String[] {"name", "credit"})
				.build();
}

使用 FlatFileItemWriterBuilder 没有 XML 等效项。

固定宽度文件写入示例

分隔符不是平面文件格式的唯一类型。许多人喜欢为每列使用固定宽度来区分字段，这通常称为“固定宽度”。Spring Batch 通过 FormatterLineAggregator 支持文件写入中的这种方式。

  • Java

  • XML

使用上面描述的相同 CustomerCredit 域对象，它可以在 Java 中按如下方式配置

Java 配置
@Bean
public FlatFileItemWriter<CustomerCredit> itemWriter(Resource outputResource) throws Exception {
	BeanWrapperFieldExtractor<CustomerCredit> fieldExtractor = new BeanWrapperFieldExtractor<>();
	fieldExtractor.setNames(new String[] {"name", "credit"});
	fieldExtractor.afterPropertiesSet();

	FormatterLineAggregator<CustomerCredit> lineAggregator = new FormatterLineAggregator<>();
	lineAggregator.setFormat("%-9s%-2.0f");
	lineAggregator.setFieldExtractor(fieldExtractor);

	return new FlatFileItemWriterBuilder<CustomerCredit>()
				.name("customerCreditWriter")
				.resource(outputResource)
				.lineAggregator(lineAggregator)
				.build();
}

使用上面描述的相同 CustomerCredit 域对象，它可以在 XML 中按如下方式配置

XML 配置
<bean id="itemWriter" class="org.springframework.batch.infrastructure.item.file.FlatFileItemWriter">
    <property name="resource" ref="outputResource" />
    <property name="lineAggregator">
        <bean class="org.spr...FormatterLineAggregator">
            <property name="fieldExtractor">
                <bean class="org.spr...BeanWrapperFieldExtractor">
                    <property name="names" value="name,credit" />
                </bean>
            </property>
            <property name="format" value="%-9s%-2.0f" />
        </bean>
    </property>
</bean>

上述大部分示例应该看起来很熟悉。但是，格式属性的值是新的。

  • Java

  • XML

以下示例显示了 Java 中的格式属性

...
FormatterLineAggregator<CustomerCredit> lineAggregator = new FormatterLineAggregator<>();
lineAggregator.setFormat("%-9s%-2.0f");
...

以下示例显示了 XML 中的格式属性

<property name="format" value="%-9s%-2.0f" />

底层实现是使用 Java 5 中添加的相同 Formatter 构建的。Java Formatter 基于 C 编程语言的 printf 功能。有关如何配置格式化程序的大多数详细信息可以在 Formatter 的 Javadoc 中找到。

  • Java

  • XML

也可以使用 FlatFileItemWriterBuilder.FormattedBuilder 自动创建 BeanWrapperFieldExtractor 和 FormatterLineAggregator，如以下示例所示

Java 配置
@Bean
public FlatFileItemWriter<CustomerCredit> itemWriter(Resource outputResource) throws Exception {
	return new FlatFileItemWriterBuilder<CustomerCredit>()
				.name("customerCreditWriter")
				.resource(outputResource)
				.formatted()
				.format("%-9s%-2.0f")
				.names(new String[] {"name", "credit"})
				.build();
}

处理文件创建

FlatFileItemReader 与文件资源的关系非常简单。当读取器初始化时，它会打开文件（如果存在），如果不存在则抛出异常。文件写入并不是那么简单。乍一看，FlatFileItemWriter 似乎应该存在类似的简单契约：如果文件已经存在，则抛出异常；如果不存在，则创建它并开始写入。然而，潜在地重新启动 Job 可能会导致问题。在正常的重新启动场景中，契约是反向的：如果文件存在，则从上次已知的好位置开始写入；如果不存在，则抛出异常。但是，如果此作业的文件名始终相同，会发生什么？在这种情况下，除非是重新启动，否则您将希望删除文件（如果存在）。由于这种可能性，FlatFileItemWriter 包含属性 shouldDeleteIfExists。将此属性设置为 true 会导致在打开写入器时删除具有相同名称的现有文件。

© . This site is unofficial and not affiliated with VMware.