使用 CXF 做 webservice 简单例子

转:http://www.cnblogs.com/frankliiu-java/articles/1641949.html

Apache CXF 是一个开放源代码框架,提供了用于方便地构建和开发 Web 服务的可靠基础架构。它允许创建高性能和可扩展的服务,您可以将这样的服务部署在 Tomcat 和基于 Spring 的轻量级容器中,以及部署在更高级的服务器上,例如 Jboss、IBM® WebSphere® 或 BEA WebLogic。

该框架提供了以下功能:

  • Web 服务标准支持:CXF 支持以下 Web 服务标准:
    • Java API for XML Web Services (JAX-WS)
    • SOAP
    • Web 服务描述语言(Web Services Description Language ,WSDL)
    • 消息传输优化机制(Message Transmission Optimization Mechanism,MTOM)
    • WS-Basic Profile
    • WS-Addressing
    • WS-Policy
    • WS-ReliableMessaging
    • WS-Security
  • 前端建模:CXF 提供了前端建模的概念,允许您使用不同的前端 API 来创建 Web 服务。API 允许您使用简单的工厂 Bean 并通过 JAX-WAS 实现来创建 Web 服务。它还允许您创建动态 Web 服务客户端。
  • 工具支持:CXF 提供了用于在 Java Bean、Web 服务和 WSDL 之间进行转换的不同工具。它提供了对 Maven 和 Ant 集成的支持,并无缝地支持 Spring 集成。
  • RESTful 服务支持:CXF 支持代表性状态传输(Representational State Transfer,RESTful )服务的概念,并支持 Java 平台的 JAX-RS 实现。(本系列的第 2 部分将提供有关 RESTful 服务的更多信息。)
  • 对不同传输和绑定的支持:CXF 支持不同种类的传输,从 XML 到逗号分隔值 (CSV)。除了支持 SOAP 和 HTTP 协议绑定之外,它还支持 Java Architecture for XML Binding (JAXB) 和 AEGIS 数据绑定。
  • 对非 XML 绑定的支持:CXF 支持非 XML 绑定,例如 JavaScript Object Notation (JSON) 和 Common Object Request Broker Architecture (CORBA)。它还支持 Java 业务集成(Java Business Integration,JBI)体系架构和服务组件体系架构(Service Component Architecture,SCA)。
  • code first 或者 xml first:支持使用code first 或者 xml first 的方式来创建web服务。

一 借助 annotation 创建独立启动的web 服务。

准备: 新建工程 导入需要的jar 包:

依赖的包:

