基于xfire实现webservice的实例



基于xfire实现webservice的实例

 

 

 

首先下载xfire的jar包,并导入项目当中

 

下载地址：http://xfire.codehaus.org/Download

 

 

 

  1. 编写实现类
    1. 首先建一个接口把对外开放的方法添加进该接口，实际上就是开放此接口让客户端

 

获得

 

 

 

 

 

  1. package com.test.service;
  3. public class HelloXfireImpl implements HelloXfire {
  5.     public String sayHello(String str) {
  6.         return str + ” this is xfire”;
  7.     }
  9. }

 

 

 

 

 

 

 

  1. 映射web.xml

 

通过配置web.xml来映射相应的路径，在web.xml添加如下代码

 

 

 

 

 

  1. <?xml version=”1.0″ encoding=”UTF-8″?>
  2. <web-app xmlns=”http://java.sun.com/xml/ns/javaee” xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance”
  3.     version=”2.5″
  4.     xsi:schemaLocation=”http://java.sun.com/xml/ns/javaee   http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd”>
  5.     <servlet>
  6.         <servlet-name>XFireServlet</servlet-name>
  7.         <servlet-class>org.codehaus.xfire.transport.http.XFireConfigurableServlet</servlet-class>
  8.         <load-on-startup>0</load-on-startup>
  9.     </servlet>
  10.     <servlet-mapping>
  11.         <servlet-name>XFireServlet</servlet-name>
  12.         <url-pattern>/services/*</url-pattern>
  13.     </servlet-mapping>
  14.     <welcome-file-list>
  15.         <welcome-file>index.jsp</welcome-file>
  16.     </welcome-file-list>
  17. </web-app>

 

 

 

3.services配置文件

 

        创建services文件

 

               在src目录下创建META-INF目录，在该目录下创建一个xfire目录在该目录

 

               下创建services.xml

 

通过配置此文件来公开我们的接口，客户端可以通过此文件的映射可以找到相应的需要公开的接口

 

 

 

  1. <?xml version=”1.0″ encoding=”UTF-8″?>
  2. <beans xmlns=”http://xfire.codehaus.org/config/1.0″>
  4.     <service>
  5.         <name>HelloXfire</name>
  6.         <serviceClass>com.test.service.HelloXfire</serviceClass>
  7.         <implementationClass>
  8.             com.test.service.HelloXfireImpl
  9.         </implementationClass>
  10.         <mce:style><!–
  11. wrapped
  12. –></mce:style><style mce_bogus=”1″>wrapped</style>
  13.         <use>literal</use>
  14.         <scope>application</scope>
  15.     </service></beans>

 

 

 

获取wsdl文件的地址

 

 什么是wsdl？

 

 参考: http://blog.csdn.net/sunchaohuang/archive/2008/10/14/3076375.aspx

 

 通过web.xml与services.xml对地址的映射我们可以获得如下地址并进行访问后就可
以得到wsdl文件的url了

 

访问的地址：
http://localhost:9099/HelloXfire/services/HelloXfire?wsdl

 

访问后会得到一个类似xml格式的内容 该文件就是一个wsdl文件

 

4.编写客户端

 

       客户端获得webservice的url地址后创建对外开放的接口的实体类，然后向相应的方法传递参数，经过服务端相应的处理返回需要的结果

 

 

 

  1. package com.test.client;
  3. import java.net.MalformedURLException;
  5. import org.codehaus.xfire.XFireFactory;
  6. import org.codehaus.xfire.client.XFireProxyFactory;
  7. import org.codehaus.xfire.service.Service;
  8. import org.codehaus.xfire.service.binding.ObjectServiceFactory;
  10. import com.test.service.HelloXfire;
  12. public class HelloXfireClient {
  14.     /**
  15.      * @param args
  16.      */
  17.     public static void main(String[] args) {
  18.         Service srvcModel = new ObjectServiceFactory().create(HelloXfire.class);
  19.         XFireProxyFactory factory = new XFireProxyFactory(XFireFactory
  20.                 .newInstance().getXFire());
  21.         String helloWorldURL = ”http://localhost:9099/HelloXfire/services/HelloXfire”;
  22.         try {
  23.             HelloXfire srvc = (HelloXfire) factory.create(srvcModel,
  24.                     helloWorldURL);
  25.             String result = srvc.sayHello(“hello ”);
  26.             System.out.print(result);
  27.         } catch (MalformedURLException e) {
  28.             e.printStackTrace();
  29.         }
  30.     }
  32. }

  

 

 

