传递方法参数与通过注释有效负载根设置端点的方法相同，只是它使用了@XPathParam，它指定了消息中要作为参数传递给方法的数据的路径。在这里，XpathParamMethodArgumentResolver负责从消息中提取值并将其传递给方法。

注释XpathParam帮助MethodArgumentResolvers（XpathParamMethodArgumentResolver）从 XML 中提取信息并将节点值绑定到方法参数（使用// cause，整个消息被递归搜索，例如，//lName搜索整个placeRequestRequest消息）。相同的实现也用于方法cancelOrderRequest：

@Endpoint

public class OrderEndpoint {

private final String SERVICE_NS = "http://www.packtpub.com/liverestaurant/OrderService/schema";

private OrderService orderService;

@Autowired

public OrderEndpoint(OrderService orderService) {

this.orderService = orderService;

}

@PayloadRoot(localPart = "placeOrderRequest", namespace = SERVICE_NS)

public @ResponsePayload

Source handleOrderRequest(@XPathParam("//fName") String fName,@XPathParam("//lName") String lName,@XPathParam("//refNumber") String refNumber) throws Exception {

return new StringSource(

"<tns:placeOrderResponse xmlns:tns=\"http://www.packtpub.com/liverestaurant/OrderService/schema\"><tns:refNumber>" + orderService.placeOrder(fName, lName, refNumber)+"</tns:refNumber></tns:placeOrderResponse>");

}

@PayloadRoot(localPart = "cancelOrderRequest", namespace = SERVICE_NS)

public @ResponsePayload

Source handleCancelOrderRequest(@XPathParam("//refNumber") String refNumber) throws Exception {

boolean cancelled = orderService.cancelOrder(refNumber);

return new StringSource(

"<tns:cancelOrderResponse xmlns:tns=\"http://www.packtpub.com/liverestaurant/OrderService/schema\"><cancelled>"+(cancelled?"true":"false")+"</cancelled></tns:cancelOrderResponse>");

}

方法参数可以是以下任何一种：

boolean或Boolean

double或Double

String

Node

NodeList

另请参阅

本章讨论了通过注释有效负载根来设置端点的方法。

使用 DOM 处理传入的 XML 消息

端点的实现要求我们获取传入的 XML 消息并提取其数据。在 Java 中，有各种方法（W3C DOM、SAX、XPath、JAXB、Castor、XMLBeans、JiBX 或 XStream）用于从输入的 XML 消息中提取数据，但大多数方法都不是语言中立的。

DOM 是为了语言中立而创建的，最初用于 JavaScript 操作 HTML 页面。在 Java 中，W3C DOM 库用于与 XML 数据交互。来自 W3C DOM 库的类，例如org.w3c.dom.Document、org.w3c.dom.Element、org.w3c.dom.Node和org.w3c.dom.Text，用于从输入的 XML 消息中提取数据。

在这个配方中，W3C DOM 用于从传入的消息中提取数据。

准备就绪

在这个配方中，项目的名称是LiveRestaurant_R-1.13，具有以下 Maven 依赖项：

spring-ws-core-2.0.1.RELEASE.jar

log4j-1.2.9.jar

如何做…

这个配方的步骤与通过注释有效负载根设置端点的配方相同，只是端点处理方法的实现不同。因此，按照所述的配方的步骤，并使用 DOM 从传入的消息中提取数据并创建响应。

运行命令mvn clean package tomcat:run并浏览到以下链接：

http://localhost:8080/LiveRestaurant/OrderService.wsdl

要测试，打开一个新的命令窗口并运行以下命令：

mvn clean package exec:java

以下是服务器端的输出：

Sent response ....

<placeOrderResponse >

<refNumber>order-John_Smith_1234</refNumber></placeOrderResponse>

...

for request ...

<tns:placeOrderRequest >

<tns:order>

<tns:refNumber>9999</tns:refNumber>

<tns:customer>

.... </tns:customer>

<tns:dateSubmitted>2008-09-29T05:49:45</tns:dateSubmitted>

<tns:orderDate>2014-09-19T03:18:33</tns:orderDate>

<!--1 or more repetitions:-->

<tns:items>

<tns:type>Snacks</tns:type>

<tns:name>Pitza</tns:name>

<tns:quantity>2</tns:quantity>

</tns:items>

</tns:order>

</tns:placeOrderRequest>

,

它是如何工作的…

传递方法参数与通过注释有效负载根设置端点的方法相同，只是我们使用了@RequestPayload，它指定了消息中要作为参数传递给方法的 DOM 元素数据。在这里，DomPayloadMethodProcessor负责从消息中提取值并将其传递给方法。由于返回类型也是由@ResponsePayload指定的 DOM 元素类型，因此DomPayloadMethodProcessor被用作返回处理程序。

@PayloadRoot注释告诉 Spring-WShandleCancelOrderRequest方法是 XML 消息的处理方法。此方法可以处理的消息类型由注释值指示（@RequestPayload元素告诉它是 DOM 元素类型）。在这种情况下，它可以处理具有placeOrderRequest本地部分和http://www.packtpub.com/liverestaurant/OrderService/schema命名空间的 XML 元素。

@PayloadRoot(namespace = NAMESPACE_URI, localPart = "placeOrderRequest")

@ResponsePayload

public Element handlePlaceOrderRequest(@RequestPayload Element placeOrderRequest) throws Exception {

String refNumber=placeOrderRequest.getElementsByTagNameNS(NAMESPACE_URI, "refNumber") .item(0).getTextContent();

String fName=placeOrderRequest.getElementsByTagNameNS(NAMESPACE_URI, "fName") .item(0).getTextContent();

String lName=placeOrderRequest.getElementsByTagNameNS(NAMESPACE_URI, "lName") .item(0).getTextContent();

前面的代码从传入的 XML 消息（placeOrderRequest）中提取元素refNumber、fName和lName，通过方法getElementsByTagNameNS找到并返回refNumber、fName和lName元素中第一项的文本内容（通过item(0).getTextContent()）。

代码的以下部分通过创建placeOrderResponse元素（使用document.createElementNS)来创建传出的 XML 消息）。然后，它创建子元素refNumber（使用document.createElementNS)并创建此元素的文本（使用createTextNode 和 appendChild)。然后，它将refNumber元素附加到响应元素placeOrderResponse（使用appendChild方法）：

