Spring Web Service 学习之Hello World篇

最新推荐文章于 2022-01-26 21:11:50 发布

gst6062825

最新推荐文章于 2022-01-26 21:11:50 发布

阅读量729

点赞数

分类专栏： webservice

webservice 专栏收录该内容

1 篇文章 0 订阅

订阅专栏

Spring Web Service是Spring社区基于Spring提供的一个关注于创建”文档驱动”的Web Service的模块, 它的主要目标是方便基于”契约优先”(Contract-First)的SOAP服务的开发. 好像没有多少人讨论, 大多数的话题都是围绕xfire, cxf, axis/axis2等主流的Web Service框架.尽管是从事这方面的工作, 不过实际开发中还是公司内部开发的一个Web Service模块,发现与Spring提供的这个模块的构架很像,所以拿出来学习学习.还是先来跑一个类似于Hello Wrold的例子吧.

1, 确定SOAP Body中包含的xml

客户端向服务端发出的xml如下:

Java代码

<?xml version="1.0" encoding="UTF-8"?>
<HelloRequest xmlns=”http://www.fuxueliang.com/ws/hello” >
Rondy.F
</HelloRequest>

服务端返回的xml如下:

Java代码

<?xml version="1.0" encoding="UTF-8"?>
<HelloResponse xmlns=”http://www.fuxueliang.com/ws/hello” >
Hello, Rondy.F!
</HelloResponse>

2, 确定WSDL

Java代码

<?xml version="1.0" encoding="UTF-8"?>
<wsdl:definitions
xmlns:wsdl=”http://schemas.xmlsoap.org/wsdl/”
xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
xmlns:schema=”http://www.fuxueliang.com/ws/hello”
xmlns:tns="http://www.fuxueliang.com/ws/hello/definitions"
targetNamespace="http://www.fuxueliang.com/ws/hello/definitions">
<wsdl:types>
<schema xmlns="htp://www.w3.org/2001/XMLSchema"
argetNamespace="http://www.fuxueliang.com/ws/hello">
<element name="HelloRequest" type="string" />
<element name="HelloResponse" type="string" />
</schema>
</wsdl:types>
<wsdl:message name="HelloRequest">
<wsdl:part element="schema:HelloRequest" name="HelloRequest" />
</wsdl:message>
<wsdl:message name="HelloResponse">
<wsdl:part element="schema:HelloResponse" name="HelloResponse" />
</wsdl:message>
<wsdl:portType name="HelloPortType">
<wsdl:operation name="Hello">
<wsdl:input message="tns:HelloRequest" name="HelloRequest" />
<wsdl:output message="tns:HelloResponse" name="HelloResponse" />
</wsdl:operation>
</wsdl:portType>
<wsdl:binding name="HelloBinding" type="tns:HelloPortType">
<soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http" />
<wsdl:operation name="Hello">
<soap:operation soapAction="" />
<wsdl:input name="HelloRequest">
<soap:body use="literal" />
</wsdl:input>
<wsdl:output name="HelloResponse">
<soap:body use="literal" />
</wsdl:output>
</wsdl:operation>
</wsdl:binding>
<wsdl:service name="HelloService">
<wsdl:port binding="tns:HelloBinding" name="HelloPort">
<soap:address location="http://localhost:8080/springws/webservice" />
</wsdl:port>
</wsdl:service>
</wsdl:definitions>

3, 创建一个Web项目, 由于Spring Web Service是基于Spring MVC的, 在web.xml中添加如下servlet, 并在WEB-INF下建立SpringMVC的默认配置文件spring-ws-servlet.xml:

Java代码

<servlet>
<servlet-name>spring-ws</servlet-name>
<servlet-class>org.springframework.ws.transport.http.MessageDispatcherServlet</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>spring-ws</servlet-name>
<url-pattern>/*</url-pattern>
</servlet-mapping>

4, 创建业务方法及具体实现如下:

Java代码

/**
* @author Rondy.F
*
*/
public interface HelloService {
String hello(String name);
}

Java代码

/**
* @author Rondy.F
*
*/
public class HelloServiceImpl implements HelloService {
public String hello(String name) {
return "Hello, " + name + "!";
}
}

5, 实现一个EndPoint来处理接收到的xml及返回xml.当然, Spring Web Service提供了很多抽象的实现, 包括Dom4j, JDom等等.这里我们使用JDK自带的, 需要继承org.springframework.ws.server.endpoint.AbstractDomPayloadEndpoint.

Java代码

