Java调用webservice接口方法（SOAP message、xfire、axis）

2022-12-28 07:49:27

webservice的 发布一般都是使用WSDL（web service descriptive language）文件的样式来发布的，在WSDL文件里面，包含这个webservice暴露在外面可供使用的接口。今天搜索到了非常好的 webservice provider列表

http://www.webservicex.net/WCF/default.aspx

这上面列出了70多个包括很多方面的free webservice provider，utilities->global weather就可以获取全球的天气预报。

下面我们来看Java如何通过WSDL文件来调用这些web service：

注意，以下的代码并没有经过真正的测试，只是说明这些情况，不同版本的Axis相差很大，大家最好以apache网站上的例子为准，这里仅仅用于说明其基本用法。

一、利用jdk web服务api实现，这里使用基于 SOAP message 的 Web 服务 
1.首先建立一个Web services EndPoint：

Java代码 
  1. package Hello;
  2. import javax.jws.WebService;
  3. import javax.jws.WebMethod;
  4. import javax.xml.ws.Endpoint;
  5. @WebService
  6. public class Hello {
  7. @WebMethod
  8. public String hello(String name) {
  9. return "Hello, " + name + "\n";
  10. }
  11. public static void main(String[] args) {
  12. // create and publish an endpoint
  13. Hello hello = new Hello();
  14. Endpoint endpoint = Endpoint.publish("http://localhost:8080/hello", hello);
  15. }
  16. }
Java代码 
  1. package Hello;
  2. import javax.jws.WebService;
  3. import javax.jws.WebMethod;
  4. import javax.xml.ws.Endpoint;
  5. @WebService
  6. public class Hello {
  7. @WebMethod
  8. public String hello(String name) {
  9. return "Hello, " + name + "\n";
  10. }
  11. public static void main(String[] args) {
  12. // create and publish an endpoint
  13. Hello hello = new Hello();
  14. Endpoint endpoint = Endpoint.publish("http://localhost:8080/hello", hello);
  15. }
  16. }

2.使用 apt 编译 Hello.java(例：apt -d [存放编译后的文件目录] Hello.java ) ,会生成 jaws目录 
3.使用java Hello.Hello运行，然后将浏览器指向http://localhost:8080/hello?wsdl就会出现下列显示 
4.使用wsimport 生成客户端 
使用如下：wsimport -p . -keep http://localhost:8080/hello?wsdl 
5.客户端程序：

Java代码 
  1. class HelloClient{
  2. public static void main(String args[]) {
  3. HelloService service = new HelloService();
  4. Hello helloProxy = service.getHelloPort();
  5. String hello = helloProxy.hello("你好");
  6. System.out.println(hello);
  7. }
  8. }
Java代码 
  1. class HelloClient{
  2. public static void main(String args[]) {
  3. HelloService service = new HelloService();
  4. Hello helloProxy = service.getHelloPort();
  5. String hello = helloProxy.hello("你好");
  6. System.out.println(hello);
  7. }
  8. }

二、使用xfire，我这里使用的是myeclipse集成的xfire进行测试的 
利用xfire开发WebService，可以有三种方法： 
      1一种是从javabean 中生成； 
      2 一种是从wsdl文件中生成； 
      3 还有一种是自己建立webservice 
步骤如下： 
    用myeclipse建立webservice工程，目录结构如下： 
  
    首先建立webservice接口， 
     代码如下：

Java代码 
  1. package com.myeclipse.wsExample;
  2. //Generated by MyEclipse
  3. public interface IHelloWorldService {
  4. public String example(String message);
  5. }
Java代码 
  1. package com.myeclipse.wsExample;
  2. //Generated by MyEclipse
  3. public interface IHelloWorldService {
  4. public String example(String message);
  5. }
Java代码 
  1. package com.myeclipse.wsExample;
  2. //Generated by MyEclipse
  3. public class HelloWorldServiceImpl implements IHelloWorldService {
  4. public String example(String message) {
  5. return message;
  6. }
  7. }
Java代码 
  1. package com.myeclipse.wsExample;
  2. //Generated by MyEclipse
  3. public class HelloWorldServiceImpl implements IHelloWorldService {
  4. public String example(String message) {
  5. return message;
  6. }
  7. }

修改service.xml 文件，加入以下代码：

Xml代码 
  1. <service>
  2. <name>HelloWorldService</name>
  3. <serviceClass>
  4. com.myeclipse.wsExample.IHelloWorldService
  5. </serviceClass>
  6. <implementationClass>
  7. com.myeclipse.wsExample.HelloWorldServiceImpl
  8. </implementationClass>
  9. <style>wrapped</style>
  10. <use>literal</use>
  11. <scope>application</scope>
  12. </service>