Document document = documentBuilder.newDocument();

Element responseElement = document.createElementNS(NAMESPACE_URI,

"placeOrderResponse");

Element canElem=document.createElementNS(NAMESPACE_URI,"refNumber");

Text responseText = document.createTextNode(orderService.placeOrder(fName, lName, refNumber));

canElem.appendChild(responseText);

responseElement.appendChild(canElem);

return responseElement;

另请参阅

在本章讨论的配方通过注释有效负载根设置端点和在第二章中讨论的配方在 HTTP 传输上创建 Web 服务客户端，构建 SOAP Web 服务的客户端。

使用 JDOM 处理传入的 XML 消息

端点的实现要求我们获取传入的 XML 消息并提取其数据。DOM 可以从 XML 文档中提取数据，但它速度慢，消耗内存，并且具有非常基本的功能。

JDOM 文档不会构建到内存中；它是按需构建的（延迟初始化设计模式）。此外，JDOM 通过提供标准的基于 Java 的集合接口，使得在文档树中导航或操作元素更容易。在这个配方中，JDOM 用于从传入的消息中提取数据。

准备工作

在这个配方中，项目的名称是LiveRestaurant_R-1.14，具有以下 Maven 依赖项：

spring-ws-core-2.0.1.RELEASE.jar

jdom-1.0.jar

log4j-1.2.9.jar

jaxen-1.1.jar

xalan-2.7.0.jar

如何做…

这个配方的步骤与通过注释有效负载根设置端点配方的步骤相同，只是端点处理方法的实现不同。因此，请按照前述配方的步骤，使用 JDOM 从传入消息中提取数据，并创建响应。

运行以下命令：

mvn clean package tomcat:run

浏览以下链接：

http://localhost:8080/LiveRestaurant/OrderService.wsdl

要测试，打开一个新的命令窗口并运行以下命令：

mvn exec:java exec:java

以下是服务器端的输出：

Sent response ...

<tns:placeOrderResponse >

<tns:refNumber>order-John_Smith_1234</tns:refNumber>

</tns:placeOrderResponse>....

for request ....

<tns:placeOrderRequest >

<tns:order>

<tns:refNumber>9999</tns:refNumber>

<tns:customer>

........

</tns:customer>

<tns:dateSubmitted>2008-09-29T05:49:45</tns:dateSubmitted>

<tns:orderDate>2014-09-19T03:18:33</tns:orderDate>

<!--1 or more repetitions:-->

<tns:items>

<tns:type>Snacks</tns:type>

<tns:name>Pitza</tns:name>

<tns:quantity>2</tns:quantity>

</tns:items>

</tns:order>

它是如何工作的…

