使用 XPath 转换 XML 消息

在消息转换方面，XPath 是一个非常好的方式来转换具有 XML 负载的消息。你可以通过定义 XPath 转换器并使用 <xpath-transformer/> 元素来做到这一点。

简单 XPath 转换

考虑以下转换器配置

<int-xml:xpath-transformer input-channel="inputChannel" output-channel="outputChannel"
      xpath-expression="/person/@name" />

也考虑以下 Message

Message<?> message =
  MessageBuilder.withPayload("<person name='John Doe' age='42' married='true'/>").build();

将此消息发送到 'inputChannel' 后，之前配置的 XPath 转换器将此 XML 消息转换为一个简单的 Message，其负载为 'John Doe'，这完全基于 xpath-expression 属性中指定的简单 XPath 表达式。

XPath 还允许你将提取的元素简单地转换为所需类型。有效的返回类型定义在 javax.xml.xpath.XPathConstants 中，并遵循 javax.xml.xpath.XPath 接口指定的转换规则。

以下常量由 XPathConstants 类定义：BOOLEAN, DOM_OBJECT_MODEL, NODE, NODESET, NUMBER, 和 STRING。

你可以通过使用 <xpath-transformer/> 元素的 evaluation-type 属性来配置所需类型，如下例所示（两次）

<int-xml:xpath-transformer input-channel="numberInput" xpath-expression="/person/@age"
                           evaluation-type="NUMBER_RESULT" output-channel="output"/>

<int-xml:xpath-transformer input-channel="booleanInput"
                           xpath-expression="/person/@married = 'true'"
                           evaluation-type="BOOLEAN_RESULT" output-channel="output"/>

节点映射器

如果你需要为 XPath 表达式提取的节点提供自定义映射，你可以提供 org.springframework.xml.xpath.NodeMapper（由 XPathOperations 实现用于按节点映射 Node 对象的接口）实现的引用。要提供 NodeMapper 的引用，你可以使用 node-mapper 属性，如下例所示

<int-xml:xpath-transformer input-channel="nodeMapperInput" xpath-expression="/person/@age"
                           node-mapper="testNodeMapper" output-channel="output"/>

以下示例展示了一个与上例配合使用的 NodeMapper 实现

class TestNodeMapper implements NodeMapper {
  public Object mapNode(Node node, int nodeNum) throws DOMException {
    return node.getTextContent() + "-mapped";
  }
}

XML 负载转换器

你还可以使用 org.springframework.integration.xml.XmlPayloadConverter 的实现来提供更精细的转换。以下示例展示了如何定义一个

<int-xml:xpath-transformer input-channel="customConverterInput"
                           output-channel="output" xpath-expression="/test/@type"
                           converter="testXmlPayloadConverter" />

以下示例展示了一个与上例配合使用的 XmlPayloadConverter 实现

class TestXmlPayloadConverter implements XmlPayloadConverter {
  public Source convertToSource(Object object) {
    throw new UnsupportedOperationException();
  }
  //
  public Node convertToNode(Object object) {
    try {
      return DocumentBuilderFactory.newInstance().newDocumentBuilder().parse(
          new InputSource(new StringReader("<test type='custom'/>")));
    }
    catch (Exception e) {
      throw new IllegalStateException(e);
    }
  }
  //
  public Document convertToDocument(Object object) {
    throw new UnsupportedOperationException();
  }
}

如果你不提供此引用，则使用 DefaultXmlPayloadConverter。在大多数情况下，这应该足够了，因为它能够从 Node、Document、Source、File、String、InputStream 和 byte[] 负载进行转换。如果你需要扩展超出该默认实现的能力，那么一个上游 Transformer 可能比在这里提供此策略的自定义实现引用更好的选择。