Axis2是一套嶄新的WebService引擎,該版本是對(duì)Axis1.x重新設(shè)計(jì)的產(chǎn)物。Axis2不僅支持SOAP1.1SOAP1.2,還集成了非常流行的REST WebService,同時(shí)還支持SpringJSON等技術(shù)。這些都將在后面的系列教程中講解。在本文中主要介紹了如何使用Axis2開(kāi)發(fā)一個(gè)不需要任何配置文件的WebService,并在客戶端使用JavaC#調(diào)用這個(gè)WebService

一、Axis2的下載和安裝

??? 讀者可以從如下的網(wǎng)址下載Axis2的最新版本:

??? http://ws.apache.org/axis2/

??? 在本文使用了目前Axis2的最新版本1.4.1。讀者可以下載如下兩個(gè)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發(fā)布到Web容器中。

??? axis2-1.4.1-war.zip文件解壓到相應(yīng)的目錄,將目錄中的axis2.war文件放到<Tomcat安裝目錄>\webapps目錄中(本文使用的Tomcat的版本是6.x),并啟動(dòng)Tomcat

??? 在瀏覽器地址欄中輸入如下的URL

??? http://localhost:8080/axis2/

??? 如果在瀏覽器中顯示出如圖1所示的頁(yè)面,則表示Axis2安裝成功。



圖1

二、編寫(xiě)和發(fā)布WebService

??對(duì)于用Java實(shí)現(xiàn)的服務(wù)程序給人的印象就是需要進(jìn)行大量的配置,不過(guò)這一點(diǎn)在Axis2中將被終結(jié)。在Axis2中不需要進(jìn)行任何的配置,就可以直接將一個(gè)簡(jiǎn)單的POJO發(fā)布成WebService。其中POJO中所有的public方法將被發(fā)布成WebService方法。

??? 下面我們來(lái)實(shí)現(xiàn)一個(gè)簡(jiǎn)單的POJO,代碼如下:

public?class?SimpleService
{
????
public?String?getGreeting(String?name)
????{
????????
return?"你好?"?+?name;
????}????
????
public?int?getPrice()
????{
????????
return?new?java.util.Random().nextInt(1000);
????}????
}

??? SimpleService類中有兩個(gè)方法,由于這兩個(gè)方法都是public方法,因此,它們都將作為WebService方法被發(fā)布。

??? 編譯SimpleService類后,將SimpleService.class文件放到<Tomcat安裝目錄>\webapps\axis2\WEB-INF\pojo目錄中(如果沒(méi)有pojo目錄,則建立該目錄)。現(xiàn)在我們已經(jīng)成功將SimpleService類發(fā)布成了WebService。在瀏覽器地址欄中輸入如下的URL

http://localhost:8080/axis2/services/listServices

??? 這時(shí)當(dāng)前頁(yè)面將顯示所有在Axis2中發(fā)布的WebService,如圖2所示。



圖2

??? 在瀏覽器地址欄中輸入如下的兩個(gè)URL來(lái)分別測(cè)試getGreetinggetPrice方法:

http://localhost:8080/axis2/services/SimpleService/getGreeting?name=bill

http://localhost:8080/axis2/services/SimpleService/getPrice

??? 3和圖4分別顯示了getGreetinggetPrice方法的測(cè)試結(jié)果。

圖3? getGreeting方法的測(cè)試結(jié)果

圖4? getPrice方法的測(cè)試結(jié)果

??? 在編寫(xiě)、發(fā)布和測(cè)試0配置的WebService時(shí)應(yīng)注意如下幾點(diǎn):

??? 1.?POJO類不能使用package關(guān)鍵字聲明包。

??? 2.?Axis2在默認(rèn)情況下可以熱發(fā)布WebService,也就是說(shuō),將WebService.class文件復(fù)制到pojo目錄中時(shí),Tomcat不需要重新啟動(dòng)就可以自動(dòng)發(fā)布WebService。如果想取消Axis2的熱發(fā)布功能,可以打開(kāi)<Tomcat安裝目錄>\webapps\axis2\WEB-INF\conf\axis2.xml,找到如下的配置代碼:

<parameter?name="hotdeployment">true</parameter>

