WebService大講堂之Axis2 用POJO實現0配置的WebService

轉自：http://www.blogjava.net/nokiaguy/archive/2009/01/02/249556.html

Axis2是一套嶄新的WebService引擎，該版本是對Axis1.x重新設計的產物。Axis2不僅支持SOAP1.1和SOAP1.2，還集成了非常流行的REST WebService，同時還支持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文件放到<Tomcat安裝目錄>\webapps目錄中（本文使用的Tomcat的版本是6.x），並啓動Tomcat。

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

http://localhost:8080/axis2/


如果在瀏覽器中顯示出如圖1所示的頁面，則表示Axis2安裝成功。
二、編寫和發佈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文件放到<Tomcat安裝目錄>\webapps\axis2\WEB-INF\pojo目錄中（如果沒有pojo目錄，則建立該目錄）。現在我們已經成功將SimpleService類發佈成了WebService。在瀏覽器地址欄中輸入如下的URL：

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


這時當前頁面將顯示所有在Axis2中發佈的WebService，

在瀏覽器地址欄中輸入如下的兩個URL來分別測試getGreeting和getPrice方法：

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


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

在編寫、發佈和測試0配置的WebService時應注意如下幾點：

1. POJO類不能使用package關鍵字聲明包。

2. Axis2在默認情況下可以熱發佈WebService，也就是說，將WebService的.class文件複製到pojo目錄中時，Tomcat不需要重新啓動就可以自動發佈WebService。如果想取消Axis2的熱發佈功能，可以打開<Tomcat安裝目錄>\webapps\axis2\WEB-INF\conf\axis2.xml，找到如下的配置代碼：

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


將true改爲false即可。要注意的是，Axis2在默認情況下雖然是熱發佈，但並不是熱更新，也就是說，一旦成功發佈了WebService，再想更新該WebService，就必須重啓Tomcat。這對於開發人員調試WebService非常不方便，因此，在開發WebService時，可以將Axis2設爲熱更新。在axis2.xml文件中找到<parameter name="hotupdate">false</parameter>，將false改爲true即可。

3. 在瀏覽器中測試WebService時，如果WebService方法有參數，需要使用URL的請求參數來指定該WebService方法參數的值，請求參數名與方法參數名要一致，例如，要測試getGreeting方法，請求參數名應爲name，如上面的URL所示。

4. 發佈WebService的pojo目錄只是默認的，如果讀者想在其他的目錄發佈WebService，可以打開axis2.xml文件，並在<axisconfig>元素中添加如下的子元素：

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


上面的配置允許在<Tomcat安裝目錄>\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文件的命名空間名，也就是<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簡化客戶端的編寫

也許有很多讀者會說“有沒有搞錯啊，只調用兩個WebService方法用要寫這麼多代碼，太麻煩了”。

不過幸好Axis2提供了一個wsdl2java.bat命令可以根據WSDL文件自動產生調用WebService的代碼。wsdl2java.bat命令可以在<Axis2安裝目錄>"bin目錄中找到。在使用wsdl2java.bat命令之前需要設置AXIS2_HOME環境變量，該變量值是<Axis2安裝目錄>。

在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”：

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


然後引用Web服務的對話框就會顯示該WebService中的所有的方法，
在完成上面的工作後，只需要如下三行C#代碼就可以調用getGreeting和getPrice方法，並顯示這兩個方法的返回值：

WebService.SimpleService simpleService = new WSC.WebService.SimpleService();
MessageBox.Show( simpleService.getGreeting("比爾"));
MessageBox.Show(simpleService.getPrice()[email protected]());


在.net解析WSDL文件時直接將getGreeting方法的參數映射爲String類型，因此，可以直接進行傳值。
從上面的調用過程可以看出，添加Web引用的過程就相當於在Java中調用wsdl2java.bat自動生成stub類的過程。只是在調用stub類時與C#有一定的區別，但從總體上來說，都大大簡化了調用WebService的過程。