此版本仍在开发中，尚不被认为是稳定的。对于最新的稳定版本，请使用 Spring Batch 文档 5.2.2！spring-doc.cadn.net.cn

XML 项读取器和写入器

Spring Batch 提供了用于读取 XML 记录和将它们映射到 Java 对象以及将 Java 对象写入 XML 记录。spring-doc.cadn.net.cn

流式处理 XML 的约束

StAX API 用于 I/O，因为其他标准 XML 解析 API 不适合批处理处理要求（DOM 将整个输入立即加载到内存中，SAX 控件通过允许用户仅提供回调来解析过程）。spring-doc.cadn.net.cn

我们需要考虑 XML 输入和输出在 Spring Batch 中的工作原理。首先，有一个与文件读取和写入不同但在 Spring Batch 中常见的概念很少 XML 处理。使用 XML 处理时，而不是记录行（FieldSet实例）需要要标记化，假设 XML 资源是“片段”的集合对应于单个记录，如下图所示：spring-doc.cadn.net.cn

图 1.XML 输入

在上述场景中，“trade”标签被定义为“根元素”。万事 “<贸易>”和“</贸易>”之间被视为一个“片段”。弹簧批次使用对象/XML 映射（OXM）将片段绑定到对象。但是，Spring Batch 不是绑定到任何特定的 XML 绑定技术。典型的用途是委托给 Spring OXM，这为最流行的 OXM 技术提供统一的抽象。对 Spring OXM 是可选的，您可以选择实现 Spring Batch 特定的接口如果需要的话。与 OXM 支持的技术的关系显示在下图：spring-doc.cadn.net.cn

图 2.OXM 绑定

通过对 OXM 的介绍以及如何使用 XML 片段来表示记录，我们现在可以更仔细地检查读者和作者。spring-doc.cadn.net.cn

`StaxEventItemReader`

这StaxEventItemReader配置为处理来自 XML 输入流的记录。首先，考虑以下一组 XML 记录，其中这StaxEventItemReader可以处理：spring-doc.cadn.net.cn

<?xml version="1.0" encoding="UTF-8"?>
<records>
    <trade xmlns="https://springframework.org/batch/sample/io/oxm/domain">
        <isin>XYZ0001</isin>
        <quantity>5</quantity>
        <price>11.39</price>
        <customer>Customer1</customer>
    </trade>
    <trade xmlns="https://springframework.org/batch/sample/io/oxm/domain">
        <isin>XYZ0002</isin>
        <quantity>2</quantity>
        <price>72.99</price>
        <customer>Customer2c</customer>
    </trade>
    <trade xmlns="https://springframework.org/batch/sample/io/oxm/domain">
        <isin>XYZ0003</isin>
        <quantity>9</quantity>
        <price>99.99</price>
        <customer>Customer3</customer>
    </trade>
</records>

为了能够处理 XML 记录，需要满足以下条件：spring-doc.cadn.net.cn

根元素名称：构成要映射的对象。示例配置通过贸易值演示了这一点。spring-doc.cadn.net.cn
资源：表示要读取的文件的 Spring 资源。spring-doc.cadn.net.cn
Unmarshaller：Spring OXM 提供的用于映射 XML 的解组工具 fragment 添加到对象。spring-doc.cadn.net.cn

Javaspring-doc.cadn.net.cn
XMLspring-doc.cadn.net.cn

以下示例显示如何定义StaxEventItemReader与根一起使用名为trade，资源data/iosample/input/input.xml，以及一个 unmarshaller 叫tradeMarshaller在 Java 中：spring-doc.cadn.net.cn

Java 配置

@Bean
public StaxEventItemReader itemReader() {
	return new StaxEventItemReaderBuilder<Trade>()
			.name("itemReader")
			.resource(new FileSystemResource("org/springframework/batch/item/xml/domain/trades.xml"))
			.addFragmentRootElements("trade")
			.unmarshaller(tradeMarshaller())
			.build();

}