不同项目的webservice调用

 

       一般情况下webservice的调用都是在不同的项目间或者不同的语言中来使用的

 

       如果是不同的语言调用webservice应用：

 

              客户端如果是其他语言，则通过得到服务端生成的wsdl或者或者wsdl文件的
地址做相应的操作得到本语言具体的客户端实现类来调用服务端对外开放的
方法

 

    如果是不同项目间的调用（java语言为例）

 


        在myeclipse下新建一个web service Client选择xfire下一步后选择wsdl的
地址:
http://localhost:9099/HelloXfire/services/HelloXfire?wsdl

 

       完成后会自动生成相应的客户端类。

 

        在HelloXfireClient类中调取服务端对外开放的接口方法获得相应数据

 

        具体代码如下

 

 

 

 

 

 

 

 

 

  1. package com.test.service;
  3. import java.net.MalformedURLException;
  4. import java.util.Collection;
  5. import java.util.HashMap;
  6. import javax.xml.namespace.QName;
  7. import org.codehaus.xfire.XFireRuntimeException;
  8. import org.codehaus.xfire.aegis.AegisBindingProvider;
  9. import org.codehaus.xfire.annotations.AnnotationServiceFactory;
  10. import org.codehaus.xfire.annotations.jsr181.Jsr181WebAnnotations;
  11. import org.codehaus.xfire.client.XFireProxyFactory;
  12. import org.codehaus.xfire.jaxb2.JaxbTypeRegistry;
  13. import org.codehaus.xfire.service.Endpoint;
  14. import org.codehaus.xfire.service.Service;
  15. import org.codehaus.xfire.soap.AbstractSoapBinding;
  16. import org.codehaus.xfire.transport.TransportManager;
  18. public class HelloXfireClient {
  20.     private static XFireProxyFactory proxyFactory = new XFireProxyFactory();
  21.     private HashMap endpoints = new HashMap();
  22.     private Service service0;
  24.     public HelloXfireClient() {
  25.         create0();
  26.         Endpoint HelloXfirePortTypeLocalEndpointEP = service0 .addEndpoint(new QName(“http://service.test.com”, ”HelloXfirePortTypeLocalEndpoint”), new QName(“http://service.test.com”, ”HelloXfirePortTypeLocalBinding”), ”xfire.local://HelloXfire”);
  27.         endpoints.put(new QName(“http://service.test.com”, ”HelloXfirePortTypeLocalEndpoint”), HelloXfirePortTypeLocalEndpointEP);
  28.         Endpoint HelloXfireHttpPortEP = service0 .addEndpoint(new QName(“http://service.test.com”, ”HelloXfireHttpPort”), new QName(“http://service.test.com”, ”HelloXfireHttpBinding”), ”http://localhost:9099/HelloXfire/services/HelloXfire”);
  29.         endpoints.put(new QName(“http://service.test.com”, ”HelloXfireHttpPort”), HelloXfireHttpPortEP);
  30.     }
  32.     public Object getEndpoint(Endpoint endpoint) {
  33.         try {
  34.             return proxyFactory.create((endpoint).getBinding(), (endpoint).getUrl());
  35.         } catch (MalformedURLException e) {
  36.             throw new XFireRuntimeException(“Invalid URL”, e);
  37.         }
  38.     }
  40.     public Object getEndpoint(QName name) {
  41.         Endpoint endpoint = ((Endpoint) endpoints.get((name)));
  42.         if ((endpoint) == null) {
  43.             throw new IllegalStateException(“No such endpoint!”);
  44.         }
  45.         return getEndpoint((endpoint));
  46.     }
  48.     public Collection getEndpoints() {
  49.         return endpoints.values();
  50.     }
  52.     private void create0() {
  53.         TransportManager tm = (org.codehaus.xfire.XFireFactory.newInstance().getXFire().getTransportManager());
  54.         HashMap props = new HashMap();
  55.         props.put(“annotations.allow.interface”, true);
  56.         AnnotationServiceFactory asf = new AnnotationServiceFactory(new Jsr181WebAnnotations(), tm, new AegisBindingProvider(new JaxbTypeRegistry()));
  57.         asf.setBindingCreationEnabled(false);
  58.         service0 = asf.create((com.test.service.HelloXfirePortType.class), props);
  59.         {
  60.             AbstractSoapBinding soapBinding = asf.createSoap11Binding(service0, new QName(“http://service.test.com”, ”HelloXfirePortTypeLocalBinding”), ”urn:xfire:transport:local”);
  61.         }
  62.         {
  63.             AbstractSoapBinding soapBinding = asf.createSoap11Binding(service0, new QName(“http://service.test.com”, ”HelloXfireHttpBinding”), ”http://schemas.xmlsoap.org/soap/http”);
  64.         }
  65.     }
  67.     public HelloXfirePortType getHelloXfirePortTypeLocalEndpoint() {
  68.         return ((HelloXfirePortType)(this).getEndpoint(new QName(“http://service.test.com”, ”HelloXfirePortTypeLocalEndpoint”)));
  69.     }
  71.     public HelloXfirePortType getHelloXfirePortTypeLocalEndpoint(String url) {
  72.         HelloXfirePortType var = getHelloXfirePortTypeLocalEndpoint();
  73.         org.codehaus.xfire.client.Client.getInstance(var).setUrl(url);
  74.         return var;
  75.     }
  77.     public HelloXfirePortType getHelloXfireHttpPort() {
  78.         return ((HelloXfirePortType)(this).getEndpoint(new QName(“http://service.test.com”, ”HelloXfireHttpPort”)));
  79.     }
  81.     public HelloXfirePortType getHelloXfireHttpPort(String url) {
  82.         HelloXfirePortType var = getHelloXfireHttpPort();
  83.         org.codehaus.xfire.client.Client.getInstance(var).setUrl(url);
  84.         return var;
  85.     }
  87.     public static void main(String[] args) {
  90.         HelloXfireClient client = new HelloXfireClient();
  92.         //create a default service endpoint
  93.         HelloXfirePortType service = client.getHelloXfireHttpPort();
  94.         String  string= service.sayHello(“hello”);
  95.         System.out.println(string);
  97.         //TODO: Add custom client code here
  98.                 //
  99.                 //service.yourServiceOperationHere();
  101.         System.out.println(“test client completed”);
  102.                 System.exit(0);
  103.     }
  105. }

 

 

 

 

 

如果能够成功运行并正确获得调用的方法返回的值说明webservice成功实现了

 

 

 

 

 

 

常见错误及解决办法：

 

 

 

       1.jar包冲突

 

       如果运行后得到以下错误

 

org.codehaus.xfire.XFireRuntimeException: Could not invoke service.. Nested exception is org.codehaus.xfire.fault.XFireFault: Could not marshall type.

 

 

 

说明jar包有冲突

 

解决办法

 

如果发现以下的包用多个

 

jaxb-api-1.0.jar
jaxb-api-2.0.jar
jaxb-impl-1.0.5.jar
jaxb-impl-2.0.1.jar

 

则删除低版本的

 

 

  2. Could not find valid implementation for: 2.0

 

如果出现如下错误

 

java.lang.IllegalStateException: Could not find valid implementation for: 2.0
at org.apache.xbean.spring.context.impl.XBeanHelper.createBeanDefinitionReader(XBeanHelper.java:48)
at org.codehaus.xfire.spring.XFireConfigLoader.getXFireApplicationContext(XFireConfigLoader.java:74)
at org.codehaus.xfire.spring.XFireConfigLoader.loadContext(XFireConfigLoader.java:41)
at org.codehaus.xfire.transport.http.XFireConfigurableServlet.loadConfig(XFireConfigurableServlet.java:86)

 

 

问题的原因是因为xfire不支持spring2.0的新特性，需要修改service.xml文件，将beans元素的命名空间放到services元素上，修改后的xml如下：

 

<beans>

 

 <services xmlns=”http://xfire.codehaus.org/config/1.0″>

 

 </services>

 

</beans>

 

另外，由于我使用了MyEclipse的Spring Capailities和WebService Capailities（使用xfire），由于后者自带了Spring1.2.6的包，造成了和2.0版本的冲突，所以必须作以下工作：

 

    删除<MyEclise_Home>/eclipse/plugins/com.genuitec.eclipse.ws.xfire_5.9.100/data/1.2/lib目录的Spring1.2.6包

 

    删除Tomcat/Webapps/<项目目录>/WEB-INF/lib目录下的Spring1.2.6包（好像重新部署不能删除已经存在的包）

 

    重新启动MyEclipse

 

问题解决。