【转】Spring的WebServiceTemplate访问WebService的方法及其本质原理

WebService客户端调用的本质就是将SAOP格式的XML通过通信协议发送到WebService的服务器端,然后接收服务器端返回的XML.

本文简单介绍一下如何通过Spring提供的WebServiceTemplate访问Webservice,WebServiceTemplate与调用webservice的客户端已及webservice服务器端示意图如下(图片来源于Spring in Action):

这里以SOAP over HTTP为例,开发步骤如下:

1,在Spring的配置文件中配置WebServiceTemplate,最简单的配置如下:

[html] view plain copy

1. <bean id="webServiceTemplate" class="org.springframework.ws.client.core.WebServiceTemplate">
2. <property name="defaultUri" value="http://localhost:8080/prjCXFWS/services/SimpleServicePort"/>
3. </bean>

*这种配置省略了MessageFactory和messageSender的配置,Spring默认会使用SaajSoapMessageFactory和HttpUrlConnectionMessageSender.等同于下面的配置

[html] view plain copy

1. <bean id="messageFactory" class="org.springframework.ws.soap.saaj.SaajSoapMessageFactory"/>
2. <bean id="webServiceTemplate" class="org.springframework.ws.client.core.WebServiceTemplate">
3. <constructor-arg ref="messageFactory"/>
4. <property name="messageSender">
5. <bean class="org.springframework.ws.transport.http.HttpUrlConnectionMessageSender"/>
6. </property>
7. <property name="defaultUri" value="http://localhost:8080/prjCXFWS/services/SimpleServicePort" />
8. </bean>

还可以使用CommonsHttpMessageSender作为messageSender,它提供了设置timeout,用户名,密码等选项的功能.(需要使用commons-httpclient.jar和commons-codec.jar)
MessageFactory还可以使用AxiomSoapMessageFactory和DomPoxMessageFactory.

[html] view plain copy

1. <bean id="webServiceTemplate" class="org.springframework.ws.client.core.WebServiceTemplate">
2. <property name="messageSender">
3. <bean class="org.springframework.ws.transport.http.CommonsHttpMessageSender">
4. <property name="readTimeout" value="0" />
5. </bean>
6. </property>
7. <property name="defaultUri" value="http://localhost:8080/prjCXFWS/services/SimpleServicePort" />
8. </bean>

2,Java调用代码:传输的是SOAP XML.

[java] view plain copy

1. private static final String MESSAGE =
2. "<queryPeopleByID  xmlns=\"http://test.cxfws.com\">1231ss</queryPeopleByID> ";
3. public static void test() {
4. ApplicationContext ac = new ClassPathXmlApplicationContext("conf/wsAppcontext.xml");
5. WebServiceTemplate simpleService = (WebServiceTemplate) ac.getBean("webServiceTemplate");
6. StreamSource source = new StreamSource(new StringReader(MESSAGE));
7. StreamResult result = new StreamResult(System.out);
8. simpleService.sendSourceAndReceiveToResult(source, result);
9. }

*MESSAGE为需要发送到webservice服务器端的XML payload内容,SOAP body之内的XML内容.

Spring调用Webservice的另一种方法是通过Spring提供的JaxWsPortProxyFactoryBean,示意图如下(图片来源于Spring in Action):

Spring的配置如下:

[html] view plain copy

1. <bean id="simpleService"
2. class="org.springframework.remoting.jaxws.JaxWsPortProxyFactoryBean">
3. <property name="serviceInterface"
4. value="com.cxfclient.test.SimpleService" />
5. <property name="wsdlDocumentUrl"
6. value="http://localhost:8080/prjCXFWS/services/SimpleServicePort?WSDL" />
7. <property name="namespaceUri" value="http://test.cxfws.com/" />
8. <property name="serviceName" value="SimpleServiceService" />
9. <property name="portName" value="SimpleServicePort" />
10. </bean>

**这种方式需要用工具通过Webservice 的wsdl文件生成客户端需要的一些Java类,如service的interface,参数类等等(如下面代码中的SimpleService,People类).
Java调用代码如下

[java] view plain copy

1. ApplicationContext ac = new ClassPathXmlApplicationContext("conf/wsAppcontext.xml");
2. SimpleService simpleService = (SimpleService) ac.getBean("simpleService");
3. People people = simpleService.queryPeopleByID("test");
4. System.out.println(people.getAge() + people.getName() + people.getPid());

关于更多客户端如何调用webservice,参照http://blog.csdn.net/kkdelta/article/details/3987591
对于服务器端,其本质也是接收符合SOAP规范的XML消息,解析XML,返回符合SOAP规范的XML,这里用一个servlet模拟webservice,代码如下:

[java] view plain copy

1. public class WSSimulator extends HttpServlet {
2. public void doGet(HttpServletRequest request, HttpServletResponse response)
3. throws IOException {
4. System.out.println("doGet");
5. BufferedReader in = new BufferedReader(new InputStreamReader( request.getInputStream()));
6. String str;
7. while ((str = in.readLine()) != null) {
8. System.out.println(str); ##1
9. }
10. in.close();
11. String soapHeader = "<SOAP-ENV:Envelope xmlns:SOAP-ENV=\"http://schemas.xmlsoap.org/soap/envelope/\">"
12. +"<SOAP-ENV:Header/><SOAP-ENV:Body>";
13. String soapPayload = "<xxx>yyy</xxx>";
14. String soapTail = "</SOAP-ENV:Body></SOAP-ENV:Envelope>";
15. response.getWriter().write(soapHeader + soapPayload + soapTail);  ##2
16. }
17. public void doPost(HttpServletRequest request, HttpServletResponse response) throws IOException {
18. System.out.println("doPost");
19. doGet(request, response);
20. }
21. }

通过WebServiceTemplate将消息发送到这个servlet监听的url,可以更深理解Webservice的本质.
##1 str就是从客户端传输到服务器端的XML.##2将SOAP消息返回给客户端.