Java Web Service Apache CXF 学习

    项目中用到web service，于是研究了二天，下面根据这二天用到的总结一下，当然最多的还是根据apache cxf官网文档http://cxf.apache.org 看文档，当然也不是都看，只看了自己需要的。

 

基础知识学习—— Hello Demo

 

    Hello Demo开始了！

 

第一，新建HelloDemo Web 项目 导入jar包。jar包从http://cxf.apache.org下载。

 

第二，新建接口IHello.java及其实现类，包为：test.hello 代码如下：

 

接口：IHello.java

package test.hello; import javax.jws.WebParam; import javax.jws.WebService; @WebService(targetNamespace = "test.hello.ns") public interface IHello { public String sayHello(@WebParam(name = "name") String name); }

 

实现类：HelloImpl.java

package test.hello; import javax.jws.WebParam; import javax.jws.WebService; @WebService(endpointInterface = "test.hello.IHello", targetNamespace = "test.hello.ns") public class HelloImpl implements IHello { public String sayHello(@WebParam(name = "name") String name) { return "Hello " + name; } }

 

在此理解两个注解 @WebService @WebParam 可以看API，@WebService说明是一个web 服务，参数targetNamespace 指名命名空间，注意接口与实现类命名空间必须是一致的，如果不是一致会报错。

 

第三，在WEB-INF下新建beans.xml 代码如下：

 

<?xml version="1.0" encoding="UTF-8" ?> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:jaxws="http://cxf.apache.org/jaxws" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://cxf.apache.org/jaxws http://cxf.apache.org/schemas/jaxws.xsd"> <import resource="classpath:META-INF/cxf/cxf.xml" /> <import resource="classpath:META-INF/cxf/cxf-extension-soap.xml" /> <import resource="classpath:META-INF/cxf/cxf-servlet.xml" /> <jaxws:endpoint id="hello" implementor="test.hello.HelloImpl" address="/hello"> </jaxws:endpoint> </beans>

 

第四，配置 web.xml 主要是配置cxf的 servlet 如下：

 

<?xml version="1.0" encoding="UTF-8"?> <web-app version="2.5" xmlns="http://java.sun.com/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"> <context-param> <param-name>contextConfigLocation</param-name> <param-value>WEB-INF/beans.xml</param-value> </context-param> <listener> <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class> </listener> <servlet> <servlet-name>CXFServlet</servlet-name> <servlet-class>org.apache.cxf.transport.servlet.CXFServlet</servlet-class> <load-on-startup>5</load-on-startup> </servlet> <servlet-mapping> <servlet-name>CXFServlet</servlet-name> <url-pattern>/ws/*</url-pattern> </servlet-mapping> <welcome-file-list> <welcome-file>index.jsp</welcome-file> </welcome-file-list> </web-app>

第五，部署到tomcat测试！

 

如果用apache-cxf-2.1.8 的jar,可能会报错，缺少jar包，ant-launcher-1.6.5.jar 可以到http://www.jarfinder.com 下载该包。

 

启动tomcat 如果没有错，打开http://127.0.0.1:8080/HelloDemo/ws/hello?wsdl 查看是否生成了wsdl wsdl如下：

<?xml version="1.0" encoding="UTF-8" ?> - <wsdl:definitions name="HelloImplService" targetNamespace="test.hello.ns" xmlns:ns1="http://cxf.apache.org/bindings/xformat" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:tns="test.hello.ns" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> - <wsdl:types> - <xs:schema elementFormDefault="unqualified" targetNamespace="test.hello.ns" version="1.0" xmlns:tns="test.hello.ns" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:element name="sayHello" type="tns:sayHello" /> <xs:element name="sayHelloResponse" type="tns:sayHelloResponse" /> - <xs:complexType name="sayHello"> - <xs:sequence> <xs:element minOccurs="0" name="name" type="xs:string" /> </xs:sequence> </xs:complexType> - <xs:complexType name="sayHelloResponse"> - <xs:sequence> <xs:element minOccurs="0" name="return" type="xs:string" /> </xs:sequence> </xs:complexType> </xs:schema> </wsdl:types> - <wsdl:message name="sayHello"> <wsdl:part element="tns:sayHello" name="parameters" /> </wsdl:message> - <wsdl:message name="sayHelloResponse"> <wsdl:part element="tns:sayHelloResponse" name="parameters" /> </wsdl:message> - <wsdl:portType name="IHello"> - <wsdl:operation name="sayHello"> <wsdl:input message="tns:sayHello" name="sayHello" /> <wsdl:output message="tns:sayHelloResponse" name="sayHelloResponse" /> </wsdl:operation> </wsdl:portType> - <wsdl:binding name="HelloImplServiceSoapBinding" type="tns:IHello"> <soap:binding style="document" mce_style="document" transport="http://schemas.xmlsoap.org/soap/http" /> - <wsdl:operation name="sayHello"> <soap:operation soapAction="" style="document" mce_style="document" /> - <wsdl:input name="sayHello"> <soap:body use="literal" /> </wsdl:input> - <wsdl:output name="sayHelloResponse"> <soap:body use="literal" /> </wsdl:output> </wsdl:operation> </wsdl:binding> - <wsdl:service name="HelloImplService"> - <wsdl:port binding="tns:HelloImplServiceSoapBinding" name="HelloImplPort"> <soap:address location="http://127.0.0.1:8080/HelloDemo/ws/hello" /> </wsdl:port> </wsdl:service> </wsdl:definitions>

 

再测试 http://127.0.0.1:8080/HelloDemo/ws/hello/sayHello?name=lingdes 是否成功，显示如下：

 

- <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> - <soap:Body> - <ns2:sayHelloResponse xmlns:ns2="test.hello.ns"> <return>Hello lingdes</return> </ns2:sayHelloResponse> </soap:Body> </soap:Envelope>

如果显示成功，于是证明web service 的服务器端部署成功，web service的构建与发布成功！

 

第六，编写web service 客户端

 

(1) 新建java项目 HelloDemoClient 导入jar包。

 

(2) 新建接口，同IHello.java 代码如下：

package client; import javax.jws.WebParam; import javax.jws.WebService; @WebService(targetNamespace = "test.hello.ns") public interface IHello { public String sayHello(@WebParam(name = "name") String name); }

(2)、新建文件夹WEB-INF, 同时新建beans.xml 文件 ，代码如下：

<?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:jaxws="http://cxf.apache.org/jaxws" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://cxf.apache.org/jaxws http://cxf.apache.org/schemas/jaxws.xsd"> <jaxws:client id="helloDemo" address="http://127.0.0.1:8080/HelloDemo/ws/hello" serviceClass="client.IHello" /> </beans>

(3) 新建client 如下：

package client; import org.springframework.context.ApplicationContext; import org.springframework.context.support.ClassPathXmlApplicationContext; public class Client { public static void main(String[] args) { ApplicationContext context = new ClassPathXmlApplicationContext( "/WEB-INF/beans.xml"); IHello client = (IHello) context.getBean("helloDemo"); System.out.println(client.sayHello("lingdes")); } }

(4) 测试 在打开服务的前提下测试，即tomcat 启动 然后测试，测试如下就是正确的了。

Hello lingdes

 

到此，一个Java web service 的 HelloDemo 就完成了。

 

当然，还有在只知道 wsdl地址去调用web 服务，可以使用动态客户端。参考官网文档：  http://cxf.apache.org/docs/dynamic-clients.html 

 

上面是利用spring的方法编写，当然也可以利用factory的来编写。