Spring Web Services 中的 XPath 支持

工程 | Arjen Poutsma | 2007年4月23日 | ...

继我关于WS-DuckTyping的文章之后,我认为展示Spring Web Services对XPath的支持会很有趣。其中一些功能现在可用,但大多数功能将包含在我们本月晚些时候发布的RC1版本中。在本文中,我将使用第35项中定义的联系XML文件 Effective XML,作者Rusty Harold。

XPathExpression

一个已经可用相当一段时间的选择是XPathExpression。这是对已编译XPath表达式的抽象,例如Java 5 XPathExpression和Jaxen XPath

最近,我添加了XPathExpressionFactoryBean,以便更容易地将XPath表达式注入到你的bean中,如下所示


<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
       http://www.springframework.org/schema/beans/spring-beans-2.0.xsd">

    <bean id="myEndpoint" class="com.mycompany.ws.MyEndpoint">
        <constructor-arg ref="nameExpression"/>
    </bean>

    <bean id="nameExpression" class="org.springframework.xml.xpath.XPathExpressionFactoryBean">
        <property name="expression" value="/Contacts/Contact/Name"/>
    </bean>

</beans>

为简单起见,此表达式不使用命名空间,但我们可以使用工厂bean的namespaces属性设置它们。

表达式可以在代码中使用,如下所示


public class MyEndpoint extends AbstractDomPayloadEndpoint {
    
    private XPathExpression nameExpression;

    public MyEndpoint(XPathExpression nameExpression) {
        this.nameExpression = nameExpression;
    }

    // Gets invoked for every incoming request
    protected Element invokeInternal(Element requestElement, Document responseDocument) throws Exception {
        String name = nameExpression.evaluateAsString(requestElement);
        // do something with name
        return null; // no response
    }

}

XPathExpression 的一个最近添加的功能是NodeMapper。如果我们将表达式更改为/Contacts/Contact,我们可以使用方法如下


public class MyEndpoint extends AbstractDomPayloadEndpoint {

    private XPathExpression nameExpression;

    public MyEndpoint(XPathExpression nameExpression) {
        this.nameExpression = nameExpression;
    }

    protected Element invokeInternal(Element requestElement, Document responseDocument) throws Exception {
        List contacts = nameExpression.evaluate(requestElement,
                new NodeMapper() {
                    public Object mapNode(Node node, int nodeNum) throws DOMException {
                        Element contactElement = (Element) node;
                        Element nameElement = (Element) contactElement.getElementsByTagName("Name").item(0);
                        Element phoneElement = (Element) contactElement.getElementsByTagName("Phone").item(0);
                        return new Contact(nameElement.getTextContent(), phoneElement.getTextContent());
                    }
                } );
        for (Iterator iterator = contacts.iterator(); iterator.hasNext();) {
            Contact contact = (Contact) iterator.next();
            System.out.println(contact);
        }
        return null; // no response
    }

}

就像我们使用Spring JDBC的RowMapper映射行一样,每个结果节点都使用匿名内部类进行映射。在这种情况下,我们创建一个Contact,稍后我们只需打印它。

XPathTemplate

另一个最近添加的是XPathTemplate。此类遵循Spring中使用的通用模板模式(JdbcTemplate、JmsTemplate等)。此模板可以按如下方式使用

public class MyEndpoint implements PayloadEndpoint {

    private XPathOperations template = new Jaxp13XPathTemplate();

    public Source invoke(Source request) throws Exception {
        String name = template.evaluateAsString("/Contacts/Contact/Name", request);
        // do something with name
        return null; // no response
    }

}

当然,可以使用构造函数参数或setter注入模板。

XPath 模板不使用预编译的 XPath 表达式,因此速度稍慢。但是,模板更灵活,因为你可以将其用于多个表达式。它还支持上面描述的NodeMapper

@XPathParam

最后,对于 Java 5 用户来说,还有一个新功能:@XPathParam 注解。你可以在方法参数上使用此注解,XPath 评估将简单地注入到方法中。使用方法如下

@Endpoint
public class MyEndpoint {

    @PayloadRoot("Contacts")
    public void handleContacts(@XPathParam("/Contacts/Contact/Name")String name) {
        // do something with name
    }

}

@Endpoint 注解是必需的,用于将类标记为端点,@PayloadRoot 指示每当出现具有Contact作为根元素的 SOAP 请求时,将调用handleContacts 方法。最后,@XPathParam 执行参数绑定。你可以绑定到 XPath 支持的所有数据类型:布尔值、双精度浮点数、字符串、节点和节点列表。当然,将所有表达式保存在一个配置文件中更易于维护,但对于简单的项目来说,这是一个合适的方法。

使用此带注解的端点样式只需要少量 XML,只需让 Spring-WS 知道端点存在并使用注解即可。其余部分会自动拾取。


<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
       http://www.springframework.org/schema/beans/spring-beans-2.0.xsd">

    <bean class="org.springframework.ws.server.endpoint.mapping.PayloadRootAnnotationMethodEndpointMapping"/>

    <bean class="org.springframework.ws.server.endpoint.adapter.XPathParamAnnotationMethodEndpointAdapter"/>

    <bean id="myEndpoint" class="com.mycompany.ws.MyEndpoint"/>

</beans>

这些功能中的大部分将包含在本月晚些时候发布的 RC1 版本中(该版本还将包含我们正在编写的更新的参考文档)。但是,此版本的快照在此处可用,因此请尝试一下,并在论坛上报告。

获取 Spring 时事通讯

通过 Spring 时事通讯保持联系

订阅

领先一步

VMware 提供培训和认证,以加速您的进步。

了解更多

获得支持

Tanzu Spring在一个简单的订阅中提供对OpenJDK™、Spring和Apache Tomcat®的支持和二进制文件。

了解更多

即将举行的活动

查看Spring社区中所有即将举行的活动。

查看全部