Axis2創建WebService實例教程

Apache Axis2 是Axis的後續版本,是新一代的SOAP引擎。那麼Axis2怎麼創建WebService呢?下面一起來看看實例教程吧!

Axis2創建WebService實例教程

Axis2是下一代 Apache Axis。Axis2 雖然由 Axis 1.x 處理程序模型提供支持,但它具有更強的靈活性並可擴展到新的體系結構。Axis2 基於新的體系結構進行了全新編寫,而且沒有采用 Axis 1.x 的常用代碼。支持開發 Axis2 的動力是探尋模塊化更強、靈活性更高和更有效的體系結構,這種體系結構可以很容易地插入到其他相關 Web 服務標準和協議(如 WS-Security、WS-ReliableMessaging 等)的實現中。

  一、Axis2的下載和安裝

1.可從 下載Axis2的最新版本:

可以下載如下兩個zip包:

其中 axis2-1.5.4-bin.zip文件中包含了Axis2中所有的jar文件,

axis2-1.5.4-war.zip文件用於將WebService發佈到Web容器中。

2.將axis2-1.5.4-war.zip文件解壓到相應的目錄,將目錄中的axis2.war文件放到<Tomcat安裝目錄>webapps目錄中,

並啓動Tomcat,在瀏覽器地址欄中輸入如下的URL:

http://localhost:8080/axis2/,如看到axis2的主頁面則安裝成功。

  二、編寫和發佈WebService

(1)用POJO形式發佈(無需配置)

在Axis2中不需要進行任何的配置,就可以直接將一個簡單的POJO發佈成WebService。

其中POJO中所有的public方法將被髮布成WebService方法。

示例代碼如下:

Java代碼

public class HelloService {

public String sayHello(){

return "hello";

}

public String sayHelloToPerson(String name){

if(name==null){

name = "nobody";

}

return "hello,"+name;

}

}

編譯HelloService類後,將HelloService.class文件放到<Tomcat安裝目錄>webappsaxis2WEB-INFpojo目錄中

(如果沒有pojo目錄,則建立該目錄)。現在我們已經成功將HelloService類發佈成了WebService。

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

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

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

://localhost:8080/axis2/services/HelloService/sayHello

://localhost:8080/axis2/services/HelloService/sayHelloToPerson?name=bill

頁面顯示如下結果:

Xml代碼

<ns:sayHelloToPersonResponse xmlns:ns="">

<return>hello,bill</return>

</ns:sayHelloToPersonResponse>

在編寫、發佈和測試WebService時應注意如下幾點:

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

2. Axis2在默認情況下可以熱發佈WebService,也就是說,將WebService的.class文件複製到pojo目錄中時,

Tomcat不需要重新啓動就可以自動發佈WebService。

如果想取消Axis2的熱發佈功能,可以打開<Tomcat安裝目錄>webappsaxis2WEB-INFconf,

找到如下的配置代碼:

Xml代碼

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

將true改爲false即可。要注意的是,Axis2在默認情況下雖然是熱發佈,但並不是熱更新.

也就是說,一旦成功發佈了WebService,再想更新該WebService,就必須重啓Tomcat。

這對於開發人員調試WebService非常不方便,因此,在開發WebService時,可以將Axis2設爲熱更新。

在文件中找到

Xml代碼

<parameter name="hotupdate">false</parameter>

將false改爲true即可。

3. 在瀏覽器中測試WebService時,如果WebService方法有參數,需要使用URL的請求參數來指定該WebService方法

參數的值,請求參數名與方法參數名要一致,例如,要測試sayHelloToPerson方法,請求參數名應爲name,如上面的URL所示。

4. 發佈WebService的pojo目錄只是默認的,如果讀者想在其他的目錄發佈WebService,

可以打開文件,並在<axisconfig>元素中添加如下的子元素:

Xml代碼

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

上面的配置允許在<Tomcat安裝目錄>webappsaxis2WEB-INFmy目錄中發佈WebService。

例如,將本例中的s複製到my目錄中也可以成功發佈

(但要刪除pojo目錄中的s,否則WebService會重名)。

(2)使用配置文件發佈

用Axis2實現Web Service,雖然可以將POJO類放在axis2WEB-INFpojo目錄中直接發佈成Web Service,

這樣做不需要進行任何配置,但這些POJO類不能在任何包中。這似乎有些不方便.

爲此,Axis2也允許將帶包的POJO類發佈成Web Service。先實現一個POJO類,代碼如下:

Java代碼

package ervice;

public class HelloServiceNew {

public String sayHelloNew(){

return "hello";

}

public String sayHelloToPersonNew(String name){

if(name==null){

name = "nobody";

}

return "hello,"+name;

}

public void updateData(String data){

tln(data+" 已更新。");

}

}

要想將HelloServiceNew類發佈成Web Service,需要一個文件,

這個文件需要放在META-INF目錄中,該文件的內容如下:

Xml代碼

<?xml version="1.0" encoding="UTF-8"?>

<service name="HelloServiceNew">

<description>

Web Service例子

</description>

<parameter name="ServiceClass">

oServiceNew

</parameter>

<messageReceivers>

<messageReceiver mep=""

