java_webservice基础入门例子.doc

Axis2是一套崭新的WebService引擎，该版本是对Axis1.x重新设计的产物。Axis2不仅支持SOAP1.1和SOAP1.2，还集成了非常流行的REST WebService，同时还支持Spring、JSON等技术。这些都将在后面的系列教程中讲解。在本文中主要介绍了如何使用Axis2开发一个不需要任何配置文件的WebService，并在客户端使用Java和C#调用这个WebService。一、Axis2的下载和安装 读者可以从如下的网址下载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： http:/localhost:8080/axis2/ 如果在浏览器中显示出如图1所示的页面，则表示Axis2安装成功。图1二、编写和发布WebService对于用Java实现的服务程序给人的印象就是需要进行大量的配置，不过这一点在Axis2中将被终结。在Axis2中不需要进行任何的配置，就可以直接将一个简单的POJO发布成WebService。其中POJO中所有的public方法将被发布成WebService方法。 下面我们来实现一个简单的POJO，代码如下：publicclassSimpleServicepublicStringgetGreeting(Stringname)return你好+name;publicintgetPrice()returnnewjava.util.Random().nextInt(1000); 在SimpleService类中有两个方法，由于这两个方法都是public方法，因此，它们都将作为WebService方法被发布。 编译SimpleService类后，将SimpleService.class文件放到webappsaxis2WEB-INFpojo目录中（如果没有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=billhttp:/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的热发布功能，可以打开webappsaxis2WEB-INFconfaxis2.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文件，并在元素中添加如下的子元素： 上面的配置允许在webappsaxis2WEB-INFmy目录中发布WebService。例如，将本例中的SimpleService.class复制到my目录中也可以成功发布（但要删除pojo目录中的SimpleService.class，否则WebService会重名）。三、 用Java实现调用WebService的客户端程序 WebService是为程序服务的，只在浏览器中访问WebService是没有意义的。因此，在本节使用Java实现了一个控制台程序来调用上一节发布的WebService。调用WebService的客户端代码如下：packageclient;space.QName;importorg.apache.axis2.addressing.EndpointReference;importorg.apache.axis2.client.Options;importorg.apache.axis2.rpc.client.RPCServiceClient;publicclassRPCClientpublicstaticvoidmain(Stringargs)throwsException/使用RPC方式调用WebServiceRPCServiceClientserviceClient=newRPCServiceClient();Optionsoptions=serviceClient.getOptions();/指定调用WebService的URLEndpointReferencetargetEPR=newEndpointReference(http:/localhost:8080/axis2/services/SimpleService);options.setTo(targetEPR);/指定getGreeting方法的参数值ObjectopAddEntryArgs=newObject超人;/指定getGreeting方法返回值的数据类型的Class对象Classclasses=newClassString.class;/指定要调用的getGreeting方法及WSDL文件的命名空间QNameopAddEntry=newQName(/axis2,getGreeting);/调用getGreeting方法并输出该方法的返回值System.out.println(serviceClient.invokeBlocking(opAddEntry,opAddEntryArgs,classes)0);/下面是调用getPrice方法的代码，这些代码与调用getGreeting方法的代码类似classes=newClassint.class;opAddEntry=newQName(/axis2,getPrice);System.out.println(serviceClient.invokeBlocking(opAddEntry,newObject,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文件的代码片段：四、用wsdl2java简化客户端的编写 也许有很多读者会说“有没有搞错啊，只调用两个WebService方法用要写这么多代码，太麻烦了”。 不过幸好Axis2提供了一个wsdl2java.bat命令可以根据WSDL文件自动产生调用WebService的代码。wsdl2java.bat命令可以在bin目录中找到。在使用wsdl2java.bat命令之前需要设置AXIS2_HOME环境变量，该变量值是。 在Windows控制台输出如下的命令行来生成调用WebService的代码：%AXIS2_HOME%binwsdl2java -uri http:/localhost:8080/axis2/services/SimpleService?wsdl -p client -s -o stub 其中-url参数指定了wsdl文件的路径，可以是本地路径，也可以是网络路径。-p参数指定了生成的Java类的包名，-o参数指定了生成的一系列文件保存的根目录。在执行完上面的命令后，读者就会发现在当前目录下多了个stub目录，在.stubsrcclient目录可以找到一个SimpleServiceStub.java文件，该文件复杂调用WebService，读者可以在程序中直接使用这个类，代码如下：packageclient;space.QName;importorg.apache.axis2.addressing.EndpointReference;importorg.apache.axis2.client.Options;importorg.apache.axis2.rpc.client.RPCServiceClient;publicclassStubClientpublicstaticvoidmain(Stringargs)throwsExceptionSimpleServiceStubstub=newSimpleServiceStub();SimpleServiceStub.GetGreetinggg=newSimpleServiceStub.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”： http:/localhost:8080/axis2/services/SimpleService?wsdl 然后引用Web服务的对话框就会显示该WebService中的所有的方法，如图5所示。图5 在完成上面的工作后，只需要如下三行C#代码就可以调用getGreeting和getPrice方法，并显示这两个方法的返回值：WebService.SimpleServicesimpleService=newWSC.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从表面上看，Web service 就是一个应用程序，它向外界暴露出一个能够通过Web进行调用的API。这就是说，你能够用编程的方法通过Web来调用这个应用程序。对Web service 更精确的解释： Web services是建立可互操作的分布式应用程序的新平台。作为一个Windows程序员，你可能已经用COM或DCOM建立过基于组件的分布式应用程序。COM是一个非常好的组件技术，但是我们也很容易举出COM并不能满足要求的情况。Web service平台是一套标准，它定义了应用程序如何在Web上实现互操作性。你可以用任何你喜欢的语言，在任何你喜欢的平台上写Web service ，只要我们可以通过Web service标准对这些服务进行查询和访问。不管你的Web service是用什么工具，什么语言写出来的，只要你用SOAP协议通过HTTP来调用它，总体结构都应如下图所示。通常，你用你自己喜欢的语言(如VB 6或者VB.NET)来构建你的Web service，然后用SOAP Toolkit或者.NET的内建支持来把它暴露给Web客户。于是，任何语言，任何平台上的客户都可以阅读其WSDL文档，以调用这个Web service。客户根据WSDL描述文档，会生成一个SOAP请求消息。Web service都是放在Web服务器 (如IIS) 后面的，客户生成的SOAP请求会被嵌入在一个HTTP POST请求中，发送到Web服务器来。Web服务器再把这些请求转发给Web service请求处理器。对VB 6程序来说，Web service请求处理器是一个与SOAP Toolkit组件协同工作的ASP页面或ISAPI extension。而对VB.NET程序来说，Web service请求处理器则是一个.NET Framework自带的ISAPI extension。请求处理器的作用在于，解析收到的SOAP请求，调用Web service，然后再生成相应的SOAP应答。Web服务器得到SOAP应答后，会再通过HTTP应答的方式把它送回到客户端。2 基本概念SOAP Web service建好以后，其他人就会去调用它。简单对象访问协议(SOAP)提供了标准的远程过程调用( RPC)方法来调用Web service。SOAP规范定义了SOAP消息的格式，以及怎样通过HTTP协议来使用SOAP。SOAP也是基于XML和XSD的，XML是SOAP的数据编码方式。客户端和服务端之间的方法调用请求和结果返回值都放在这些消息里。 XML和XSD可扩展的标记语言(XML)是Web service平台中表示数据的基本格式。除了易于建立和易于分析外，XML主要的优点在于它既是平台无关的，又是厂商无关的。无关性是比技术优越性更重要的。XML解决了数据表示的问题，但它没有定义一套标准的数据类型，更没有说怎么去扩展这套数据类型。例如，整形数到底代表什么？16位，32位，还是64位？这些细节对实现互操作性都是很重要的。W3C制定的XML Schema(XSD)就是专门解决这个问题的一套标准。它定义了一套标准的数据类型，并给出了一种语言来扩展这套数据类型。Web service平台就是用XSD来作为其数据类型系统的。当用某种语言(如VB.NET或C#)来构造一个Web service时，为了符合Web service标准，所有使用的数据类型都必须被转换为XSD类型。 WSDL(Web Services Description Language)用于描述服务端所提供服务的XML格式。WSDL文件里，描述了服务端提供的服务，提供的调用方法，以及调用时所要遵循的格式，比如调用参数和返回值的格式等等。WSDL 很像COM编程里的IDL(Interface Description Language)，是服务器与客户端之间的契约，双方必须按契约严格行事才能实现功能。 WSML(Web Services Meta Language)用于描述WSDL里提供的方法与实现该方法的COM对象之间的映射关系。该文件是Microsoft的实现中特有的，不是SOAP标准的一部分。一般情况下，该文件只在服务端存在。3Webservice的技术特点长项一： 跨防火墙的通信 如果应用程序有成千上万的用户，而且分布在世界各地，那么客户端和服务器之间的通信将是一个棘手的问题。因为客户端和服务器之间通常会有防火墙或者代理服务器。在这种情况下，使用DCOM就不是那么简单，通常也不便于把客户端程序发布到数量如此庞大的每一个用户手中。传统的做法是，选择用浏览器作为客户端，写下一大堆ASP页面，把应用程序的中间层暴露给最终用户。这样做的结果是开发难度大，程序很难维护。 举个例子，在应用程序里加入一个新页面，必须先建立好用户界面(Web页面)，并在这个页面后面，包含相应商业逻辑的中间层组件，还要再建立至少一个ASP页面，用来接受用户输入的信息，调用中间层组件，把结果格式化为HTML形式，最后还要把“结果页”送回浏览器。要是客户端代码不再如此依赖于HTML表单，客户端的编程就简单多了。 如果中间层组件换成Web Service的话，就可以从用户界面直接调用中间层组件，从而省掉建立ASP页面的那一步。要调用Web Service，可以直接使用Microsoft SOAP Toolkit或.NET这样的SOAP客户端，也可以使用自己开发的SOAP客户端，然后把它和应用程序连接起来。不仅缩短了开发周期，还减少了代码复杂度，并能够增强应用程序的可维护性。同时，应用程序也不再需要在每次调用中间层组件时，都跳转到相应的“结果页”。 从经验来看，在一个用户界面和中间层有较多交互的应用程序中，使用Web Service这种结构，可以节省花在用户界面编程上20%的开发时间。另外，这样一个由Web Service组成的中间层，完全可以在应用程序集成或其它场合下重用。最后，通过Web Service把应用程序的逻辑和数据“暴露”出来，还可以让其它平台上的客户重用这些应用程序。长项二： 应用程序集成 企业级的应用程序开发者都知道，企业里经常都要把用不同语言写成的、在不同平台上运行的各种程序集成起来，而这种集成将花费很大的开发力量。应用程序经常需要从运行在IBM主机上的程序中获取数据；或者把数据发送到主机或UNIX应用程序中去。即使在同一个平台上，不同软件厂商生产的各种软件也常常需要集成起来。通过Web Service，应用程序可以用标准的方法把功能和数据“暴露”出来，供其它应用程序使用。 例如，有一个订单登录程序，用于登录从客户来的新订单，包括客户信息、发货地址、数量、价格和付款方式等内容；还有一个订单执行程序，用于实际货物发送的管理。这两个程序来自不同软件厂商。一份新订单进来之后，订单登录程序需要通知订单执行程序发送货物。通过在订单执行程序上面增加一层Web Service，订单执行程序可以把“Add Order”函数“暴露”出来。这样，每当有新订单到来时，订单登录程序就可以调用这个函数来发送货物了。 长项三： B2B的集成 用Web Service集成应用程序，可以使公司内部的商务处理更加自动化。但当交易跨越供应商和客户、突破公司的界限时会怎么样呢？跨公司的商务交易集成通常叫做B2B集成。 Web Service是B2B集成成功的关键。通过Web Service，公司可以把关键的商务应用“暴露”给指定的供应商和客户。例如，把电子下单系统和电子发票系统“暴露”出来，客户就可以以电子的方式发送订单，供应商则可以以电子的方式发送原料采购发票。当然，这并不是一个新的概念， EDI(电子文档交换)早就是这样了。但是，Web Service的实现要比EDI简单得多，而且Web Service运行在Internet上，在世界任何地方都可轻易实现，其运行成本就相对较低。不过，Web Service并不像EDI那样，是文档交换或B2B集成的完整解决方案。Web Service只是B2B集成的一个关键部分，还需要许多其它的部分才能实现集成。 用Web Service来实现B2B集成的最大好处在于可以轻易实现互操作性。只要把商务逻辑“暴露”出来，成为Web Service，就可以让任何指定的合作伙伴调用这些商务逻辑，而不管他们的系统在什么平台上运行，使用什么开发语言。这样就大大减少了花在B2B集成上的时间和成本，让许多原本无法承受EDI的中小企业也能实现B2B集成。长项四： 软件和数据重用 软件重用是一个很大的主题，重用的形式很多，重用的程度有大有小。最基本的形式是源代码模块或者类一级的重用，另一种形式是二进制形式的组件重用。 当前，像表格控件或用户界面控件这样的可重用软件组件，在市场上都占有很大的份额。但这类软件的重用有一个很大的限制，就是重用仅限于代码，数据不能重用。原因在于，发布组件甚至源代码都比较容易，但要发布数据就没那么容易，除非是不会经常变化的静态数据。 Web Service在允许重用代码的同时，可以重用代码背后的数据。使用Web Service，再也不必像以前那样，要先从第三方购买、安装软件组件，再从应用程序中调用这些组件；只需要直接调用远端的Web Service就可以了。举个例子，要在应用程序中确认用户输入的地址，只需把这个地址直接发送给相应的Web Service，这个Web Service 就会帮你查阅街道地址、城市、省区和邮政编码等信息，确认这个地址是否在相应的邮政编码区域。Web Service 的提供商可以按时间或使用次数来对这项服务进行收费。这样的服务要通过组件重用来实现是不可能的，那样的话你必须下载并安装好包含街道地址、城市、省区和邮政编码等信息的数据库，而且这个数据库还是不能实时更新的。 另一种软件重用的情况是，把好几个应用程序的功能集成起来。例如，要建立一个局域网上的门户站点应用，让用户既可以查询联邦快递包裹，查看股市行情，又可以管理自己的日程安排，还可以在线购买电影票。现在Web上有很多应用程序供应商，都在其应用中实现了这些功能。一旦他们把这些功能都通过Web Service “暴露”出来，就可以非常容易地把所有这些功能都集成到你的门户站点中，为用户提供一个统一的、友好的界面。 将来，许多应用程序都会利用Web Service，把当前基于组件的应用程序结构扩展为组件/Web Service 的混合结构，可以在应用程序中使用第三方的Web Service 提供的功能，也可以把自己的应用程序功能通过Web Service 提供给别人。两种情况下，都可以重用代码和代码背后的数据。4.如何调用webservice4.0 webservice的调用过程 客户端：取得服务端的服务描述文件WSDL，解析该文件的内容，了解服务端的服务信息，以及调用方式。根据需要，生成恰当的SOAP请求消息（指定调用的方法，已经调用的参数），发往服务端。等待服务端返回的SOAP回应消息，解析得到返回值。 服务端：生成服务描述文件，以供客户端获取。接收客户端发来的SOAP请求消息，解析其中的方法调用和参数格式。根据WSDL和WSML的描述，调用相应的COM对象来完成指定功能，并把返回值放入SOAP回应消息返回给用户。高层接口 使用高层接口，不需要知道SOAP和XML的任何信息，就可以生成和使用一个WebService。Soap Toolkit 2.0通过提供两个COM对象SoapClient和SoapServer，来完成这些功能。 在客户端，只需要生成一个SoapClient实例，并用WSDL作为参数来调用其中的mssoapinit方法。SoapClient对象会自动解析WSDL文件，并在内部生成所有Web Service的方法和参数信息。之后，你就可以像调用IDispatch接口里的方法一样，调用里面所有的方法。在VB或是脚本语言里，你甚至可以直接在SoapClient对象名后面直接加上.方法(参数)进行调用。 低层接口 要使用低层接口，你必须对SOAP和XML有所了解。你可以对SOAP的处理过程进行控制，特别是要做特殊处理的时候。在客户端，首先要创建一个HttpConnector对象，负责HTTP连接。设定Connector的一些头部信息，比如EndPoinURL和SoapAction等。如果网络连接需要使用代理服务器，那也要在这里设定相关的信息。接着创建SoapSerializer对象，用于生成Soap消息。按照WSDL里定义，把所有参数按顺序序列化，得到一个完整的SOAP请求消息。该Soap消息，作为Payload通过HttpConnector被发送到服务端。最后，生成一个SoapReader对象，负责读取服务端返回的SOAP消息，取得其中的返回值。4.1 使用PowerBuilder调用 适用版本8.0 需下载Bulletin Web Services Toolkit 4.142使用java调用需要下载apache soap。下载地址：/soap/index.html导入：import org.apache.soap.*;import org.apache.soap.rpc.*;例程：import java.io.*;import java.util.*;import .*;import org.w3c.dom.*;import org.apache.soap.util.xml.*;import org.apache.soap.*;import org.apache.soap.encoding.*;import org.apache.soap.encoding.soapenc.*;import org.apache.soap.rpc.*;import org.apache.soap.transport.http.SOAPHTTPConnection;public class testClient public static void main(String args) throws Exception URL url = new URL (/yundan/service1.wsdl);/改成你的地址 SOAPMappingRegistry smr = new SOAPMappingRegistry (); StringDeserializer sd = new StringDeserializer (); smr.mapTypes (Constants.NS_URI_SOAP_ENC, new QName (, Result), null, null, sd); / 创建传输路径和参数 SOAPHTTPConnection st = new SOAPHTTPConnection(); / 创建调用 Call call = new Call (); call.setSOAPTransport(st); call.setSOAPMappingRegistry (smr); call.setTargetObjectURI (/message/); call.setMethodName(addNumbers); call.setEncodingStyleURI (/soap/encoding/); Vector params = new Vector(); params.addElement(new Parameter(NumberOne, Double.class, 10, null); params.addElement(new Parameter(NumberTwo, Double.class, 25, null); call.setParams(params); Response resp = null; try resp = call.invoke (url, /action/Hello2.addNumbers); catch (SOAPException e) System.err.println(Caught SOAPException ( + e.getFaultCode () + ): + e.getMessage (); return; / 检查返回值 if (resp != null & !resp.generatedFault() Parameter ret = resp.getReturnValue(); Object value = ret.getValue(); System.out.println (Answer- + value); else Fault fault = resp.getFault (); System.err.println (Generated fault: ); System.out.println ( Fault Code = + fault.getFaultCode(); System.out.println ( Fault String = + fault.getFaultString(); 4. 3 在asp中使用Jscript调用需下载msSoapToolkit20.exe引用：MSSOAP.SoapClient 例程： webservice演示 webservice 演示Result: 4. 4在asp中使用vbscript调用需下载msSoapToolkit20.exe引用：MSSOAP.SoapClient 例程：webservie演示webservie演示Result: 4. 5使用C#调用无需下载任何组件Visual项目新建 windows应用程序。C#项目在解决方案资源管理器中添加web引用,输入wsdl文件所在地址。将web引用改名.yundan.（service_name）即可引用*需引用System.web.services*例程：using System;using System.Drawing;using System.Collections;using System.ComponentModel;using System.Windows.Forms;using System.Data;namespace csharp public class Form1 : System.Windows.Forms.Form private System.Windows.Forms.Label label1; private System.Windows.Forms.TextBox textBox1; private System.ComponentModel.Container components = null; public Form1() InitializeComponent(); p