Xml代码 
  1. <service>
  2. <name>HelloWorldService</name>
  3. <serviceClass>
  4. com.myeclipse.wsExample.IHelloWorldService
  5. </serviceClass>
  6. <implementationClass>
  7. com.myeclipse.wsExample.HelloWorldServiceImpl
  8. </implementationClass>
  9. <style>wrapped</style>
  10. <use>literal</use>
  11. <scope>application</scope>
  12. </service>

把整个项目部署到tomcat服务器中 ，打开浏览器，输入http://localhost:8989/HelloWorld/services/HelloWorldService?wsdl

客户端实现如下：

Java代码 
  1. package com.myeclipse.wsExample.client;
  2. import java.net.MalformedURLException;
  3. import java.net.URL;
  4. import org.codehaus.xfire.XFireFactory;
  5. import org.codehaus.xfire.client.Client;
  6. import org.codehaus.xfire.client.XFireProxyFactory;
  7. import org.codehaus.xfire.service.Service;
  8. import org.codehaus.xfire.service.binding.ObjectServiceFactory;
  9. import com.myeclipse.wsExample.IHelloWorldService;
  10. public class HelloWorldClient {
  11. public static void main(String[] args) throws MalformedURLException, Exception {
  12. // TODO Auto-generated method stub
  13. Service s=new ObjectServiceFactory().create(IHelloWorldService.class);
  14. XFireProxyFactory xf=new XFireProxyFactory(XFireFactory.newInstance().getXFire());
  15. String url="http://localhost:8989/HelloWorld/services/HelloWorldService";
  16. try
  17. {
  18. IHelloWorldService hs=(IHelloWorldService) xf.create(s,url);
  19. String st=hs.example("zhangjin");
  20. System.out.print(st);
  21. }
  22. catch(Exception e)
  23. {
  24. e.printStackTrace();
  25. }
  26. }
  27. }
Java代码 
  1. package com.myeclipse.wsExample.client;
  2. import java.net.MalformedURLException;
  3. import java.net.URL;
  4. import org.codehaus.xfire.XFireFactory;
  5. import org.codehaus.xfire.client.Client;
  6. import org.codehaus.xfire.client.XFireProxyFactory;
  7. import org.codehaus.xfire.service.Service;
  8. import org.codehaus.xfire.service.binding.ObjectServiceFactory;
  9. import com.myeclipse.wsExample.IHelloWorldService;
  10. public class HelloWorldClient {
  11. public static void main(String[] args) throws MalformedURLException, Exception {
  12. // TODO Auto-generated method stub
  13. Service s=new ObjectServiceFactory().create(IHelloWorldService.class);
  14. XFireProxyFactory xf=new XFireProxyFactory(XFireFactory.newInstance().getXFire());
  15. String url="http://localhost:8989/HelloWorld/services/HelloWorldService";
  16. try
  17. {
  18. IHelloWorldService hs=(IHelloWorldService) xf.create(s,url);
  19. String st=hs.example("zhangjin");
  20. System.out.print(st);
  21. }
  22. catch(Exception e)
  23. {
  24. e.printStackTrace();
  25. }
  26. }
  27. }

这里再说点题外话，有时候我们知道一个wsdl地址，比如想用java客户端引用.net 做得webservice，使用myeclipse引用，但是却出现无法通过验证的错误，这时我们可以直接在类中引用，步骤如下：

Java代码 
  1. public static void main(String[] args) throws MalformedURLException, Exception {
  2. // TODO Auto-generated method stub
  3. Service s=new ObjectServiceFactory().create(IHelloWorldService.class);
  4. XFireProxyFactory xf=new XFireProxyFactory(XFireFactory.newInstance().getXFire());
  5. //远程调用.net开发的webservice
  6. Client c=new Client(new URL("http://www.webxml.com.cn/webservices/qqOnlineWebService.asmx?wsdl"));
  7. Object[] o=c.invoke("qqCheckOnline", new String[]{"531086641","591284436"});
  8. //调用.net本机开发的webservice
  9. Client c1=new Client(new URL("http://localhost/zj/Service.asmx?wsdl"));
  10. Object[] o1=c1.invoke("HelloWorld",new String[]{});
  11. }