/**
* @author Rondy.F
*
*/
public class HelloEndPoint extends AbstractDomPayloadEndpoint {
/**
* Namespace of both request and response.
*/
public static final String NAMESPACE_URI = "http://www.fuxueliang.com/ws/hello";
/**
* The local name of the expected request.
*/
public static final String HELLO_REQUEST_LOCAL_NAME = "HelloRequest";
/**
* The local name of the created response.
*/
public static final String HELLO_RESPONSE_LOCAL_NAME = "HelloResponse";
private HelloService helloService;
@Override
protected Element invokeInternal(Element requestElement, Document document) throws Exception {
Assert.isTrue(NAMESPACE_URI.equals(requestElement.getNamespaceURI()), "Invalid namespace");
Assert.isTrue(HELLO_REQUEST_LOCAL_NAME.equals(requestElement.getLocalName()), "Invalid local name");
NodeList children = requestElement.getChildNodes();
Text requestText = null;
for (int i = 0; i < children.getLength(); i++) {
if (children.item(i).getNodeType() == Node.TEXT_NODE) {
requestText = (Text) children.item(i);
break;
}
}
if (requestText == null) {
throw new IllegalArgumentException("Could not find request text node");
}
String response = helloService.hello(requestText.getNodeValue());
Element responseElement = document.createElementNS(NAMESPACE_URI, HELLO_RESPONSE_LOCAL_NAME);
Text responseText = document.createTextNode(response);
responseElement.appendChild(responseText);
return responseElement;
}
public void setHelloService(HelloService helloService) {
this.helloService = helloService;
}
}

6, 修改配置文件spring-ws-servlet.xml.

Java代码

<?xml version="1.0" encoding="UTF-8"?>
<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="payloadMapping" class="org.springframework.ws.server.endpoint.mapping.PayloadRootQNameEndpointMapping">
<property name="endpointMap">
<map>
<entry key=”{http://www.fuxueliang.com/ws/hello}HelloRequest” />
<ref bean="helloEndpoint" />
</entry>
</map>
</property>
</bean>
<bean id="hello" class="org.springframework.ws.wsdl.wsdl11.SimpleWsdl11Definition">
<property name="wsdl" value="/WEB-INF/hello.wsdl"/>
</bean>
<bean id="helloEndpoint" class="org.rondy.ws.HelloEndPoint">
<property name="helloService" ref="helloService" />
</bean>
<bean id="helloService" class="org.rondy.service.HelloServiceImpl" />
</beans>

注: 其中最主要的bean就是payloadMapping, 它定义了接收到的message与endpoint之间的mapping关系:将SOAP Body中包含的xml的根节点的QName为{http://www.fuxueliang.com/ws/hello}HelloRequest交给helloEndpoint处理.
SimpleWsdl11Definition这个bean则是定义了这个服务的wsdl, 访问地址是:http://localhost:8080/springws/hello.wsdl.

7, 客户端(saaj实现)的代码如下:

Java代码

/**
*
* @author Rondy.F
*
*/
public class HelloWebServiceClient {
public static final String NAMESPACE_URI = "http://www.fuxueliang.com/ws/hello";
public static final String PREFIX = "tns";
private SOAPConnectionFactory connectionFactory;
private MessageFactory messageFactory;
private URL url;
public HelloWebServiceClient(String url) throws SOAPException, MalformedURLException {
connectionFactory = SOAPConnectionFactory.newInstance();
messageFactory = MessageFactory.newInstance();
this.url = new URL(url);
}
private SOAPMessage createHelloRequest() throws SOAPException {
SOAPMessage message = messageFactory.createMessage();
SOAPEnvelope envelope = message.getSOAPPart().getEnvelope();
Name helloRequestName = envelope.createName("HelloRequest", PREFIX, NAMESPACE_URI);
SOAPBodyElement helloRequestElement = message.getSOAPBody().addBodyElement(helloRequestName);
helloRequestElement.setValue("Rondy.F");
return message;
}
public void callWebService() throws SOAPException, IOException {
SOAPMessage request = createHelloRequest();
SOAPConnection connection = connectionFactory.createConnection();
SOAPMessage response = connection.call(request, url);
if (!response.getSOAPBody().hasFault()) {
writeHelloResponse(response);
} else {
SOAPFault fault = response.getSOAPBody().getFault();
System.err.println("Received SOAP Fault");
System.err.println("SOAP Fault Code :" + fault.getFaultCode());
System.err.println("SOAP Fault String :" + fault.getFaultString());
}
}
@SuppressWarnings("unchecked")
private void writeHelloResponse(SOAPMessage message) throws SOAPException {
SOAPEnvelope envelope = message.getSOAPPart().getEnvelope();
Name helloResponseName = envelope.createName("HelloResponse", PREFIX, NAMESPACE_URI);
Iterator childElements = message.getSOAPBody().getChildElements(helloResponseName);
SOAPBodyElement helloResponseElement = (SOAPBodyElement) childElements.next();
String value = helloResponseElement.getTextContent();
System.out.println("Hello Response [" + value + "]");
}
public static void main(String[] args) throws Exception {
String url = "http://localhost:8080/springws";
HelloWebServiceClient helloClient = new HelloWebServiceClient(url);
helloClient.callWebService();
}
}