它的工作方式与前面的配方中解释的方式相同，只是在其方法实现中使用了JDOM。

代码的以下部分通过使用命名空间和 XPath 对象从传入的 XML 消息（placeOrderRequest）中提取值refNumber, fName和lName：

Namespace namespace = Namespace.getNamespace("tns", NAMESPACE_URI);

XPath refNumberExpression = XPath.newInstance("//tns:refNumber");

refNumberExpression.addNamespace(namespace);

XPath fNameExpression = XPath.newInstance("//tns:fName");

fNameExpression.addNamespace(namespace);

XPath lNameExpression = XPath.newInstance("//tns:lName");

lNameExpression.addNamespace(namespace);

String refNumber = refNumberExpression.valueOf(placeOrderRequest);

String fName = fNameExpression.valueOf(placeOrderRequest);

String lName = lNameExpression.valueOf(placeOrderRequest);

代码的以下部分通过创建placeOrderResponse元素（使用new Element(...))）来创建传出消息。然后，它创建子元素refNumber（使用new Element(...))并创建此元素的文本（使用setText(...))。然后，它将消息元素附加到响应元素placeOrderResponse（使用addContent方法）：

Namespace resNamespace = Namespace.getNamespace("tns", NAMESPACE_URI);

Element root = new Element("placeOrderResponse", resNamespace);

Element message = new Element("refNumber", resNamespace);

message.setText(orderService.placeOrder(fName, lName, refNumber));

root.addContent(message);

Document doc = new Document(root);

return doc.getRootElement();

另请参阅

在本章讨论的配方通过注释有效负载根设置端点和使用 DOM 处理传入的 XML 消息。

在第二章中讨论的配方在 HTTP 传输上创建 Web 服务客户端，构建 SOAP Web 服务的客户端。

使用 JAXB2 处理传入的 XML 消息

Java Architecture for XML Binding（JAXB）是用于对象-XML 编组的 Java 标准。JAXB 定义了一个用于从 XML 文档读取和写入 Java 对象的程序员 API。对象-XML 映射通常在类中进行注释。JAXB 提供了一组有用的注释，其中大多数具有默认值，使得这种编组工作变得容易。

这个配方演示了如何以非常简单的方式使用 JAXB 处理 Web 服务中的传入 XML 消息。为了简单起见，并且延续之前的配方，相同的配方被重新使用，稍微改进了将 XML 模式转换为域类的方法，以演示 JAXB 的用法。

准备工作

在这个配方中，项目的名称是LiveRestaurant_R-1.15，并且具有以下 Maven 依赖项：

spring-ws-core-2.0.1.RELEASE.jar

log4j-1.2.9.jar

如何做…

这个食谱的步骤与食谱通过注释 payload-root 设置端点的步骤相同，只是端点处理方法的实现不同。因此，按照前述食谱的步骤，并使用 JAXB Marshaller/Un-Mashaller 将有效载荷转换为 POJO。

首先，我们定义了一组领域对象，我们需要从数据合同OrderService.xsd（参考食谱使用 JAXB2 进行编组）中编组到 XML/从 XML 中编组（参见第六章）。

更改端点的实现(OrderEndpoint)以使用 JAXB。

运行以下命令：

mvn clean package tomcat:run

浏览以下链接：

http://localhost:8080/LiveRestaurant/OrderService.wsdl

要测试，打开一个新的命令窗口到Liverestaurant_R-1.15-Client并运行以下命令：

mvn clean package exec:java

以下是服务器端的输出：

Sent response ....

<placeOrderResponse >

<refNumber>order-John_Smith_1234</refNumber>

</placeOrderResponse>....

....

<tns:placeOrderRequest >

<tns:order>

<tns:refNumber>9999</tns:refNumber>

<tns:customer>

........

</tns:customer>

<tns:dateSubmitted>2008-09-29T05:49:45</tns:dateSubmitted>

<tns:orderDate>2014-09-19T03:18:33</tns:orderDate>

<!--1 or more repetitions:-->

<tns:items>

<tns:type>Snacks</tns:type>

<tns:name>Pitza</tns:name>

<tns:quantity>2</tns:quantity>

</tns:items>

</tns:order>

</tns:placeOrderRequest>

它是如何工作的…

在前面的代码中，XML 在运行时与 Java 类绑定使用JAXB。传入的 XML 被转换为 Java 对象（解组）并在处理对象后，结果对象被编组回 XML 然后返回给调用者：

@PayloadRoot(localPart = "placeOrderRequest", namespace = SERVICE_NS)