commons-logging-1.1.jar
geronimo-activation_1.1_spec-1.0-M1.jar (or Sun's Activation jar)
geronimo-annotation_1.0_spec-1.1.jar (JSR 250)
geronimo-javamail_1.4_spec-1.0-M1.jar (or Sun's JavaMail jar)
geronimo-servlet_2.5_spec-1.1-M1.jar (or Sun's Servlet jar)
geronimo-ws-metadata_2.0_spec-1.1.1.jar (JSR 181)
jaxb-api-2.1.jar
jaxb-impl-2.1.6.jar
jaxws-api-2.1.jar
jetty-6.1.5.jar
jetty-util-6.1.5.jar
neethi-2.0.jar
saaj-api-1.3.jar
saaj-impl-1.3.jar
stax-api-1.0.1.jar
wsdl4j-1.6.1.jar
wstx-asl-3.2.1.jar
XmlSchema-1.2.jar
xml-resolver-1.2.jar

spring jar包, 用来支持xml配置:

aopalliance-1.0.jar
spring-core-2.0.4.jar
spring-beans-2.0.4.jar
spring-context-2.0.4.jar
spring-web-2.0.4.jar

CXF jar包:

cxf-2.1.jar

以上jar 包 可从apache官方网站下载apache-cxf-2.1.2.zip, 然后从apache-cxf-2.1.2/lib 目录中获得

1 首先服务点接口。

[java] view plain copy
  1. packagecom.demo;
  2. importjava.util.List;
  3. importjavax.jws.WebParam;
  4. importjavax.jws.WebService;
  5. @WebService
  6. publicinterfaceHelloWorld{
  7. StringsayHi(@WebParam(name="text")Stringtext);
  8. StringsayHiToUser(Useruser);
  9. String[]SayHiToUserList(List<User>userList);
  10. }

· 2 编写服务实现

[java] view plain copy
  1. packagecom.demo;
  2. importjava.util.LinkedHashMap;
  3. importjava.util.List;
  4. importjava.util.Map;
  5. importjavax.jws.WebService;
  6. @WebService(endpointInterface="com.demo.HelloWorld",serviceName="HelloWorld")
  7. publicclassHelloWorldImplimplementsHelloWorld{
  8. Map<Integer,User>users=newLinkedHashMap<Integer,User>();
  9. publicStringsayHi(Stringtext){
  10. return"Hello"+text;
  11. }
  12. publicStringsayHiToUser(Useruser){
  13. users.put(users.size()+1,user);
  14. return"Hello"+user.getName();
  15. }
  16. publicString[]SayHiToUserList(List<User>userList){
  17. String[]result=newString[userList.size()];
  18. inti=0;
  19. for(Useru:userList){
  20. result[i]="Hello"+u.getName();
  21. i++;
  22. }
  23. returnresult;
  24. }
  25. }

3 编写 webServiceApp.java类来暴露 web服务。

[java] view plain copy
  1. packagecom.demo;
  2. importjavax.xml.ws.Endpoint;
  3. publicclasswebServiceApp{
  4. publicstaticvoidmain(String[]args){
  5. System.out.println("webservicestart");
  6. HelloWorldImplimplementor=newHelloWorldImpl();
  7. Stringaddress="http://localhost:8080/helloWorld";
  8. Endpoint.publish(address,implementor);
  9. System.out.println("webservicestarted");
  10. }
  11. }

4 run webServiceApp.java 类来启动服务。 访问http://localhost:8080/helloWorld?wsdl 查看是否显示

wsdl。

5编写客户端访问服务。

[java] view plain copy
  1. packagecom.demo;
  2. importjava.util.ArrayList;
  3. importjava.util.List;
  4. importorg.apache.cxf.jaxws.JaxWsProxyFactoryBean;
  5. importorg.springframework.context.support.ClassPathXmlApplicationContext;
  6. publicclassHelloWorldClient{
  7. publicstaticvoidmain(String[]args){
  8. JaxWsProxyFactoryBeansvr=newJaxWsProxyFactoryBean();
  9. svr.setServiceClass(HelloWorld.class);
  10. svr.setAddress("http://localhost:8080/helloWorld");
  11. HelloWorldhw=(HelloWorld)svr.create();
  12. Useruser=newUser();
  13. user.setName("Tony");
  14. user.setDescription("test");
  15. System.out.println(hw.sayHiToUser(user));
  16. }
  17. }

6测试: run webServiceApp.java 类来启动服务,然后 run HelloWorldClient.java 来访问服务。


二 集成到spring 中。

1 在 web.xml 中加入 :

[html] view plain copy
  1. <?xmlversion="1.0"encoding="UTF-8"?>
  2. <web-app>
  3. <welcome-file-list>
  4. <welcome-file>index.jsp</welcome-file>
  5. </welcome-file-list>
  6. <context-param>
  7. <param-name>contextConfigLocation</param-name>
  8. <param-value>WEB-INF/classes/applicationContext.xml</param-value>
  9. </context-param>
  10. <listener>
  11. <listener-class>
  12. org.springframework.web.context.ContextLoaderListener
  13. </listener-class>
  14. </listener>
  15. <servlet>
  16. <servlet-name>CXFServlet</servlet-name>
  17. <display-name>CXFServlet</display-name>
  18. <servlet-class>
  19. org.apache.cxf.transport.servlet.CXFServlet
  20. </servlet-class>
  21. <load-on-startup>1</load-on-startup>
  22. </servlet>
  23. <servlet-mapping>
  24. <servlet-name>CXFServlet</servlet-name>
  25. <url-pattern>/webservice/*</url-pattern>
  26. </servlet-mapping>
  27. </web-app>

2 在 applicationContext.xml 中加入:

[html] view plain copy
  1. <?xmlversion="1.0"encoding="UTF-8"?>
  2. <beansxmlns="http://www.springframework.org/schema/beans"
  3. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4. xmlns:jaxws="http://cxf.apache.org/jaxws"
  5. xsi:schemaLocation="
  6. http://www.springframework.org/schema/beans
  7. http://www.springframework.org/schema/beans/spring-beans.xsd
  8. http://cxf.apache.org/jaxwshttp://cxf.apache.org/schemas/jaxws.xsd">
  9. <importresource="classpath:META-INF/cxf/cxf.xml"/>
  10. <importresource="classpath:META-INF/cxf/cxf-extension-soap.xml"/>
  11. <importresource="classpath:META-INF/cxf/cxf-servlet.xml"/>
  12. <jaxws:endpoint
  13. id="helloWorld"
  14. implementor="com.demo.HelloWorldImpl"
  15. address="/helloWorld"/>
  16. <beanid="client"class="com.demo.HelloWorld"
  17. factory-bean="clientFactory"factory-method="create"/>
  18. <beanid="clientFactory"class="org.apache.cxf.jaxws.JaxWsProxyFactoryBean">
  19. <propertyname="serviceClass"value="com.demo.HelloWorld"/>
  20. <propertyname="address"
  21. value="http://localhost:8080/s/webservice/helloWorld"/>
  22. </bean>
  23. </beans>

注意: 这里需要加入 xmlns:jaxws="http://cxf.apache.org/jaxws"

http://cxf.apache.org/jaxwshttp://cxf.apache.org/schemas/jaxws.xsd

3 修改客户端。

[java] view plain copy
  1. packagecom.demo;
  2. importjava.util.ArrayList;
  3. importjava.util.List;
  4. importorg.apache.cxf.jaxws.JaxWsProxyFactoryBean;
  5. importorg.springframework.context.support.ClassPathXmlApplicationContext;
  6. publicclassHelloWorldClient{
  7. publicstaticvoidmain(String[]args){
  8. HelloWorldclient=(HelloWorld)context.getBean("client");
  9. Useruser1=newUser();
  10. user1.setName("Tony");
  11. user1.setDescription("test");
  12. Useruser2=newUser();
  13. user2.setName("freeman");
  14. user2.setDescription("test");
  15. List<User>userList=newArrayList<User>();
  16. userList.add(user1);
  17. userList.add(user2);
  18. String[]res=client.SayHiToUserList(userList);
  19. System.out.println(res[0]);
  20. System.out.println(res[1]);
  21. }
  22. }

4 发布工程启动web服务器(我用 tomcat 6)。

5访问http://localhost:8080/s/webservice/helloWorld?wsdl查看是否显示 wsdl 。

6run run HelloWorldClient.java 来访问服务。

你可能感兴趣的:(使用 CXF 做 webservice 简单例子)