XML 项读取器和写入器

Spring Batch 为读取 XML 记录并将其映射到 Java 对象，以及将 Java 对象写入为 XML 记录提供了事务基础设施。spring-doc.cadn.net.cn

流式 XML 的限制

StAX API 用于输入/输出操作，因为其他标准 XML 解析 API 无法满足批处理需求（DOM 会一次性将整个输入加载到内存中，而 SAX 通过仅允许用户提供回调方式来控制解析过程）。spring-doc.cadn.net.cn

我们需要考虑 Spring Batch 中 XML 输入和输出的工作原理。首先，有一些概念与文件读写不同，但在整个 Spring Batch 的 XML 处理中是通用的。在 XML 处理中，不需要对记录行（FieldSet 实例）进行分词，而是假设 XML 资源是一个“片段”集合，每个片段对应一条独立记录，如下图所示：spring-doc.cadn.net.cn

XML Input
图 1. XML 输入

在上述场景中，'trade'标签被定义为'根元素'。位于'<trade>'和'</trade>'之间的所有内容被视为一个'片段'。Spring Batch 使用对象/XML 映射（OXM）将片段绑定到对象。然而，Spring Batch 并不依赖于任何特定的 XML 绑定技术。典型用法是委托给 Spring OXM，它为最流行的 OXM 技术提供了统一的抽象层。对 Spring OXM 的依赖是可选的，如果需要，您可以选择实现 Spring Batch 特定的接口。OXM 所支持的技术之间的关系如下图所示：spring-doc.cadn.net.cn

OXM Binding
图 2. OXM 绑定

通过介绍 OXM 以及如何使用 XML 片段来表示记录，我们现在可以更深入地考察读取器和写入器。spring-doc.cadn.net.cn

StaxEventItemReader

StaxEventItemReader 配置为处理来自 XML 输入流的记录提供了典型的设置。首先，考虑以下一组 StaxEventItemReader 可以处理的 XML 记录：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

  • 根元素名称：构成要映射对象的片段的根元素名称。示例配置通过值 "trade" 演示了这一点。spring-doc.cadn.net.cn

  • 资源：一个代表要读取文件的 Spring 资源。spring-doc.cadn.net.cn

  • Unmarshaller：Spring OXM 提供的一个反序列化设施，用于将 XML 片段映射为对象。spring-doc.cadn.net.cn

以下示例展示了如何在 Java 中定义一个 StaxEventItemReader，它适用于名为 trade 的根元素、data/iosample/input/input.xml 类型的资源以及名为 tradeMarshaller 的反序列化器：spring-doc.cadn.net.cn

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

}

以下示例展示了如何在 XML 中定义一个StaxEventItemReader，它使用名为trade的根元素、data/iosample/input/input.xml资源以及名为tradeMarshaller的反序列化器：spring-doc.cadn.net.cn

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

请注意，在此示例中，我们选择使用一个 XStreamMarshaller，它接受一个以映射形式传入的别名，其中第一个键和值分别是片段（即根元素）的名称以及要绑定的对象类型。然后，与 FieldSet 类似，映射到对象类型内字段的其他元素名称在映射中被描述为键/值对。在配置文件中，我们可以使用 Spring 配置工具来描述所需的别名。spring-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 资源，直到识别到即将开始一个新的片段。默认情况下，读取器通过匹配元素名称来识别新片段的开始。读取器会从该片段创建一个独立的 XML 文档，并将该文档传递给反序列化器（通常是 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 对象被传递给编组器（通常是标准的 Spring OXM Marshaller），该编组器通过使用自定义事件写入器将数据写入 Resource，此写入器会过滤由 OXM 工具为每个片段生成的 StartDocument 和 EndDocument 事件。spring-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.infrastructure.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=true属性，用于指定是否可以覆盖现有文件。spring-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);