学步园

      最近学习了如何使用apache cxf和Spring发布webservice，虽然网上的资料很多，但是没有一个文档可以让读者按照操作步骤来实现完整的发布流程，都需要多篇文件杂合在一起，互相参考才可以完成第一个HelloWorld形式的Webservice。现在将我利用apache cxf和Spring发布webservice的详细的发布过程记录下来，以供后来者参考。

 环境信息如下：

 JDK1.5.15

 Tomcat5.5.26

 Spring2.5.5

 apache-cxf-2.2.4

 具体实现步骤如下：

（1）使用IDE建立WEB工程cxfservice

工程目录结构如下：

其中的WEB-INF/lib目录下的jar包为直接将apache-cxf-2.2.4.zip下载包中的apache-cxf-2.2.4/lib目录下的全部的jar，在学习过程中这种办法是最简单的了。

当然我们也可以用最少的Jar包来完成本实例的任务，首先要将cxf的依赖包加入，包括如下一些jar包：

commons-logging-1.1.1.jar<br /> geronimo-activation_1.1_spec-1.0.2.jar (or Sun's Activation jar)<br /> geronimo-annotation_1.0_spec-1.1.1.jar (JSR 250)<br /> geronimo-javamail_1.4_spec-1.6.jar (or Sun's JavaMail jar)<br /> geronimo-servlet_2.5_spec-1.2.jar (or Sun's Servlet jar)<br /> geronimo-ws-metadata_2.0_spec-1.1.2.jar (JSR 181)<br /> geronimo-jaxws_2.1_spec-1.0.jar (or Sun's jaxws-api-2.1.jar)<br /> geronimo-stax-api_1.0_spec-1.0.1.jar (or other stax-api jar)<br /> jaxb-api-2.1.jar<br /> jaxb-impl-2.1.12.jar<br /> jetty-6.1.21.jar<br /> jetty-util-6.1.21.jar<br /> neethi-2.0.4.jar<br /> saaj-api-1.3.jar<br /> saaj-impl-1.3.2.jar<br /> wsdl4j-1.6.2.jar<br /> wstx-asl-3.2.8.jar<br /> XmlSchema-1.4.5.jar<br /> xml-resolver-1.2.jar</p> <p>  

再就是Spring的包了，包括如下一些

aopalliance-1.0.jar<br /> spring-core-2.5.5.jar<br /> spring-beans-2.5.5.jar<br /> spring-context-2.5.5.jar<br /> spring-web-2.5.5.jar<br />

最后就是apache cxf本身的包了

cxf-2.2.3.jar

（2）配置文件说明

applicationContext.xml文件的内容如下：

<?xml version="1.0" encoding="UTF-8"?><br /> <beans<br /> xmlns="http://www.springframework.org/schema/beans"<br /> xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"<br /> xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd"><br /> <import resource="classpath*:META-INF/cxf/cxf.xml" /><br /> <import resource="classpath*:META-INF/cxf/cxf-extension-soap.xml" /><br /> <import resource="classpath*:META-INF/cxf/cxf-servlet.xml" /><br /> <import resource="classpath:services.xml" /><br /> </beans>

services.xml文件的内容如下：

<?xml version="1.0" encoding="UTF-8"?><br /> <beans xmlns="http://www.springframework.org/schema/beans"<br /> xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"<br /> xmlns:jaxws="http://cxf.apache.org/jaxws"<br /> xsi:schemaLocation="<br /> http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd<br /> http://cxf.apache.org/jaxws http://cxf.apache.org/schemas/jaxws.xsd"><br /> <jaxws:endpoint id="webServiceHelloWorld"<br /> address="/HelloWorld" implementor="com.cxf.test.interfaces.HelloWorldImpl"/><br /> </beans>

web.xml文件的内容如下：

<?xml version="1.0" encoding="UTF-8"?><br /> <web-app id="WebApp_ID" version="2.4" xmlns="http://java.sun.com/xml/ns/j2ee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"><br /> <display-name>cxfservice</display-name><br /> <context-param><br /> <param-name>contextConfigLocation</param-name><br /> <param-value>WEB-INF/classes/applicationContext.xml</param-value><br /> </context-param><br /> <listener><br /> <listener-class><br /> org.springframework.web.context.ContextLoaderListener<br /> </listener-class><br /> </listener><br /> <servlet><br /> <servlet-name>CXFServlet</servlet-name><br /> <servlet-class><br /> org.apache.cxf.transport.servlet.CXFServlet<br /> </servlet-class><br /> </servlet><br /> <servlet-mapping><br /> <servlet-name>CXFServlet</servlet-name><br /> <url-pattern>/services/*</url-pattern><br /> </servlet-mapping></p> <p> <welcome-file-list><br /> <welcome-file>index.html</welcome-file><br /> <welcome-file>index.htm</welcome-file><br /> <welcome-file>index.jsp</welcome-file><br /> <welcome-file>default.html</welcome-file><br /> <welcome-file>default.htm</welcome-file><br /> <welcome-file>default.jsp</welcome-file><br /> </welcome-file-list><br /> </web-app>

（3）发布的HelloWord服务说明

    要发布的HelloWorld服务的接口定义文件com.cxf.test.interfaces.HelloWorld：

package com.cxf.test.interfaces;</p> <p>import javax.jws.WebParam;<br /> import javax.jws.WebResult;<br /> import javax.jws.WebService;</p> <p>@WebService<br /> public interface HelloWorld<br /> {<br /> /*<br /> * 一个简单的方法,返回一个字符串<br /> *<br /> * @param hello<br /> *<br /> * @return<br /> */<br /> String say(String hello);</p> <p> /**<br /> * 稍微复杂一些的方法,传递一个对象给服务端处理<br /> *<br /> * @param user<br /> * @return<br /> */<br /> String sayUserName(@WebParam(name = "user") UserDTO user);</p> <p> /**<br /> * 最复杂的方法,返回一个List封装的对象集合<br /> *<br /> * @return<br /> */<br /> public @WebResult(partName = "o") ListObject findUsers();<br /> }

      要发布的HelloWorld服务的接口实现类com.cxf.test.interfaces.HelloWorldImpl：

