命名空间支持

Spring Integration XML 模块中的所有组件都提供命名空间支持。为了启用命名空间支持，您需要导入 Spring Integration XML 模块的模式。以下示例显示了典型的设置

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:int="http://www.springframework.org/schema/integration"
  xmlns:int-xml="http://www.springframework.org/schema/integration/xml"
  xsi:schemaLocation="http://www.springframework.org/schema/beans
    https://www.springframework.org/schema/beans/spring-beans.xsd
    http://www.springframework.org/schema/integration
    https://www.springframework.org/schema/integration/spring-integration.xsd
    http://www.springframework.org/schema/integration/xml
    https://www.springframework.org/schema/integration/xml/spring-integration-xml.xsd">
</beans>

XPath 表达式

Spring Integration XML 模块中的许多组件都使用 XPath 表达式。这些组件中的每一个都引用一个已定义为顶级元素的 XPath 表达式，或者使用嵌套的<xpath-expression/>元素。

所有形式的 XPath 表达式都会创建一个使用 Spring 的org.springframework.xml.xpath.XPathExpressionFactory的XPathExpression。创建 XPath 表达式时，将使用类路径上可用的最佳 XPath 实现（JAXP 1.3+ 或 Jaxen，优先使用 JAXP）。

在内部，Spring Integration 使用 Spring Web Services 项目提供的 XPath 功能（www.spring.io/spring-ws）。具体来说，我们使用 Spring Web Services XML 模块 (spring-xml-x.x.x.jar)。要了解更多信息，请参阅 docs.spring.io/spring-ws/docs/current/reference/#xpath 中的相应文档。

以下是xpath-expression元素所有可用配置参数的概述：以下列表显示了xpath-expression元素的可用属性

<int-xml:xpath-expression expression="" (1)
          id=""                         (2)
          namespace-map=""              (3)
          ns-prefix=""                  (4)
          ns-uri="">                    (5)
    <map></map>                         (6)
</int-xml:xpath-expression>
1 定义 XPath 表达式。必填。
2 底层 bean 定义的标识符。它是org.springframework.xml.xpath.XPathExpression的一个实例。可选。
3 引用包含命名空间的映射。映射的键定义命名空间前缀，映射的值设置命名空间 URI。不能同时指定此属性和map元素或ns-prefix和ns-uri属性。可选。
4 允许您直接在 XPath 表达式元素上设置命名空间前缀作为属性。如果设置ns-prefix，则必须还设置ns-uri属性。可选。
5 允许您直接在 XPath 表达式元素上设置命名空间 URI 作为属性。如果设置ns-uri，则必须还设置ns-prefix属性。可选。
6 定义包含命名空间的映射。只允许一个map子元素。映射的键定义命名空间前缀，映射的值设置命名空间 URI。不能同时指定此元素和map属性或设置ns-prefix和ns-uri属性。可选。

向 XPath 表达式提供命名空间（可选）

对于 XPath 表达式元素，您可以提供命名空间信息作为配置参数。您可以使用以下选项之一定义命名空间

  • 使用namespace-map属性引用映射

  • 使用map子元素提供命名空间映射

  • 指定ns-prefix和ns-uri属性

所有三个选项是互斥的。只能设置一个选项。

以下示例显示了几种使用 XPath 表达式的方法，包括设置 XML 命名空间的选项如前所述

<int-xml:xpath-filter id="filterReferencingXPathExpression"
                      xpath-expression-ref="refToXpathExpression"/>

<int-xml:xpath-expression id="refToXpathExpression" expression="/name"/>

<int-xml:xpath-filter id="filterWithoutNamespace">
    <int-xml:xpath-expression expression="/name"/>
</int-xml:xpath-filter>

<int-xml:xpath-filter id="filterWithOneNamespace">
    <int-xml:xpath-expression expression="/ns1:name"
                              ns-prefix="ns1" ns-uri="www.example.org"/>
</int-xml:xpath-filter>

<int-xml:xpath-filter id="filterWithTwoNamespaces">
    <int-xml:xpath-expression expression="/ns1:name/ns2:type">
        <map>
            <entry key="ns1" value="www.example.org/one"/>
            <entry key="ns2" value="www.example.org/two"/>
        </map>
    </int-xml:xpath-expression>
</int-xml:xpath-filter>

<int-xml:xpath-filter id="filterWithNamespaceMapReference">
    <int-xml:xpath-expression expression="/ns1:name/ns2:type"
                              namespace-map="defaultNamespaces"/>
</int-xml:xpath-filter>

<util:map id="defaultNamespaces">
    <util:entry key="ns1" value="www.example.org/one"/>
    <util:entry key="ns2" value="www.example.org/two"/>
</util:map>

使用带有默认命名空间的 XPath 表达式

使用默认命名空间时，您可能会遇到行为与预期不同的情况。假设我们有以下 XML 文档（表示两本书的订单）

<?xml version="1.0" encoding="UTF-8"?>
<order>
    <orderItem>
        <isbn>0321200683</isbn>
        <quantity>2</quantity>
    </orderItem>
    <orderItem>
        <isbn>1590596439</isbn>
        <quantity>1</quantity>
    </orderItem>
</order>

此文档未声明命名空间。因此，应用以下 XPath 表达式可以正常工作

<int-xml:xpath-expression expression="/order/orderItem" />

您可能期望相同的表达式也适用于以下 XML 文件

<?xml version="1.0" encoding="UTF-8"?>
<order xmlns="http://www.example.org/orders">
	<orderItem>
		<isbn>0321200683</isbn>
		<quantity>2</quantity>
	</orderItem>
	<orderItem>
		<isbn>1590596439</isbn>
		<quantity>1</quantity>
	</orderItem>
</order>

前面的示例与前面的示例完全相同，但声明了一个默认命名空间。

但是，前面的 XPath 表达式（/order/orderItem）在这种情况下会失败。

为了解决这个问题，您必须通过设置ns-prefix和ns-uri属性或设置namespace-map属性来提供命名空间前缀和命名空间 URI。命名空间 URI 必须与 XML 文档中声明的命名空间匹配。在前面的示例中，那是www.example.org/orders。

但是，您可以任意选择命名空间前缀。事实上，提供空字符串实际上可以工作。（但是，不允许为空。）对于由空字符串组成的命名空间前缀，您的 XPath 表达式必须使用冒号 (":") 来指示默认命名空间。如果您省略冒号，则 XPath 表达式将不匹配。以下 XPath 表达式与前面示例中的 XML 文档匹配

<int-xml:xpath-expression expression="/:order/:orderItem"
    ns-prefix="" ns-uri="https://www.example.org/prodcuts"/>

您还可以提供任何其他任意选择的命名空间前缀。以下 XPath 表达式（使用myorder命名空间前缀）也匹配

<int-xml:xpath-expression expression="/myorder:order/myorder:orderItem"
    ns-prefix="myorder" ns-uri="https://www.example.org/prodcuts"/>

命名空间 URI 才是真正重要的信息，而不是前缀。Jaxen 对此点进行了很好的总结

在 XPath 1.0 中，所有无前缀名称都是未限定的。XPath 表达式中使用的前缀不必与被查询文档中使用的前缀相同。只需要命名空间 URI 匹配，而前缀不需要匹配。