public @ResponsePayload

Source handlePlaceOrderRequest(@RequestPayload Source source) throws Exception {

PlaceOrderRequest request = (PlaceOrderRequest) unmarshal(source, PlaceOrderRequest.class);

PlaceOrderResponse response = new PlaceOrderResponse();

String refNumber=request.getOrder().getRefNumber();

String fName=request.getOrder().getCustomer().getName().getFName();

String lName=request.getOrder().getCustomer().getName().getLName();

response.setRefNumber(orderService.placeOrder(fName,lName,refNumber));

return marshal(response);

}

private Object unmarshal(Source source, Class clazz) throws JAXBException {

JAXBContext context;

try {

context = JAXBContext.newInstance(clazz);

Unmarshaller um = context.createUnmarshaller();

return um.unmarshal(source);

} catch (JAXBException e) {

e.printStackTrace();

throw e;

}

}

private Source marshal(Object obj) throws JAXBException {

JAXBContext context = JAXBContext.newInstance(obj.getClass());

return new JAXBSource(context, obj);

}

JAXB上下文通过构造函数传递的 Java 类与类中的注释绑定，指示解组器在运行时将数据从 XML 标记实例化和加载到对象中。现在将对象传递给服务类(OrderServiceImpl)进行处理：

public class OrderServiceImpl implements OrderService {

@Service

public class OrderServiceImpl implements OrderService {

public String placeOrder( String fName,String lName,String refNumber){

return "order-"+fName+"_"+lName+"_"+refNumber;

}

public boolean cancelOrder( String refNumber ){

return true;

}

这种方法允许开发人员使用简单的编组技术与 Java 对象而不是 XML 代码一起工作。

另请参阅

在本章中讨论的食谱通过注释 payload-root 设置端点。

在第六章中讨论的食谱使用 JAXB2 进行编组，编组和对象-XML 映射（OXM）-使用编组器和解组器将 POJO 转换为 XML 消息/从 XML 消息转换为 POJO。

使用拦截器在服务器端验证 XML 消息

数据合同是在设置 Spring-WS 时使用的基本概念。然而，在服务器端/客户端发送/回复 SOAP 消息之前，验证是一个基本要求。

Spring-WS 支持服务器端和客户端消息的验证。在这个食谱中，应用了服务器端验证，当不正确的请求到达服务器或不正确的响应从服务器发送到客户端时，它会抛出异常。

准备好

在这个食谱中，项目的名称是LiveRestaurant_R-1.16，具有以下 Maven 依赖项：

spring-ws-core-2.0.1.RELEASE.jar

log4j-1.2.9.jar

如何做…

这个食谱的步骤与使用 DOM 处理传入的 XML 消息的步骤相同，只是验证请求/响应消息的验证不同。

修改spring-ws-servlet.xml以包括PayloadValidatingInterceptor。

运行以下命令：

mvn clean package tomcat:run

浏览以下链接：

http://localhost:8080/LiveRestaurant/OrderService.wsdl

要测试，打开一个新的命令窗口到Liverestaurant_R-1.16-Client并运行以下命令：

mvn clean package exec:java

以下是服务器端的输出：

Sent response [...

<placeOrderResponse >

<refNumber>order-John_Smith_1234</refNumber>

</placeOrderResponse>...

for request ...

<tns:placeOrderRequest >

<tns:order>

<tns:refNumber>9999</tns:refNumber>

<tns:customer>

<tns:addressPrimary>

.....

</tns:addressPrimary>

.......

</tns:customer>

........

</tns:order>

</tns:placeOrderRequest>

WARN [http-8080-1] (AbstractFaultCreatingValidatingInterceptor.java:156) - XML validation error on request: cvc-complex-type.2.4.a: Invalid content was found s

tarting with element 'tns:address'. One of '{ "http://www.packtpub.com/liverestaurant/OrderService/schema":addressPrimary}' is expected.

........ Sent response....

<faultcode>SOAP-ENV:Client</faultcode><faultstring xml:lang="en">Validation error</faultstring><detail><spring-ws:ValidationErrcode>

or xmlns:spring-ws="http://springframework.org/spring-ws">cvc-complex-type.2.4.a: Invalid content was found starting with element 'tns:address'. One of '{ "http:code>

//www.packtpub.com/liverestaurant/OrderService/schema":addressPrimary}' is expected.</spring-ws:ValidationError></detail></SOAP-ENV:Fault></SOAP-ENV:Body></SOAP

-ENV:Envelope>]

它是如何工作的…