Java代码 
  1. public static void main(String[] args) throws MalformedURLException, Exception {
  2. // TODO Auto-generated method stub
  3. Service s=new ObjectServiceFactory().create(IHelloWorldService.class);
  4. XFireProxyFactory xf=new XFireProxyFactory(XFireFactory.newInstance().getXFire());
  5. //远程调用.net开发的webservice
  6. Client c=new Client(new URL("http://www.webxml.com.cn/webservices/qqOnlineWebService.asmx?wsdl"));
  7. Object[] o=c.invoke("qqCheckOnline", new String[]{"531086641","591284436"});
  8. //调用.net本机开发的webservice
  9. Client c1=new Client(new URL("http://localhost/zj/Service.asmx?wsdl"));
  10. Object[] o1=c1.invoke("HelloWorld",new String[]{});
  11. }

三、使用axis1.4调用webservice方法 
   前提条件：下载axis1.4包和tomcat服务器   ，并将axis文件夹复制到tomcat服务器的webapp文件夹中 
   这里我就说一下最简单的方法：

首先建立一个任意的java类（例如：HelloWorld.java），复制到axis文件夹下,将其扩展名改为jws，然后重新启动tomcat，在浏览器中输入http://localhost:8989/axis/HelloWorld.jws?wsdl，就会得到一个wsdl文件，其客户端调用方法如下：

Java代码 
  1. import javax.xml.rpc.Service;
  2. import javax.xml.rpc.ServiceException;
  3. import javax.xml.rpc.ServiceFactory;
  4. import java.net.MalformedURLException;
  5. import java.net.URL;
  6. import java.rmi.RemoteException;
  7. import javax.xml.namespace.QName;
  8. public class TestHelloWorld {
  9. public static void main(String[] args) throws MalformedURLException, ServiceException, RemoteException {
  10. // TODO Auto-generated method stub
  11. String wsdlUrl ="http://localhost:8989/axis/HelloWorld.jws?wsdl";
  12. String nameSpaceUri ="http://localhost:8989/axis/HelloWorld.jws";
  13. String serviceName = "HelloWorldService";
  14. String portName = "HelloWorld";
  15. ServiceFactory serviceFactory = ServiceFactory.newInstance();
  16. Service afService =serviceFactory.createService(new URL(wsdlUrl),new QName(nameSpaceUri, serviceName));
  17. HelloWorldInterface proxy = (HelloWorldInterface)afService.getPort(new QName(nameSpaceUri, portName),HelloWorldInterface.class);
  18. System.out.println("return value is "+proxy.getName("john") ) ;
  19. }
  20. }
Java代码 
  1. import javax.xml.rpc.Service;
  2. import javax.xml.rpc.ServiceException;
  3. import javax.xml.rpc.ServiceFactory;
  4. import java.net.MalformedURLException;
  5. import java.net.URL;
  6. import java.rmi.RemoteException;
  7. import javax.xml.namespace.QName;
  8. public class TestHelloWorld {
  9. public static void main(String[] args) throws MalformedURLException, ServiceException, RemoteException {
  10. // TODO Auto-generated method stub
  11. String wsdlUrl ="http://localhost:8989/axis/HelloWorld.jws?wsdl";
  12. String nameSpaceUri ="http://localhost:8989/axis/HelloWorld.jws";
  13. String serviceName = "HelloWorldService";
  14. String portName = "HelloWorld";
  15. ServiceFactory serviceFactory = ServiceFactory.newInstance();
  16. Service afService =serviceFactory.createService(new URL(wsdlUrl),new QName(nameSpaceUri, serviceName));
  17. HelloWorldInterface proxy = (HelloWorldInterface)afService.getPort(new QName(nameSpaceUri, portName),HelloWorldInterface.class);
  18. System.out.println("return value is "+proxy.getName("john") ) ;
  19. }
  20. }

四、使用axis2开发webservice（这里首先感谢李宁老师）    
  使用axis2 需要先下载

axis2-1.4.1-bin.zip

axis2-1.4.1-war.zip 
  http://ws.apache.org/axis2/   
  同理，也需要将axis2复制到webapp目录中 
在axis2中部署webservice有两种方法， 
    第一种是pojo方式，这种方式比较简单，但是有一些限制，例如部署的类不能加上包名 
    第二种方式是利用xml发布webservice，这种方法比较灵活，不需要限制类的声明 
    下面分别说明使用方法： 
    1.pojo方式：在Axis2中不需要进行任何的配置，就可以直接将一个简单的POJO发布成WebService。其中POJO中所有的public方法将被发布成WebService方法。先实现一个pojo类：

Java代码 
  1. public class HelloWorld{
  2. public String getName(String name)
  3. {
  4. return "你好 " + name;
  5. }
  6. public int add(int a,int b)
  7. {
  8. return a+b;
  9. }
  10. }
