java webservice应用举例.docx
《java webservice应用举例.docx》由会员分享,可在线阅读,更多相关《java webservice应用举例.docx(32页珍藏版)》请在冰豆网上搜索。
javawebservice应用举例
Axis2是一套崭新的WebService引擎,该版本是对Axis1.x重新设计的产物。
Axis2不仅支持SOAP1.1和SOAP1.2,还集成了非常流行的RESTWebService,同时还支持Spring、JSON等技术。
这些都将在后面的系列教程中讲解。
在本文中主要介绍了如何使用Axis2开发一个不需要任何配置文件的WebService,并在客户端使用Java和C#调用这个WebService。
一、Axis2的下载和安装
读者可以从如下的网址下载Axis2的最新版本:
http:
//ws.apache.org/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:
http:
//localhost:
8080/axis2/
如果在浏览器中显示出如图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:
http:
//localhost:
8080/axis2/services/listServices
这时当前页面将显示所有在Axis2中发布的WebService,如图2所示。
图2
在浏览器地址栏中输入如下的两个URL来分别测试getGreeting和getPrice方法:
http:
//localhost:
8080/axis2/services/SimpleService/getGreeting?
name=bill
http:
//localhost:
8080/axis2/services/SimpleService/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,找到如下的配置代码:
true
将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文件,并在元素中添加如下的子元素:
上面的配置允许在\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,而要使用newObject[]{}。
3. 如果被调用的WebService方法没有返回值,应使用RPCServiceClient类的invokeRobust方法,该方法只有两个参数,它们的含义与invokeBlocking方法的前两个参数的含义相同。
4. 在创建QName对象时,QName类的构造方法的第一个参数表示WSDL文件的命名空间名,也就是definitions>元素的targetNamespace属性值,下面是SimpleService类生成的WSDL文件的代码片段:
xml version="1.0" encoding="UTF-8"?
>
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">
types>
types>
definitions>
四、用wsdl2java简化客户端的编写
也许有很多读者会说“有没有搞错啊,只调用两个WebService方法用要写这么多代码,太麻烦了”。
不过幸好Axis2提供了一个wsdl2java.bat命令可以根据WSDL文件自动产生调用WebService的代码。
wsdl2java.bat命令可以在"bin目录中找到。
在使用wsdl2java.bat命令之前需要设置AXIS2_HOME环境变量,该变量值是。
在Windows控制台输出如下的命令行来生成调用WebService的代码:
%AXIS2_HOME%\bin\wsdl2java-urihttp:
//localhost:
8080/axis2/services/SimpleService?
wsdl-pclient-s-ostub
其中-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协议的语言调用。
在VisualStudio中使用C#调用WebService是在所有语言中最容易实现的(VB.net的调用方法类似,也同样很简单)。
新建一个VisualStudio工程,并在引用Web服务的对话框中输入如下的URL,并输入Web引用名为“WebService”:
http:
//localhost:
8080/axis2/services/SimpleService?
wsdl
然后引用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的过程。
1. 什么是webservice
从表面上看,Webservice就是一个应用程序,它向外界暴露出一个能够通过Web进行调用的API。
这就是说,你能够用编程的方法通过Web来调用这个应用程序。
对Webservice更精确的解释:
Webservices是建立可互操作的分布式应用程序的新平台。
作为一个Windows程序员,你可能已经用COM或DCOM建立过基于组件的分布式应用程序。
COM是一个非常好的组件技术,但是我们也很容易举出COM并不能满足要求的情况。
Webservice平台是一套标准,它定义了应用程序如何在Web上实现互操作性。
你可以用任何你喜欢的语言,在任何你喜欢的平台上写Webservice,只要我们可以通过Webservice标准对这些服务进行查询和访问。
不管你的Webservice是用什么工具,什么语言写出来的,只要你用SOAP协议通过HTTP来调用它,总体结构都应如下图所示。
通常,你用你自己喜欢的语言(如VB6或者VB.NET)来构建你的Webservice,然后用SOAPToolkit或者.NET的内建支持来把它暴露给Web客户。
于是,任何语言,任何平台上的客户都可以阅读其WSDL文档,以调用这个Webservice。
客户根据WSDL描述文档,会生成一个SOAP请求消息。
Webservice都是放在Web服务器(如IIS)后面的,客户生成的SOAP请求会被嵌入在一个HTTPPOST请求中,发送到Web服务器来。
Web服务器再把这些请求转发给Webservice请求处理器。
对VB6程序来说,Webservice请求处理器是一个与SOAPToolkit组件协同工作的ASP页面或ISAPIextension。
而对VB.NET程序来说,Webservice请求处理器则是一个.NETFramework自带的ISAPIextension。
请求处理器的作用在于,解析收到的SOAP请求,调用Webservice,然后再生成相应的SOAP应答。
Web服务器得到SOAP应答后,会再通过HTTP应答的方式把它送回到客户端。
2. 基本概念
SOAP
Webservice建好以后,其他人就会去调用它。
简单对象访问协议(SOAP)提供了标准的远程过程调用(RPC)方法来调用Webservice。
SOAP规范定义了SOAP消息的格式,以及怎样通过HTTP协议来使用SOAP。
SOAP也是基于XML和XSD的,XML是SOAP的数据编码方式。
客户端和服务端之间的方法调用请求和结果返回值都放在这些消息里。
XML和XSD
可扩展的标记语言(XML)是Webservice平台中表示数据的基本格式。
除了易于建立和易于分析外,XML主要的优点在于它既是平台无关的,又是厂商无关的。
无关性是比技术优越性更重要的。
XML解决了数据表示的问题,但它没有定义一套标准的数据类型,更没有说怎么去扩展这套数据类型。
例如,整形数到底代表什么?
16位,32位,还是64位?
这些细节对实现互操作性都是很重要的。
W3C制定的XMLSchema(XSD)就是专门解决这个问题的一套标准。
它定义了一套标准的数据类型,并给出了一种语言来扩展这套数据类型。
Webservice平台就是用XSD来作为其数据类型系统的。
当用某种语言(如VB.NET或C#)来构造一个Webservice时,为了符合Webservice标准,所有使用的数据类型都必须被转换为XSD类型。
WSDL(WebServicesDescriptionLanguage)
用于描述服务端所提供服务的XML格式。
WSDL文件里,描述了服务端提供的服务,提供的调用方法,以及调用时所要遵循的格式,比如调用参数和返回值的格式等等。
WSDL很像COM编程里的IDL(InterfaceDescriptionLanguage),是服务器与客户端之间的契约,双方必须按契约严格行事才能实现功能。
WSML(WebServicesMetaLanguage)
用于描述WSDL里提供的方法与实现该方法的COM对象之间的映射关系。
该文件是Microsoft的实现中特有的,不是SOAP标准的一部分。
一般情况下,该文件只在服务端存在。
3.Webservice的技术特点
长项一:
跨防火墙的通信
如果应用程序有成千上万的用户,而且分布在世界各地,那么客户端和服务器之间的通信将是一个棘手的问
题。
因为客户端和服务器之间通常会有防火墙或者代理服务器。
在这种情况下,使用DCOM就不是那么简单,通常也不便于把客户端程序发布到数量如此庞大的每一个用户手中。
传统的做法是,选择用浏览器作为客户端,写下一大堆ASP页面,把应用程序的中间层暴露给最终用户。
这样做的结果是开发难度大,程序很难维护。
举个例子,在应用程序里加入一个新页面,必须先建立好用户界面(Web页面),并在这个页面后面,包含相应商业逻辑的中间层组件,还要再建立至少一个ASP页面,用来接受用户输入的信息,调用中间层组件,把结果格式化为HTML形式,最后还要把“结果页”送回浏览器。
要是客户端代码不再如此依赖于HTML表单,客户端的编程就简单多了。
如果中间层组件换成WebService的话,就可以从用户界面直