跳到主要内容

命名空间支持

QWen Plus 中英对照 Namespace Support

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>
xml

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 项目 (www.spring.io/spring-ws) 提供的 XPath 功能。具体来说，我们使用 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>
xml

  • 定义一个 XPath 表达式。必需。

  • 基础 bean 定义的标识符。它是 org.springframework.xml.xpath.XPathExpression 的一个实例。可选。

  • 引用包含命名空间的地图。地图的键定义命名空间前缀，地图的值设置命名空间 URI。同时指定此属性和 map 元素或 ns-prefix 和 ns-uri 属性是无效的。可选。

  • 让您直接在 XPath 表达式元素上将命名空间前缀作为属性设置。如果您设置了 ns-prefix，则还必须设置 ns-uri 属性。可选。

  • 让您直接在 XPath 表达式元素上将命名空间 URI 作为属性设置。如果您设置了 ns-uri，则还必须设置 ns-prefix 属性。可选。

  • 定义一个包含命名空间的地图。只允许一个 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>
xml

使用默认命名空间的 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>
xml

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

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

你可能认为相同的表达式也适用于以下 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>
xml

前面的例子与上一个例子看起来完全相同，但声明了一个默认命名空间。

但是，在这种情况下，前面的 XPath 表达式 (/order/orderItem) 失败了。

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

然而，你可以任意选择命名空间前缀。事实上，提供一个空字符串实际上是可行的。（但是，不允许使用 null。）在命名空间前缀为空字符串的情况下，你的 Xpath 表达式必须使用冒号（":"）来表示默认命名空间。如果你省略冒号，XPath 表达式将无法匹配。以下 XPath 表达式与前面示例中的 XML 文档匹配：

*:localName
xpath

在这个例子中，*:localName 会匹配默认命名空间中的所有本地名称。

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

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

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

命名空间 URI 是真正重要的信息，而不是前缀。Jaxen 非常好地总结了这一点：

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