一个简单的Spring Web Service示例

刚接触web service，好不容易找到一篇spring-ws的例子，还琢磨了好长一段时间，很多概念性的问题都没弄清楚。只能依葫芦画瓢，照搬过来，稍微修改了一下，使结构更加清晰，原文出自 http://fuxueliang.javaeye.com/blog/175184#。

  

     基本环境：

             JDK6、Tomcat 6.0、MyEclipse 6.6、spring 2.0、spring-ws-1.5.5

 

1、spring-ws-servlet.xml

      这个地方出现了一段插曲，hello.wsdl放在WEB-INF下老是报错，说hello.wsdl找不到，后来放到classpath下才OK。

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

1. <?xml version="1.0" encoding="UTF-8"?>   
2. <beans xmlns="http://www.springframework.org/schema/beans"    
3.        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
4.        xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.0.xsd">
6.     <bean id="payloadMapping" class="org.springframework.ws.server.endpoint.mapping.PayloadRootQNameEndpointMapping">
7.         <property name="endpointMap">
8.             <map>
9.                 <entry key="{http://www.ispring.com/ws/hello}eRequest"> 
10.                     <ref bean="helloEndpoint"/>         
11.                 </entry>
12.             </map>      
13.         </property> 
14.     </bean>
15.     
16.     <bean id="hello" class="org.springframework.ws.wsdl.wsdl11.SimpleWsdl11Definition"> 
17.         <!--  --><property name="wsdl" value="classpath://hello.wsdl"></property>
18.         <!-- <property name="wsdl" value="/WEB_INF/hello.wsdl"></property> -->
19.         <!-- <constructor-arg value="/WEB_INF/hello.wsdl"/> -->
20.     </bean>
21.     
22.     <bean id="helloEndpoint" class="com.sws.HelloEndPoint">
23.         <property name="helloService" ref="helloService"></property>
24.     </bean>
25.     
26.     <bean id="helloService" class="com.sws.HelloServiceImpl"></bean>
28. </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.

 

2、web.xml