以下示例显示如何定义StaxEventItemReader与根一起使用名为trade，资源data/iosample/input/input.xml，以及一个 unmarshaller 叫tradeMarshaller在 XML 中：spring-doc.cadn.net.cn

XML 配置

<bean id="itemReader" class="org.springframework.batch.item.xml.StaxEventItemReader">
    <property name="fragmentRootElementName" value="trade" />
    <property name="resource" value="org/springframework/batch/item/xml/domain/trades.xml" />
    <property name="unmarshaller" ref="tradeMarshaller" />
</bean>

请注意，在此示例中，我们选择使用XStreamMarshaller，它接受作为映射传入的别名，第一个键和值是片段的名称（即根元素）和要绑定的对象类型。然后，类似于FieldSet这映射到对象类型内字段的其他元素的名称描述为映射中的键/值对。在配置文件中，我们可以使用 Spring 配置实用程序来描述所需的别名。spring-doc.cadn.net.cn

Javaspring-doc.cadn.net.cn
XMLspring-doc.cadn.net.cn

以下示例显示了如何在 Java 中描述别名：spring-doc.cadn.net.cn

Java 配置

@Bean
public XStreamMarshaller tradeMarshaller() {
	Map<String, Class> aliases = new HashMap<>();
	aliases.put("trade", Trade.class);
	aliases.put("price", BigDecimal.class);
	aliases.put("isin", String.class);
	aliases.put("customer", String.class);
	aliases.put("quantity", Long.class);

	XStreamMarshaller marshaller = new XStreamMarshaller();

	marshaller.setAliases(aliases);

	return marshaller;
}

以下示例演示如何在 XML 中描述别名：spring-doc.cadn.net.cn

XML 配置

<bean id="tradeMarshaller"
      class="org.springframework.oxm.xstream.XStreamMarshaller">
    <property name="aliases">
        <util:map id="aliases">
            <entry key="trade"
                   value="org.springframework.batch.samples.domain.trade.Trade" />
            <entry key="price" value="java.math.BigDecimal" />
            <entry key="isin" value="java.lang.String" />
            <entry key="customer" value="java.lang.String" />
            <entry key="quantity" value="java.lang.Long" />
        </util:map>
    </property>
</bean>

输入时，读取器读取 XML 资源，直到它识别出新片段即将开始。默认情况下，读取器会匹配元素名称以识别新的 fragment 即将开始。读者从 fragment 并将文档传递给反序列化器（通常是 Spring OXM的Unmarshaller）将 XML 映射到 Java 对象。spring-doc.cadn.net.cn

总之，此过程类似于以下 Java 代码，它使用注入由 Spring 配置提供：spring-doc.cadn.net.cn

StaxEventItemReader<Trade> xmlStaxEventItemReader = new StaxEventItemReader<>();
Resource resource = new ByteArrayResource(xmlResource.getBytes());

Map aliases = new HashMap();
aliases.put("trade","org.springframework.batch.samples.domain.trade.Trade");
aliases.put("price","java.math.BigDecimal");
aliases.put("customer","java.lang.String");
aliases.put("isin","java.lang.String");
aliases.put("quantity","java.lang.Long");
XStreamMarshaller unmarshaller = new XStreamMarshaller();
unmarshaller.setAliases(aliases);
xmlStaxEventItemReader.setUnmarshaller(unmarshaller);
xmlStaxEventItemReader.setResource(resource);
xmlStaxEventItemReader.setFragmentRootElementName("trade");
xmlStaxEventItemReader.open(new ExecutionContext());

boolean hasNext = true;

Trade trade = null;

while (hasNext) {
    trade = xmlStaxEventItemReader.read();
    if (trade == null) {
        hasNext = false;
    }
    else {
        System.out.println(trade);
    }
}

`StaxEventItemWriter`