??? true改為false即可。要注意的是,Axis2在默認(rèn)情況下雖然是熱發(fā)布,但并不是熱更新,也就是說(shuō),一旦成功發(fā)布了WebService,再想更新該WebService,就必須重啟Tomcat。這對(duì)于開(kāi)發(fā)人員調(diào)試WebService非常不方便,因此,在開(kāi)發(fā)WebService時(shí),可以將Axis2設(shè)為熱更新。在axis2.xml文件中找到<parameter name="hotupdate">false</parameter>,將false改為true即可。

??? 3.?在瀏覽器中測(cè)試WebService時(shí),如果WebService方法有參數(shù),需要使用URL的請(qǐng)求參數(shù)來(lái)指定該WebService方法參數(shù)的值,請(qǐng)求參數(shù)名與方法參數(shù)名要一致,例如,要測(cè)試getGreeting方法,請(qǐng)求參數(shù)名應(yīng)為name,如上面的URL所示。

??? 4.?發(fā)布WebServicepojo目錄只是默認(rèn)的,如果讀者想在其他的目錄發(fā)布WebService,可以打開(kāi)axis2.xml文件,并在<axisconfig>元素中添加如下的子元素:

????<deployer?extension=".class"?directory="my"?class="org.apache.axis2.deployment.POJODeployer"/>

??? 上面的配置允許在<Tomcat安裝目錄>"webapps"axis2"WEB-INF"my目錄中發(fā)布WebService。例如,將本例中的SimpleService.class復(fù)制到my目錄中也可以成功發(fā)布(但要?jiǎng)h除pojo目錄中的SimpleService.class,否則WebService會(huì)重名)。

三、Java實(shí)現(xiàn)調(diào)用WebService的客戶端程序

??? WebService是為程序服務(wù)的,只在瀏覽器中訪問(wèn)WebService是沒(méi)有意義的。因此,在本節(jié)使用Java實(shí)現(xiàn)了一個(gè)控制臺(tái)程序來(lái)調(diào)用上一節(jié)發(fā)布的WebService。調(diào)用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方式調(diào)用WebService????????
????????RPCServiceClient?serviceClient?=?new?RPCServiceClient();
????????Options?options?
=?serviceClient.getOptions();
????????
//??指定調(diào)用WebService的URL
????????EndpointReference?targetEPR?=?new?EndpointReference(
????????????????
"http://localhost:8080/axis2/services/SimpleService");
????????options.setTo(targetEPR);
????????
//??指定getGreeting方法的參數(shù)值
????????Object[]?opAddEntryArgs?=?new?Object[]?{"超人"};
????????
//??指定getGreeting方法返回值的數(shù)據(jù)類型的Class對(duì)象
????????Class[]?classes?=?new?Class[]?{String.class};
????????
//??指定要調(diào)用的getGreeting方法及WSDL文件的命名空間
????????QName?opAddEntry?=?new?QName("http://ws.apache.org/axis2",?"getGreeting");
????????
//??調(diào)用getGreeting方法并輸出該方法的返回值
????????System.out.println(serviceClient.invokeBlocking(opAddEntry,?opAddEntryArgs,?classes)[0]);
????????
//??下面是調(diào)用getPrice方法的代碼,這些代碼與調(diào)用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]);
????}?
}

運(yùn)行上面的程序后,將在控制臺(tái)輸出如下的信息:
你好?超人
443

??? 在編寫(xiě)客戶端代碼時(shí)應(yīng)注意如下幾點(diǎn):

??? 1.?客戶端代碼需要引用很多Axis2jar包,如果讀者不太清楚要引用哪個(gè)jar包,可以在Eclipse的工程中引用Axis2發(fā)行包的lib目錄中的所有jar包。

??? 2.?在本例中使用了RPCServiceClient類的invokeBlocking方法調(diào)用了WebService中的方法。invokeBlocking方法有三個(gè)參數(shù),其中第一個(gè)參數(shù)的類型是QName對(duì)象,表示要調(diào)用的方法名;第二個(gè)參數(shù)表示要調(diào)用的WebService方法的參數(shù)值,參數(shù)類型為Object[];第三個(gè)參數(shù)表示WebService方法的返回值類型的Class對(duì)象,參數(shù)類型為Class[]。當(dāng)方法沒(méi)有參數(shù)時(shí),invokeBlocking方法的第二個(gè)參數(shù)值不能是null,而要使用new Object[]{}。