1. <?xml version="1.0" encoding="UTF-8"?>
2. <web-app version="2.4" 
3.     xmlns="http://java.sun.com/xml/ns/j2ee" 
4.     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
5.     xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee 
6.     http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd">
7.   
8.     <!-- begin Spring配置 
9.     <context-param>
10.         <param-name>contextConfigLocation</param-name>
11.         <param-value>
12.             /WEB-INF/spring-ws-servlet.xml,
13.         </param-value>
14.     </context-param>
15.     <listener>
16.         <listener-class>
17.             org.springframework.web.context.ContextLoaderListener
18.         </listener-class>
19.     </listener>
20.     <listener>
21.         <listener-class>
22.             org.springframework.web.util.IntrospectorCleanupListener
23.         </listener-class>
24.     </listener>-->
25.     <!-- end Spring配置 -->
26.     
27.     <servlet>        
28.         <servlet-name>spring-ws</servlet-name>         
29.         <servlet-class>org.springframework.ws.transport.http.MessageDispatcherServlet</servlet-class>   
30.     </servlet>   
31.     <servlet-mapping>   
32.         <servlet-name>spring-ws</servlet-name>   
33.         <url-pattern>/*</url-pattern>   
34.     </servlet-mapping> 
35.   
36.   <welcome-file-list>
37.     <welcome-file>index.jsp</welcome-file>
38.   </welcome-file-list>
39.   
40. </web-app>

3、hello.wsdl

1. <?xml version="1.0" encoding="UTF-8"?>   
2. <wsdl:definitions    
3.     xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"   
4.     xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"  
5.     xmlns:schema="http://www.ispring.com/ws/hello"  
6.     xmlns:tns="http://www.ispring.com/ws/hello/definitions"  
7.     targetNamespace="http://www.ispring.com/ws/hello/definitions">       
8.     
9.     <wsdl:types>   
10.         <schema xmlns="http://www.w3.org/2001/XMLSchema"
11.                 targetNamespace="http://www.ispring.com/ws/hello">
12.             <element name="dRequest" type="string" />
13.             <element name="dResponse" type="string" />
14.         </schema>   
15.     </wsdl:types>   
16.     
17.     <wsdl:message name="bRequest">   
18.         <wsdl:part element="schema:dRequest" name="cRequest" />   
19.     </wsdl:message>   
20.     <wsdl:message name="bResponse">   
21.         <wsdl:part element="schema:dResponse" name="cResponse" />   
22.     </wsdl:message>   
23.     
24.     <wsdl:portType name="HelloPortType">   
25.         <wsdl:operation name="sayHello">   
26.             <wsdl:input message="tns:bRequest" name="aRequest" />   
27.             <wsdl:output message="tns:bResponse" name="aResponse" />   
28.         </wsdl:operation>   
29.     </wsdl:portType>   
30.     
31.     <wsdl:binding name="HelloBinding" type="tns:HelloPortType">   
32.         <soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http" />   
33.         <wsdl:operation name="sayHello">   
34.             <soap:operation soapAction="" />   
35.             <wsdl:input name="aRequest">   
36.                 <soap:body use="literal" />   
37.             </wsdl:input>   
38.             <wsdl:output name="aResponse">   
39.                 <soap:body use="literal" />   
40.             </wsdl:output>   
41.         </wsdl:operation>   
42.     </wsdl:binding>   
43.     
44.     <wsdl:service name="HelloService">   
45.         <wsdl:port binding="tns:HelloBinding" name="HelloPort">   
46.             <soap:address location="http://localhost:8088/springws/webservice" />   
47.         </wsdl:port>   
48.     </wsdl:service>   
49. </wsdl:definitions>

4、HelloService.java

1. package com.sws;
3. public interface HelloService {
4.     
5.     String sayHello(String name);
7. }

5、HelloServiceImpl.java

1. package com.sws;
3. public class HelloServiceImpl implements HelloService {
5.     @Override
6.     public String sayHello(String name) {   
7.         return "Hello, " + name + "!";   
8.     } 
10. }

6、HelloEndPoint.java

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

1. package com.sws;
3. import org.springframework.util.Assert;
4. import org.springframework.ws.server.endpoint.AbstractDomPayloadEndpoint;
5. import org.w3c.dom.Document;
6. import org.w3c.dom.Element;
7. import org.w3c.dom.Node;
8. import org.w3c.dom.NodeList;
9. import org.w3c.dom.Text;
11. public class HelloEndPoint extends AbstractDomPayloadEndpoint{
13.     /**
14.      * Namespace of both request and response
15.      */
16.     public static final String NAMESPACE_URI = "http://www.ispring.com/ws/hello";
17.     
18.     /**
19.      * The local name of the expected request
20.      */
21.     public static final String HELLO_REQUEST_LOCAL_NAME = "eRequest";
22.     
23.     /**
24.      * The local name of the created response
25.      */
26.     public static final String HELLO_RESPONSE_LOCAL_NAME = "fResponse";
27.     
28.     private HelloService helloService;
29.     
31.     @Override
32.     protected Element invokeInternal(Element requestElement, Document document)throws Exception {
33.         Assert.isTrue(NAMESPACE_URI.equals(requestElement.getNamespaceURI()), "Invalid namespace");
34.         Assert.isTrue(HELLO_REQUEST_LOCAL_NAME.equals(requestElement.getLocalName()), "Invalid local name");
35.         
36.         NodeList children = requestElement.getChildNodes();
37.         Text requestText = null;
38.         for(int i=0; i<children.getLength(); i++){
39.             if(children.item(i).getNodeType() == Node.TEXT_NODE){
40.                 requestText = (Text) children.item(i);
41.             }
42.         }
43.         
44.         if(requestText == null){
45.             throw new IllegalArgumentException("Could not find request text node");
46.         }
47.         
48.         String response = helloService.sayHello(requestText.getNodeValue());
49.         Element responseElement = document.createElementNS(NAMESPACE_URI, HELLO_RESPONSE_LOCAL_NAME);
50.         Text responseText = document.createTextNode(response);
51.         responseElement.appendChild(responseText);
52.         return responseElement;
53.     }
56.     public HelloService getHelloService() {
57.         return helloService;
58.     }
61.     public void setHelloService(HelloService helloService) {
62.         this.helloService = helloService;
63.     }
65. }