输出与输入对称。这StaxEventItemWriter需要一个Resource一个 marshaller，以及一个rootTagName.Java 对象被传递给封送程序（通常是 standard Spring OXM Marshaller），它写入Resource通过使用自定义事件过滤StartDocument和EndDocument为每个 OXM 工具的片段。spring-doc.cadn.net.cn

Javaspring-doc.cadn.net.cn
XMLspring-doc.cadn.net.cn

以下 Java 示例使用MarshallingEventWriterSerializer:spring-doc.cadn.net.cn

Java 配置

@Bean
public StaxEventItemWriter itemWriter(Resource outputResource) {
	return new StaxEventItemWriterBuilder<Trade>()
			.name("tradesWriter")
			.marshaller(tradeMarshaller())
			.resource(outputResource)
			.rootTagName("trade")
			.overwriteOutput(true)
			.build();

}

以下 XML 示例使用MarshallingEventWriterSerializer:spring-doc.cadn.net.cn

XML 配置

<bean id="itemWriter" class="org.springframework.batch.item.xml.StaxEventItemWriter">
    <property name="resource" ref="outputResource" />
    <property name="marshaller" ref="tradeMarshaller" />
    <property name="rootTagName" value="trade" />
    <property name="overwriteOutput" value="true" />
</bean>

前面的配置设置了三个必需的属性，并将可选的overwriteOutput=trueattrbute，在本章前面提到，用于指定是否可以覆盖现有文件。spring-doc.cadn.net.cn

Javaspring-doc.cadn.net.cn
XMLspring-doc.cadn.net.cn

以下 Java 示例使用与读取示例中使用的封送程序相同的封送程序本章前面显示：spring-doc.cadn.net.cn

Java 配置

@Bean
public XStreamMarshaller customerCreditMarshaller() {
	XStreamMarshaller marshaller = new XStreamMarshaller();

	Map<String, Class> aliases = new HashMap<>();
	aliases.put("trade", Trade.class);
	aliases.put("price", BigDecimal.class);
	aliases.put("isin", String.class);
	aliases.put("customer", String.class);
	aliases.put("quantity", Long.class);

	marshaller.setAliases(aliases);

	return marshaller;
}

以下 XML 示例使用与读取示例中使用的封送处理程序相同的封送处理程序本章前面显示：spring-doc.cadn.net.cn

XML 配置

<bean id="customerCreditMarshaller"
      class="org.springframework.oxm.xstream.XStreamMarshaller">
    <property name="aliases">
        <util:map id="aliases">
            <entry key="customer"
                   value="org.springframework.batch.samples.domain.trade.Trade" />
            <entry key="price" value="java.math.BigDecimal" />
            <entry key="isin" value="java.lang.String" />
            <entry key="customer" value="java.lang.String" />
            <entry key="quantity" value="java.lang.Long" />
        </util:map>
    </property>
</bean>

用 Java 示例进行总结，以下代码说明了所有要点讨论，演示了所需属性的编程设置：spring-doc.cadn.net.cn

FileSystemResource resource = new FileSystemResource("data/outputFile.xml")

Map aliases = new HashMap();
aliases.put("trade","org.springframework.batch.samples.domain.trade.Trade");
aliases.put("price","java.math.BigDecimal");
aliases.put("customer","java.lang.String");
aliases.put("isin","java.lang.String");
aliases.put("quantity","java.lang.Long");
Marshaller marshaller = new XStreamMarshaller();
marshaller.setAliases(aliases);

StaxEventItemWriter staxItemWriter =
	new StaxEventItemWriterBuilder<Trade>()
				.name("tradesWriter")
				.marshaller(marshaller)
				.resource(resource)
				.rootTagName("trade")
				.overwriteOutput(true)
				.build();

staxItemWriter.afterPropertiesSet();

ExecutionContext executionContext = new ExecutionContext();
staxItemWriter.open(executionContext);
Trade trade = new Trade();
trade.setPrice(11.39);
trade.setIsin("XYZ0001");
trade.setQuantity(5L);
trade.setCustomer("Customer1");
staxItemWriter.write(trade);