本文为原创,如需转载,请注明作者和出处,谢谢!
axis2是一套崭新的webservice引擎,该版本是对axis1.x重新设计的产物。axis2不仅支持soap1.1和soap1.2,还集成了非常流行的rest webservice,同时还支持spring、json等技术。这些都将在后面的系列教程中讲解。在本文中主要介绍了如何使用axis2开发一个不需要任何配置文件的webservice,并在客户端使用java和c#调用这个webservice。
一、axis2的下载和安装
读者可以从如下的网址下载axis2的最新版本:
在本文使用了目前axis2的最新版本1.4.1。读者可以下载如下两个zip包:
axis2-1.4.1-bin.zip
axis2-1.4.1-war.zip
其中axis2-1.4.1-bin.zip文件中包含了axis2中所有的jar文件, axis2-1.4.1-war.zip文件用于将webservice发布到web容器中。
将axis2-1.4.1-war.zip文件解压到相应的目录,将目录中的axis2.war文件放到安装目录>\webapps目录中(本文使用的tomcat的版本是6.x),并启动tomcat。
在浏览器地址栏中输入如下的url:
如果在浏览器中显示出如图1所示的页面,则表示axis2安装成功。
图1
二、编写和发布webservice
对于用java实现的服务程序给人的印象就是需要进行大量的配置,不过这一点在axis2中将被终结。在axis2中不需要进行任何的配置,就可以直接将一个简单的pojo发布成webservice。其中pojo中所有的public方法将被发布成webservice方法。
下面我们来实现一个简单的pojo,代码如下:
public class simpleservice
{
public string getgreeting(string name)
{
return "你好 " name;
}
public int getprice()
{
return new java.util.random().nextint(1000);
}
}
在simpleservice类中有两个方法,由于这两个方法都是public方法,因此,它们都将作为webservice方法被发布。
编译simpleservice类后,将simpleservice.class文件放到安装目录>\webapps\axis2\web-inf\pojo目录中(如果没有pojo目录,则建立该目录)。现在我们已经成功将simpleservice类发布成了webservice。在浏览器地址栏中输入如下的url:
这时当前页面将显示所有在axis2中发布的webservice,如图2所示。
图2
在浏览器地址栏中输入如下的两个url来分别测试getgreeting和getprice方法:
图3和图4分别显示了getgreeting和getprice方法的测试结果。
图3 getgreeting方法的测试结果
图4 getprice方法的测试结果
在编写、发布和测试0配置的webservice时应注意如下几点:
1. pojo类不能使用package关键字声明包。
2. axis2在默认情况下可以热发布webservice,也就是说,将webservice的.class文件复制到pojo目录中时,tomcat不需要重新启动就可以自动发布webservice。如果想取消axis2的热发布功能,可以打开安装目录>\webapps\axis2\web-inf\conf\axis2.xml,找到如下的配置代码:
<parameter name="hotdeployment">trueparameter>
将true改为false即可。要注意的是,axis2在默认情况下虽然是热发布,但并不是热更新,也就是说,一旦成功发布了webservice,再想更新该webservice,就必须重启tomcat。这对于开发人员调试webservice非常不方便,因此,在开发webservice时,可以将axis2设为热更新。在axis2.xml文件中找到false,将false改为true即可。
3. 在浏览器中测试webservice时,如果webservice方法有参数,需要使用url的请求参数来指定该webservice方法参数的值,请求参数名与方法参数名要一致,例如,要测试getgreeting方法,请求参数名应为name,如上面的url所示。
4. 发布webservice的pojo目录只是默认的,如果读者想在其他的目录发布webservice,可以打开axis2.xml文件,并在元素中添加如下的子元素:
<deployer extension=".class" directory="my" class="org.apache.axis2.deployment.pojodeployer"/>
上面的配置允许在安装目录>\webapps\axis2\web-inf\my目录中发布webservice。例如,将本例中的simpleservice.class复制到my目录中也可以成功发布(但要删除pojo目录中的simpleservice.class,否则webservice会重名)。
三、 用java实现调用webservice的客户端程序
webservice是为程序服务的,只在浏览器中访问webservice是没有意义的。因此,在本节使用java实现了一个控制台程序来调用上一节发布的webservice。调用webservice的客户端代码如下:
package client;
import javax.xml.namespace.qname;
import org.apache.axis2.addressing.endpointreference;
import org.apache.axis2.client.options;
import org.apache.axis2.rpc.client.rpcserviceclient;
public class rpcclient
{
public static void main(string[] args) throws exception
{
// 使用rpc方式调用webservice
rpcserviceclient serviceclient = new rpcserviceclient();
options options = serviceclient.getoptions();
// 指定调用webservice的url
endpointreference targetepr = new endpointreference(
"http://localhost:8080/axis2/services/simpleservice");
options.setto(targetepr);
// 指定getgreeting方法的参数值
object[] opaddentryargs = new object[] {"超人"};
// 指定getgreeting方法返回值的数据类型的class对象
class[] classes = new class[] {string.class};
// 指定要调用的getgreeting方法及wsdl文件的命名空间
qname opaddentry = new qname("http://ws.apache.org/axis2", "getgreeting");
// 调用getgreeting方法并输出该方法的返回值
system.out.println(serviceclient.invokeblocking(opaddentry, opaddentryargs, classes)[0]);
// 下面是调用getprice方法的代码,这些代码与调用getgreeting方法的代码类似
classes = new class[] {int.class};
opaddentry = new qname("http://ws.apache.org/axis2", "getprice");
system.out.println(serviceclient.invokeblocking(opaddentry, new object[]{}, classes)[0]);
}
}
运行上面的程序后,将在控制台输出如下的信息:
你好 超人
443
在编写客户端代码时应注意如下几点:
1. 客户端代码需要引用很多axis2的jar包,如果读者不太清楚要引用哪个jar包,可以在eclipse的工程中引用axis2发行包的lib目录中的所有jar包。
2. 在本例中使用了rpcserviceclient类的invokeblocking方法调用了webservice中的方法。invokeblocking方法有三个参数,其中第一个参数的类型是qname对象,表示要调用的方法名;第二个参数表示要调用的webservice方法的参数值,参数类型为object[];第三个参数表示webservice方法的返回值类型的class对象,参数类型为class[]。当方法没有参数时,invokeblocking方法的第二个参数值不能是null,而要使用new object[]{}。
3. 如果被调用的webservice方法没有返回值,应使用rpcserviceclient类的invokerobust方法,该方法只有两个参数,它们的含义与invokeblocking方法的前两个参数的含义相同。
4. 在创建qname对象时,qname类的构造方法的第一个参数表示wsdl文件的命名空间名,也就是元素的targetnamespace属性值,下面是simpleservice类生成的wsdl文件的代码片段:
xml version="1.0" encoding="utf-8"?>
<wsdl:definitions xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:ns1="http://org.apache.axis2/xsd"
xmlns:ns="http://ws.apache.org/axis2" xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
xmlns:http="http://schemas.xmlsoap.org/wsdl/http/" xmlns:xs="http://www.w3.org/2001/xmlschema"
xmlns:mime="http://schemas.xmlsoap.org/wsdl/mime/" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
xmlns:soap12="http://schemas.xmlsoap.org/wsdl/soap12/"
targetnamespace="http://ws.apache.org/axis2">
<wsdl:types>
wsdl:types>
wsdl:definitions>
四、用wsdl2java简化客户端的编写
也许有很多读者会说“有没有搞错啊,只调用两个webservice方法用要写这么多代码,太麻烦了”。
不过幸好axis2提供了一个wsdl2java.bat命令可以根据wsdl文件自动产生调用webservice的代码。wsdl2java.bat命令可以在安装目录>"bin目录中找到。在使用wsdl2java.bat命令之前需要设置axis2_home环境变量,该变量值是安装目录>。
在windows控制台输出如下的命令行来生成调用webservice的代码:
%axis2_home%\bin\wsdl2java -uri http://localhost:8080/axis2/services/simpleservice?wsdl
-p client -s -o stub
其中-url参数指定了wsdl文件的路径,可以是本地路径,也可以是网络路径。-p参数指定了生成的java类的包名,-o参数指定了生成的一系列文件保存的根目录。在执行完上面的命令后,读者就会发现在当前目录下多了个stub目录,在."stub"src"client目录可以找到一个simpleservicestub.java文件,该文件复杂调用webservice,读者可以在程序中直接使用这个类,代码如下:
package client;
import javax.xml.namespace.qname;
import org.apache.axis2.addressing.endpointreference;
import org.apache.axis2.client.options;
import org.apache.axis2.rpc.client.rpcserviceclient;
public class stubclient
{
public static void main(string[] args) throws exception
{
simpleservicestub stub = new simpleservicestub();
simpleservicestub.getgreeting gg = new simpleservicestub.getgreeting();
gg.setname("比尔");
system.out.println( stub.getgreeting(gg).get_return());
system.out.println(stub.getprice().get_return());
}
}
上面的代码大大简化了调用webservice的步骤,并使代码更加简洁。但要注意的是,wsdl2java.bat命令生成的stub类将webservice方法的参数都封装在了相应的类中,类名为方法名,例如,getgreeting方法的参数都封装在了getgreeting类中,要想调用getgreeting方法,必须先创建getgreeting类的对象实例。
五、使用c#调用webservice
从理论上说,webservice可以被任何支持soap协议的语言调用。在visual studio中使用c#调用webservice是在所有语言中最容易实现的(vb.net的调用方法类似,也同样很简单)。
新建一个visual studio工程,并在引用web服务的对话框中输入如下的url,并输入web引用名为“webservice”:
然后引用web服务的对话框就会显示该webservice中的所有的方法,如图5所示。
图5
在完成上面的工作后,只需要如下三行c#代码就可以调用getgreeting和getprice方法,并显示这两个方法的返回值:
webservice.simpleservice simpleservice = new wsc.webservice.simpleservice();
messagebox.show( simpleservice.getgreeting("比尔"));
messagebox.show(simpleservice.getprice().@return.tostring());
在.net解析wsdl文件时直接将getgreeting方法的参数映射为string类型,因此,可以直接进行传值。
从上面的调用过程可以看出,添加web引用的过程就相当于在java中调用wsdl2java.bat自动生成stub类的过程。只是在调用stub类时与c#有一定的区别,但从总体上来说,都大大简化了调用webservice的过程。
下一篇:
《android开发完全讲义(第2版)》(本书凯发k8网页登录的版权已输出到台湾)
《android高薪之路:android程序员面试宝典 》
新浪微博: 昵称:李宁_lining