7、HelloWebServiceClient.java(saaj实现)

1. package com.sws;
3. import java.net.MalformedURLException;
4. import java.net.URL;
5. import java.util.Iterator;
7. import javax.xml.soap.MessageFactory;
8. import javax.xml.soap.Name;
9. import javax.xml.soap.SOAPBodyElement;
10. import javax.xml.soap.SOAPConnection;
11. import javax.xml.soap.SOAPConnectionFactory;
12. import javax.xml.soap.SOAPEnvelope;
13. import javax.xml.soap.SOAPException;
14. import javax.xml.soap.SOAPFault;
15. import javax.xml.soap.SOAPMessage;
17. public class HelloWebServiceClient {
19.     public static final String NAMESPACE_URI = "http://www.ispring.com/ws/hello";
20.     
21.     public static final String PREFIX = "tns";
22.     
23.     private SOAPConnectionFactory connectionFactory;
24.     
25.     private MessageFactory messageFactory;
26.     
27.     private URL url;
28.     
29.     public HelloWebServiceClient(String url) throws UnsupportedOperationException, SOAPException, MalformedURLException{
30.         connectionFactory = SOAPConnectionFactory.newInstance();
31.         messageFactory = MessageFactory.newInstance();
32.         this.url = new URL(url);
33.     }
34.     
35.     private SOAPMessage createHelloRequest() throws SOAPException{
36.         SOAPMessage message = messageFactory.createMessage();
37.         SOAPEnvelope envelope = message.getSOAPPart().getEnvelope();
38.         Name helloRequestName = envelope.createName("eRequest",PREFIX,NAMESPACE_URI);
39.         SOAPBodyElement helloRequestElement = message.getSOAPBody().addBodyElement(helloRequestName);
40.         helloRequestElement.setValue("ispring");
41.         return message;
42.     }
43.     
44.     public void callWebService() throws SOAPException{
45.         SOAPMessage request = createHelloRequest();
46.         SOAPConnection connection = connectionFactory.createConnection();
47.         SOAPMessage response = connection.call(request, url);
48.         if(!response.getSOAPBody().hasFault()){
49.             writeHelloResponse(response);
50.         }else{
51.             SOAPFault fault = response.getSOAPBody().getFault();
52.             System.err.println("Received SOAP Fault");
53.             System.err.println("SOAP Fault Code : " + fault.getFaultCode());
54.             System.err.println("SOAP Fault String : " + fault.getFaultString());            
55.         }
56.     }
57.     
58.     private void writeHelloResponse(SOAPMessage message) throws SOAPException{
59.         SOAPEnvelope envelope = message.getSOAPPart().getEnvelope();
60.         Name helloResponseName = envelope.createName("fResponse",PREFIX,NAMESPACE_URI);
61.         Iterator childElements = message.getSOAPBody().getChildElements(helloResponseName);
62.         SOAPBodyElement helloResponseElement = (SOAPBodyElement)childElements.next();
63.         String value = helloResponseElement.getTextContent();
64.         System.out.println("Hello Response [" + value + "]");
65.     }
66.     
67.     public static void main(String[] args) throws UnsupportedOperationException, MalformedURLException, SOAPException {
68.         String url = "http://localhost:8088/SpringWS";
69.         HelloWebServiceClient helloClient = new HelloWebServiceClient(url);
70.         helloClient.callWebService();
71.     }
73. }