package com.cxf.test.interfaces;</p> <p>import java.util.ArrayList;</p> <p>import javax.jws.WebService;</p> <p>/**<br /> * @author zhangzk<br /> *<br /> */<br /> /**<br /> * WebService实现类.<br /> *<br /> * 使用@WebService指向Interface定义类即可.<br /> */<br /> @WebService(endpointInterface = "com.cxf.test.interfaces.HelloWorld")<br /> public class HelloWorldImpl implements HelloWorld<br /> {<br /> public String sayUserName(UserDTO user)<br /> {<br /> return "hello " + user.getName();<br /> }</p> <p> public String say(String hello)<br /> {<br /> return "hello " + hello;<br /> }</p> <p> public ListObject findUsers()<br /> {<br /> ArrayList<Object> list = new ArrayList<Object>();</p> <p> list.add(instancUser(1, "lib"));<br /> list.add(instancUser(2, "mld"));<br /> list.add(instancUser(3, "lq"));<br /> list.add(instancUser(4, "gj"));<br /> ListObject o = new ListObject();<br /> o.setList(list);<br /> return o;<br /> }</p> <p> private UserDTO instancUser(Integer id, String name)<br /> {<br /> UserDTO user = new UserDTO();<br /> user.setId(id);<br /> user.setName(name);<br /> return user;<br /> }<br /> }

       findUsers()接口返回的参数对象定义文件com.cxf.test.interfaces.ListObject：

package com.cxf.test.interfaces;</p> <p>import java.util.ArrayList;<br /> import java.util.List;</p> <p>import javax.xml.bind.annotation.XmlAccessType;<br /> import javax.xml.bind.annotation.XmlAccessorType;<br /> import javax.xml.bind.annotation.XmlElement;<br /> import javax.xml.bind.annotation.XmlType;</p> <p>@XmlAccessorType(XmlAccessType.FIELD)<br /> @XmlType(name = "listObject", propOrder ={ "list" })<br /> public class ListObject<br /> {<br /> @XmlElement(nillable = true)<br /> protected List<Object> list;</p> <p> /**<br /> * Gets the value of the list property.<br /> *<br /> * <p><br /> * This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be<br /> * present inside the JAXB object. This is why there is not a <CODE>set</CODE> method for the list property.<br /> *<br /> * <p><br /> * For example, to add a new item, do as follows:<br /> *<br /> * <pre><br /> * getList().add(newItem);<br /> * </pre><br /> *<br /> *<br /> * <p><br /> * Objects of the following type(s) are allowed in the list {@link Object }<br /> *<br /> *<br /> */<br /> public List<Object> getList()<br /> {<br /> if (list == null)<br /> {<br /> list = new ArrayList<Object>();<br /> }<br /> return this.list;<br /> }</p> <p> public void setList(ArrayList<Object> list)<br /> {<br /> this.list = list;<br /> }</p> <p>}<br />

        UserDTO instancUser(Integer id, String name)接口返回的对象定义文件com.cxf.test.interfaces.UserDTO：

package com.cxf.test.interfaces;</p> <p>import javax.xml.bind.annotation.XmlAccessType;<br /> import javax.xml.bind.annotation.XmlAccessorType;<br /> import javax.xml.bind.annotation.XmlType;</p> <p>/**<br /> * Web Service传输User信息的DTO.<br /> *<br /> * 分离entity类与web service接口间的耦合，隔绝entity类的修改对接口的影响. 使用JAXB 2.0的annotation标注JAVA-XML映射，尽量使用默认约定.<br /> *<br /> */<br /> @XmlAccessorType(XmlAccessType.FIELD)<br /> @XmlType(name = "User")<br /> public class UserDTO<br /> {</p> <p> protected Integer id;</p> <p> protected String name;</p> <p> public Integer getId()<br /> {<br /> return id;<br /> }</p> <p> public void setId(Integer value)<br /> {<br /> id = value;<br /> }</p> <p> public String getName()<br /> {<br /> return name;<br /> }</p> <p> public void setName(String value)<br /> {<br /> name = value;<br /> }<br /> }

（4）将WEB工程发布到Tomcat下作为一个WEB应用，webContext为cxfservice，Port为9000

       启动Tomcat后，以如下方式访问http://localhost:9000/cxfservice/services/HelloWorld?wsdl即可看到我们发布的Webservices服务HelloWorld了。在浏览器中将看到的WSDL文件另存为HelloWorld.xml即为发布的Webservice的WSDL文件。后续的调用过程与其它的操作方式完全相同。