使用XPath转换XML消息

在消息转换方面，XPath 是一种转换具有 XML 有效负载的消息的有效方法。您可以通过使用<xpath-transformer/> 元素定义 XPath 转换器来实现。

简单的 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 可能比在此处提供对该策略的自定义实现的引用更好的选择。