class="essageReceiver" />

<messageReceiver mep=""

class="nOnlyMessageReceiver" />

</messageReceivers>

</service>

其中<service>元素用於發佈Web Service,一個<service>元素只能發佈一個WebService類,

name屬性表示WebService名,如下面的URL可以獲得這個WebService的WSDL內容:

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

其中name屬性名就是上面URL中"?"和"/"之間的部分。

<description>元素表示當前Web Service的描述,<parameter>元素用於設置WebService的參數,

在這裏用於設置WebService對應的類名。

在這裏最值得注意的是<messageReceivers>元素,該元素用於設置處理WebService方法的處理器。

例如,sayHelloNew方法有一個返回值,因此,需要使用可處理輸入輸出的RPCMessageReceiver類,

而updateData方法沒有返回值,因此,需要使用只能處理輸入的RPCInOnlyMessageReceiver類。

使用這種方式發佈WebService,必須打包成文件,文件實際上就是改變了擴展名的文件。

現在建立了兩個文件:和。

將編譯,生成s。

和s文件的位置如下:

D:ws comsinosoftwebservices

D:wsMETA-INF

在windows控制檯中進入ws目錄,並輸入如下的命令生成文件.

jar cvf .

實際上,.jar文件也可以發佈webservice,但axis2官方文檔中建議使用.aar文件發佈webservice.

最後將ws.aar文件複製到<Tomcat安裝目錄>webappsaxis2WEB-INFservices目錄中,

啓動Tomcat後,就可以調用這個WebService了。

另外文件中也可以直接指定WebService類的方法,如可以用下面的配置代碼來發布WebService

Xml代碼

<service name=" HelloServiceNew ">

<description>

Web Service例子

</description>

<parameter name="ServiceClass">

oServiceNew

</parameter>

<operation name="sayHello">

<messageReceiver class="essageReceiver"/>

</operation>

<operation name="updateData">

<messageReceiver

class="nOnlyMessageReceiver"/>

</operation>

</service>

如果想發佈多個WebService,可以使用<serviceGroup>元素

Xml代碼

<serviceGroup>

<service name="myService1">

...

</service>

<service name="myService2">

...

</service>

</serviceGroup>

中間省略的代碼同上面文件的配置。

  三、 用Java實現調用WebService的客戶端程序

WebService是爲程序服務的,只在瀏覽器中訪問WebService是沒有意義的。調用WebService的客戶端代碼如下:

Java代碼

import e;

import Fault;

import ointReference;

import ons;

import erviceClient;

public class TestMain {

public static void main(String args[]) throws AxisFault{

// 使用RPC方式調用WebService

RPCServiceClient serviceClient = new RPCServiceClient();

Options options = ptions();

// 指定調用WebService的URL

EndpointReference targetEPR = new EndpointReference(

"http://localhost:8080/axis2/services/HelloService");

o(targetEPR);

// 指定sayHelloToPerson方法的參數值

Object[] opAddEntryArgs = new Object[] {"美女"};

// 指定sayHelloToPerson方法返回值的數據類型的Class對象

Class[] classes = new Class[] {s};

// 指定要調用的sayHelloToPerson方法及WSDL文件的命名空間

QName opAddEntry = new QName("", "sayHelloToPerson");

// 調用sayHelloToPerson方法並輸出該方法的返回值

tln(keBlocking(opAddEntry, opAddEntryArgs, classes)[0]);

}

}

輸出結果爲:

hello,美女

在編寫客戶端代碼時應注意如下幾點:

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屬性值。

四、用wsdl2java簡化客戶端的編寫

Axis2提供了一個命令可以根據WSDL文件自動產生調用WebService的代碼。

命令可以在<Axis2安裝目錄>/bin目錄中找到。

在使用命令之前需要設置AXIS2_HOME環境變量,該變量值是<Axis2安裝目錄>。

在Windows控制檯輸出如下的命令行來生成調用WebService的代碼:

%AXIS2_HOME%binwsdl2java -uri http://localhost:8080/axis2/services/HelloService?wsdl

-p client -s -o stub

其中-url參數指定了wsdl文件的路徑,可以是本地路徑,也可以是網絡路徑。

-p參數指定了生成的Java類的包名,-o參數指定了生成的一系列文件保存的根目錄。

在執行完上面的命令後,就會發現在當前目錄下多了個stub目錄,

在stub/src/client目錄可以找到一個文件,

該文件複雜調用WebService,可以在程序中直接使用這個類,代碼如下:

Java代碼

package client;

public class StupTest {

public static void main(String[] args) throws Exception

{

HelloServiceStub stub = new HelloServiceStub();

elloToPerson gg = new elloToPerson();

ame("美女");

tln( ello()_return());

tln(elloToPerson(gg)_return());

}

}

輸出結果如下:

hello

hello,美女

上面的代碼大大簡化了調用WebService的步驟,並使代碼更加簡潔。

但要注意的是,命令生成的Stub類將WebService方法的參數都封裝在了相應的類中,

類名爲方法名,例如,sayHelloToPerson方法的參數都封裝在了SayHelloToPerson類中,

要想調用sayHelloToPerson方法,必須先創建SayHelloToPerson類的對象實例。