??? 3.?如果被調(diào)用的WebService方法沒(méi)有返回值,應(yīng)使用RPCServiceClient類的invokeRobust方法,該方法只有兩個(gè)參數(shù),它們的含義與invokeBlocking方法的前兩個(gè)參數(shù)的含義相同。

??? 4.?在創(chuàng)建QName對(duì)象時(shí),QName類的構(gòu)造方法的第一個(gè)參數(shù)表示WSDL文件的命名空間名,也就是<wsdl:definitions>元素的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簡(jiǎn)化客戶端的編寫(xiě)

??? 也許有很多讀者會(huì)說(shuō)“有沒(méi)有搞錯(cuò)啊,只調(diào)用兩個(gè)WebService方法用要寫(xiě)這么多代碼,太麻煩了”。

??? 不過(guò)幸好Axis2提供了一個(gè)wsdl2java.bat命令可以根據(jù)WSDL文件自動(dòng)產(chǎn)生調(diào)用WebService的代碼。wsdl2java.bat命令可以在<Axis2安裝目錄>"bin目錄中找到。在使用wsdl2java.bat命令之前需要設(shè)置AXIS2_HOME環(huán)境變量,該變量值是<Axis2安裝目錄>。

??? Windows控制臺(tái)輸出如下的命令行來(lái)生成調(diào)用WebService的代碼:

%AXIS2_HOME%\bin\wsdl2java -uri http://localhost:8080/axis2/services/SimpleService?wsdl -p client -s -o stub

??? 其中-url參數(shù)指定了wsdl文件的路徑,可以是本地路徑,也可以是網(wǎng)絡(luò)路徑。-p參數(shù)指定了生成的Java類的包名,-o參數(shù)指定了生成的一系列文件保存的根目錄。在執(zhí)行完上面的命令后,讀者就會(huì)發(fā)現(xiàn)在當(dāng)前目錄下多了個(gè)stub目錄,在."stub"src"client目錄可以找到一個(gè)SimpleServiceStub.java文件,該文件復(fù)雜調(diào)用WebService,讀者可以在程序中直接使用這個(gè)類,代碼如下:

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());
????}?
}

??? 上面的代碼大大簡(jiǎn)化了調(diào)用WebService的步驟,并使代碼更加簡(jiǎn)潔。但要注意的是,wsdl2java.bat命令生成的Stub類將WebService方法的參數(shù)都封裝在了相應(yīng)的類中,類名為方法名,例如,getGreeting方法的參數(shù)都封裝在了GetGreeting類中,要想調(diào)用getGreeting方法,必須先創(chuàng)建GetGreeting類的對(duì)象實(shí)例。

五、使用C#調(diào)用WebService

??? 從理論上說(shuō),WebService可以被任何支持SOAP協(xié)議的語(yǔ)言調(diào)用。在Visual Studio中使用C#調(diào)用WebService是在所有語(yǔ)言中最容易實(shí)現(xiàn)的(VB.net的調(diào)用方法類似,也同樣很簡(jiǎn)單)。

??? 新建一個(gè)Visual Studio工程,并在引用Web服務(wù)的對(duì)話框中輸入如下的URL,并輸入Web引用名為“WebService”:

??? http://localhost:8080/axis2/services/SimpleService?wsdl

??? 然后引用Web服務(wù)的對(duì)話框就會(huì)顯示該WebService中的所有的方法,如圖5所示。



圖5

??? 在完成上面的工作后,只需要如下三行C#代碼就可以調(diào)用getGreetinggetPrice方法,并顯示這兩個(gè)方法的返回值:

WebService.SimpleService?simpleService?=?new?WSC.WebService.SimpleService();
MessageBox.Show(?simpleService.getGreeting(
"比爾"));
MessageBox.Show(simpleService.getPrice().@return.ToString());

??? .net解析WSDL文件時(shí)直接將getGreeting方法的參數(shù)映射為String類型,因此,可以直接進(jìn)行傳值。
??? 從上面的調(diào)用過(guò)程可以看出,添加Web引用的過(guò)程就相當(dāng)于在Java中調(diào)用wsdl2java.bat自動(dòng)生成stub類的過(guò)程。只是在調(diào)用stub類時(shí)與C#有一定的區(qū)別,但從總體上來(lái)說(shuō),都大大簡(jiǎn)化了調(diào)用WebService的過(guò)程。