Java代码 
  1. public class HelloWorld{
  2. public String getName(String name)
  3. {
  4. return "你好 " + name;
  5. }
  6. public int add(int a,int b)
  7. {
  8. return a+b;
  9. }
  10. }

由于这两个方法都是public类型，所以都会发布成webservice。编译HelloWorld类后，将HelloWorld.class文件放到%tomcat%\webapps\axis2\WEB-INF\pojo目录中（如果没有pojo目录，则建立该目录），然后打开浏览器进行测试： 
输入一下url：

http://localhost:8080/axis2/services/listServices 
会列出所有webservice 
  
这是其中的两个webservice列表，接着，在客户端进行测试： 
首先可以写一个封装类，减少编码，代码如下：

Java代码 
  1. package MZ.GetWebService;
  2. import javax.xml.namespace.QName;
  3. import org.apache.axis2.AxisFault;
  4. import org.apache.axis2.addressing.EndpointReference;
  5. import org.apache.axis2.client.Options;
  6. import org.apache.axis2.rpc.client.RPCServiceClient;
  7. public class GetWSByAxis2 {
  8. private static String EndPointUrl;
  9. private static String QUrl="http://ws.apache.org/axis2";
  10. private QName opAddEntry;
  11. public String WSUrl;
  12. public RPCServiceClient setOption() throws AxisFault
  13. {
  14. RPCServiceClient serviceClient = new RPCServiceClient();
  15. Options options = serviceClient.getOptions();
  16. EndpointReference targetEPR = new EndpointReference(WSUrl);
  17. options.setTo(targetEPR);
  18. return serviceClient;
  19. }
  20. public QName getQname(String Option){
  21. return new QName (QUrl,Option);
  22. }
  23. //返回String
  24. public String getStr(String Option) throws AxisFault
  25. {
  26. RPCServiceClient serviceClient =this.setOption();
  27. opAddEntry =this.getQname(Option);
  28. String str = (String) serviceClient.invokeBlocking(opAddEntry,
  29. new Object[]{}, new Class[]{String.class })[0];
  30. return str;
  31. }
  32. // 返回一维String数组
  33. public String[] getArray(String Option) throws AxisFault
  34. {
  35. RPCServiceClient serviceClient =this.setOption();
  36. opAddEntry =this.getQname(Option);
  37. String[] strArray = (String[]) serviceClient.invokeBlocking(opAddEntry,
  38. new Object[]{}, new Class[]{String[].class })[0];
  39. return strArray;
  40. }
  41. //从WebService中返回一个对象的实例
  42. public Object getObject(String Option,Object o) throws AxisFault
  43. {
  44. RPCServiceClient serviceClient =this.setOption();
  45. QName qname=this.getQname(Option);
  46. Object object = serviceClient.invokeBlocking(qname, new Object[]{},new Class[]{o.getClass()})[0];
  47. return object;
  48. }
  49. /////////////////////////////////////////       读者可以自己封装数据类型，如int,byte,float等数据类型
  50. }
Java代码 
  1. package MZ.GetWebService;
  2. import javax.xml.namespace.QName;
  3. import org.apache.axis2.AxisFault;
  4. import org.apache.axis2.addressing.EndpointReference;
  5. import org.apache.axis2.client.Options;
  6. import org.apache.axis2.rpc.client.RPCServiceClient;
  7. public class GetWSByAxis2 {
  8. private static String EndPointUrl;
  9. private static String QUrl="http://ws.apache.org/axis2";
  10. private QName opAddEntry;
  11. public String WSUrl;
  12. public RPCServiceClient setOption() throws AxisFault
  13. {
  14. RPCServiceClient serviceClient = new RPCServiceClient();
  15. Options options = serviceClient.getOptions();
  16. EndpointReference targetEPR = new EndpointReference(WSUrl);
  17. options.setTo(targetEPR);
  18. return serviceClient;
  19. }
  20. public QName getQname(String Option){
  21. return new QName (QUrl,Option);
  22. }
  23. //返回String
  24. public String getStr(String Option) throws AxisFault
  25. {
  26. RPCServiceClient serviceClient =this.setOption();
  27. opAddEntry =this.getQname(Option);
  28. String str = (String) serviceClient.invokeBlocking(opAddEntry,
  29. new Object[]{}, new Class[]{String.class })[0];
  30. return str;
  31. }
  32. // 返回一维String数组
  33. public String[] getArray(String Option) throws AxisFault
  34. {
  35. RPCServiceClient serviceClient =this.setOption();
  36. opAddEntry =this.getQname(Option);
  37. String[] strArray = (String[]) serviceClient.invokeBlocking(opAddEntry,
  38. new Object[]{}, new Class[]{String[].class })[0];
  39. return strArray;
  40. }
  41. //从WebService中返回一个对象的实例
  42. public Object getObject(String Option,Object o) throws AxisFault
  43. {
  44. RPCServiceClient serviceClient =this.setOption();
  45. QName qname=this.getQname(Option);
  46. Object object = serviceClient.invokeBlocking(qname, new Object[]{},new Class[]{o.getClass()})[0];
  47. return object;
  48. }
  49. /////////////////////////////////////////       读者可以自己封装数据类型，如int,byte,float等数据类型
  50. }

客户端调用方法：

Java代码 
  1. MZ.GetWebService.GetWSByAxis2 ws=new MZ.GetWebService.GetWSByAxis2();
  2. ws.WSUrl="http://localhost:8989/axis2/services/HelloWorld";
  3. HelloWorld hello= (HelloWorld)ws.getObject("getName", HelloWorld.class);
  4. System.out.println(hello.getName("zhangjin"));
Java代码 
  1. MZ.GetWebService.GetWSByAxis2 ws=new MZ.GetWebService.GetWSByAxis2();
  2. ws.WSUrl="http://localhost:8989/axis2/services/HelloWorld";
  3. HelloWorld hello= (HelloWorld)ws.getObject("getName", HelloWorld.class);
  4. System.out.println(hello.getName("zhangjin"));

2.使用service.xml发布webservice，这种方式和直接放在pojo目录中的POJO类不同。要想将MyService类发布成Web
Service，需要一个services.xml文件，这个文件需要放在META-INF目录中，该文件的内容如下：

Xml代码 
  1. <service name="HelloWorld">
  2. <description>
  3. HelloWorld webservice
  4. </description>
  5. <parameter name="ServiceClass">
  6. service.HelloWorld
  7. </parameter>
  8. <messageReceivers>
  9. <messageReceiver mep="http://www.w3.org/2004/08/wsdl/in-out"
  10. class="org.apache.axis2.rpc.receivers.RPCMessageReceiver" />
  11. <messageReceiver mep="http://www.w3.org/2004/08/wsdl/in-only"
  12. class="org.apache.axis2.rpc.receivers.RPCInOnlyMessageReceiver" />
  13. </messageReceivers>
  14. </service>
Xml代码 
  1. <service name="HelloWorld">
  2. <description>
  3. HelloWorld webservice
  4. </description>
  5. <parameter name="ServiceClass">
  6. service.HelloWorld
  7. </parameter>
  8. <messageReceivers>
  9. <messageReceiver mep="http://www.w3.org/2004/08/wsdl/in-out"
  10. class="org.apache.axis2.rpc.receivers.RPCMessageReceiver" />
  11. <messageReceiver mep="http://www.w3.org/2004/08/wsdl/in-only"
  12. class="org.apache.axis2.rpc.receivers.RPCInOnlyMessageReceiver" />
  13. </messageReceivers>
  14. </service>

其中<service>元素用于发布Web Service，一个<service>元素只能发布一个WebService类，name属性表示WebService名，如下面的URL可以获得这个WebService的WSDL内容： 
http://localhost:8080/axis2/services/myService?wsdl 
  除此之外，还有直接可以在其中制定webservice操作方法：可以这样些service.xml文件

Java代码 
  1. <service name="HelloWorld">
  2. <description>
  3. HelloWorld service
  4. </description>
  5. <parameter name="ServiceClass">
  6. service.HelloWorld
  7. </parameter>
  8. <operation name="getName">
  9. <messageReceiver class="org.apache.axis2.rpc.receivers.RPCMessageReceiver" />
  10. </operation>
  11. <operation name="add">
  12. <messageReceiver
  13. class="org.apache.axis2.rpc.receivers.RPCMessageReceiver" />
  14. </operation>
  15. </service>
Java代码
  1. <service name="HelloWorld">
  2. <description>
  3. HelloWorld service
  4. </description>
  5. <parameter name="ServiceClass">
  6. service.HelloWorld
  7. </parameter>
  8. <operation name="getName">
  9. <messageReceiver class="org.apache.axis2.rpc.receivers.RPCMessageReceiver" />
  10. </operation>
  11. <operation name="add">
  12. <messageReceiver
  13. class="org.apache.axis2.rpc.receivers.RPCMessageReceiver" />
  14. </operation>
  15. </service>

如果要发布多个webservice，可以在文件两段加上<serviceGroup><service></service>...<service></service></serviceGroup>发布

 
上一篇：每天一道Java题[10]


下一篇：Docker镜像构建的两种方式