- 相關(guān)推薦
Axis2創(chuàng)建WebService實例教程
Apache Axis2 是Axis的后續(xù)版本，是新一代的SOAP引擎。那么Axis2怎么創(chuàng)建WebService呢？下面一起來看看實例教程吧！
Axis2是下一代 Apache Axis。Axis2 雖然由 Axis 1.x 處理程序模型提供支持，但它具有更強的靈活性并可擴展到新的體系結(jié)構(gòu)。Axis2 基于新的體系結(jié)構(gòu)進行了全新編寫，而且沒有采用 Axis 1.x 的常用代碼。支持開發(fā) Axis2 的動力是探尋模塊化更強、靈活性更高和更有效的體系結(jié)構(gòu)，這種體系結(jié)構(gòu)可以很容易地插入到其他相關(guān) Web 服務(wù)標準和協(xié)議（如 WS-Security、WS-ReliableMessaging 等）的實現(xiàn)中。
一、Axis2的下載和安裝
1.可從http://ws.apache.org/axis2/ 下載Axis2的最新版本：
可以下載如下兩個zip包：
axis2-1.5.4-bin.zip
axis2-1.5.4-war.zip
其中 axis2-1.5.4-bin.zip文件中包含了Axis2中所有的jar文件,
axis2-1.5.4-war.zip文件用于將WebService發(fā)布到Web容器中。
2.將axis2-1.5.4-war.zip文件解壓到相應(yīng)的目錄，將目錄中的axis2.war文件放到<Tomcat安裝目錄>\webapps目錄中，
并啟動Tomcat,在瀏覽器地址欄中輸入如下的URL：
http://localhost:8080/axis2/，如看到axis2的主頁面則安裝成功。
二、編寫和發(fā)布WebService
(1)用POJO形式發(fā)布（無需配置）
在Axis2中不需要進行任何的配置，就可以直接將一個簡單的POJO發(fā)布成WebService。
其中POJO中所有的public方法將被發(fā)布成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安裝目錄>\webapps\axis2\WEB-INF\pojo目錄中
（如果沒有pojo目錄，則建立該目錄）。現(xiàn)在我們已經(jīng)成功將HelloService類發(fā)布成了WebService。
在瀏覽器地址欄中輸入如下的URL：
http://localhost:8080/axis2/services/listServices
在瀏覽器地址欄中輸入如下的兩個URL來分別測試sayHelloToPerson和sayHello方法：
1.http://localhost:8080/axis2/services/HelloService/sayHello
2.http://localhost:8080/axis2/services/HelloService/sayHelloToPerson?name=bill
頁面顯示如下結(jié)果：
Xml代碼
<ns:sayHelloToPersonResponse xmlns:ns="http://ws.apache.org/axis2">
<return>hello,bill</return>
</ns:sayHelloToPersonResponse>
在編寫、發(fā)布和測試WebService時應(yīng)注意如下幾點：
1. POJO類不能使用package關(guān)鍵字聲明包。
2. Axis2在默認情況下可以熱發(fā)布WebService，也就是說，將WebService的.class文件復制到pojo目錄中時，
Tomcat不需要重新啟動就可以自動發(fā)布WebService。
如果想取消Axis2的熱發(fā)布功能，可以打開<Tomcat安裝目錄>\webapps\axis2\WEB-INF\conf\axis2.xml，
找到如下的配置代碼：
Xml代碼
<parameter name="hotdeployment">true</parameter>
將true改為false即可。要注意的是，Axis2在默認情況下雖然是熱發(fā)布，但并不是熱更新.
也就是說，一旦成功發(fā)布了WebService，再想更新該WebService，就必須重啟Tomcat。
這對于開發(fā)人員調(diào)試WebService非常不方便，因此，在開發(fā)WebService時，可以將Axis2設(shè)為熱更新。
在axis2.xml文件中找到
Xml代碼
<parameter name="hotupdate">false</parameter>
將false改為true即可。
3. 在瀏覽器中測試WebService時，如果WebService方法有參數(shù)，需要使用URL的請求參數(shù)來指定該WebService方法
參數(shù)的值，請求參數(shù)名與方法參數(shù)名要一致，例如，要測試sayHelloToPerson方法，請求參數(shù)名應(yīng)為name，如上面的URL所示。
4. 發(fā)布WebService的pojo目錄只是默認的，如果讀者想在其他的目錄發(fā)布WebService，
可以打開axis2.xml文件，并在<axisconfig>元素中添加如下的子元素：
Xml代碼
<deployer extension=".class" directory="my" class="org.apache.axis2.deployment.POJODeployer"/>
上面的配置允許在<Tomcat安裝目錄>\webapps\axis2\WEB-INF\my目錄中發(fā)布WebService。
例如，將本例中的HelloService.class復制到my目錄中也可以成功發(fā)布
（但要刪除pojo目錄中的SimpleService.class，否則WebService會重名）。
(2)使用services.xml配置文件發(fā)布
用Axis2實現(xiàn)Web Service，雖然可以將POJO類放在axis2\WEB-INF\pojo目錄中直接發(fā)布成Web Service，
這樣做不需要進行任何配置，但這些POJO類不能在任何包中。這似乎有些不方便.
為此，Axis2也允許將帶包的POJO類發(fā)布成Web Service。先實現(xiàn)一個POJO類，代碼如下：
Java代碼
package com.sinosoft.webservice;
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){
System.out.println(data+" 已更新。");
}
}
要想將HelloServiceNew類發(fā)布成Web Service，需要一個services.xml文件，
這個文件需要放在META-INF目錄中，該文件的內(nèi)容如下：
Xml代碼
<?xml version="1.0" encoding="UTF-8"?>
<service name="HelloServiceNew">
<description>
Web Service例子
</description>
<parameter name="ServiceClass">
com.sinosoft.webservice.HelloServiceNew
</parameter>
<messageReceivers>
<messageReceiver mep="http://www.w3.org/2004/08/wsdl/in-out"
class="org.apache.axis2.rpc.receivers.RPCMessageReceiver" />
<messageReceiver mep="http://www.w3.org/2004/08/wsdl/in-only"
class="org.apache.axis2.rpc.receivers.RPCInOnlyMessageReceiver" />
</messageReceivers>
</service>
其中<service>元素用于發(fā)布Web Service，一個<service>元素只能發(fā)布一個WebService類，
name屬性表示W(wǎng)ebService名，如下面的URL可以獲得這個WebService的WSDL內(nèi)容：
http://localhost:8080/axis2/services/HelloServiceNew?wsdl
其中name屬性名就是上面URL中"?"和"/"之間的部分。
<description>元素表示當前Web Service的描述，<parameter>元素用于設(shè)置WebService的參數(shù)，
在這里用于設(shè)置WebService對應(yīng)的類名。
在這里最值得注意的是<messageReceivers>元素，該元素用于設(shè)置處理WebService方法的處理器。
例如，sayHelloNew方法有一個返回值，因此，需要使用可處理輸入輸出的RPCMessageReceiver類，
而updateData方法沒有返回值，因此，需要使用只能處理輸入的RPCInOnlyMessageReceiver類。
使用這種方式發(fā)布WebService，必須打包成.aar文件，.aar文件實際上就是改變了擴展名的.jar文件。
現(xiàn)在建立了兩個文件：HelloServiceNew.java和services.xml。
將HelloServiceNew.java編譯，生成HelloServiceNew.class。
services.xml和HelloServiceNew.class文件的位置如下：
D:\ws\ com\sinosoft\webservice\HelloServiceNew.class
D:\ws\META-INF\services.xml
在windows控制臺中進入ws目錄，并輸入如下的命令生成.aar文件.
jar cvf ws.aar .
實際上，.jar文件也可以發(fā)布webservice，但axis2官方文檔中建議使用.aar文件發(fā)布webservice.
最后將ws.aar文件復制到<Tomcat安裝目錄>\webapps\axis2\WEB-INF\services目錄中，
啟動Tomcat后，就可以調(diào)用這個WebService了。
另外services.xml文件中也可以直接指定WebService類的方法，如可以用下面的配置代碼來發(fā)布WebService
Xml代碼
<service name=" HelloServiceNew ">
<description>
Web Service例子
</description>
<parameter name="ServiceClass">
com.sinosoft.webservice.HelloServiceNew
</parameter>
<operation name="sayHello">
<messageReceiver class="org.apache.axis2.rpc.receivers.RPCMessageReceiver"/>
</operation>
<operation name="updateData">
<messageReceiver
class="org.apache.axis2.rpc.receivers.RPCInOnlyMessageReceiver"/>
</operation>
</service>
如果想發(fā)布多個WebService，可以使用<serviceGroup>元素
Xml代碼
<serviceGroup>
<service name="myService1">
...
</service>
<service name="myService2">
...
</service>
</serviceGroup>
中間省略的代碼同上面services.xml文件的配置。
三、 用Java實現(xiàn)調(diào)用WebService的客戶端程序
WebService是為程序服務(wù)的，只在瀏覽器中訪問WebService是沒有意義的。調(diào)用WebService的客戶端代碼如下：
Java代碼
import javax.xml.namespace.QName;
import org.apache.axis2.AxisFault;
import org.apache.axis2.addressing.EndpointReference;
import org.apache.axis2.client.Options;
import org.apache.axis2.rpc.client.RPCServiceClient;
public class TestMain {
public static void main(String args[]) throws AxisFault{
// 使用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/HelloService");
options.setTo(targetEPR);
// 指定sayHelloToPerson方法的參數(shù)值
Object[] opAddEntryArgs = new Object[] {"美女"};
// 指定sayHelloToPerson方法返回值的數(shù)據(jù)類型的Class對象
Class[] classes = new Class[] {String.class};
// 指定要調(diào)用的sayHelloToPerson方法及WSDL文件的命名空間
QName opAddEntry = new QName("http://ws.apache.org/axis2", "sayHelloToPerson");
// 調(diào)用sayHelloToPerson方法并輸出該方法的返回值
System.out.println(serviceClient.invokeBlocking(opAddEntry, opAddEntryArgs, classes)[0]);
}
}
輸出結(jié)果為：
hello,美女
在編寫客戶端代碼時應(yīng)注意如下幾點：
1. 客戶端代碼需要引用很多Axis2的jar包，如果讀者不太清楚要引用哪個jar包，
可以在Eclipse的工程中引用Axis2發(fā)行包的lib目錄中的所有jar包。
2. 在本例中使用了RPCServiceClient類的invokeBlocking方法調(diào)用了WebService中的方法。
invokeBlocking方法有三個參數(shù)，其中第一個參數(shù)的類型是QName對象，表示要調(diào)用的方法名；
第二個參數(shù)表示要調(diào)用的WebService方法的參數(shù)值，參數(shù)類型為Object[]；
第三個參數(shù)表示W(wǎng)ebService方法的返回值類型的Class對象，參數(shù)類型為Class[]。
當方法沒有參數(shù)時，invokeBlocking方法的第二個參數(shù)值不能是null，而要使用new Object[]{}。
3. 如果被調(diào)用的WebService方法沒有返回值，應(yīng)使用RPCServiceClient類的invokeRobust方法，
該方法只有兩個參數(shù)，它們的含義與invokeBlocking方法的前兩個參數(shù)的含義相同。
4. 在創(chuàng)建QName對象時，QName類的構(gòu)造方法的第一個參數(shù)表示W(wǎng)SDL文件的命名空間名，
也就是<wsdl:definitions>元素的targetNamespace屬性值。
四、用wsdl2java簡化客戶端的編寫
Axis2提供了一個wsdl2java.bat命令可以根據(jù)WSDL文件自動產(chǎn)生調(diào)用WebService的代碼。
wsdl2java.bat命令可以在<Axis2安裝目錄>/bin目錄中找到。
在使用wsdl2java.bat命令之前需要設(shè)置AXIS2_HOME環(huán)境變量，該變量值是<Axis2安裝目錄>。
在Windows控制臺輸出如下的命令行來生成調(diào)用WebService的代碼：
%AXIS2_HOME%\bin\wsdl2java -uri http://localhost:8080/axis2/services/HelloService?wsdl
-p client -s -o stub
其中-url參數(shù)指定了wsdl文件的路徑，可以是本地路徑，也可以是網(wǎng)絡(luò)路徑。
-p參數(shù)指定了生成的Java類的包名，-o參數(shù)指定了生成的一系列文件保存的根目錄。
在執(zhí)行完上面的命令后，就會發(fā)現(xiàn)在當前目錄下多了個stub目錄，
在stub/src/client目錄可以找到一個HelloServiceStub.java文件，
該文件復雜調(diào)用WebService，可以在程序中直接使用這個類，代碼如下：
Java代碼
package client;
public class StupTest {
public static void main(String[] args) throws Exception
{
HelloServiceStub stub = new HelloServiceStub();
HelloServiceStub.SayHelloToPerson gg = new HelloServiceStub.SayHelloToPerson();
gg.setName("美女");
System.out.println( stub.sayHello().get_return());
System.out.println(stub.sayHelloToPerson(gg).get_return());
}
}
輸出結(jié)果如下：
hello
hello,美女
上面的代碼大大簡化了調(diào)用WebService的步驟，并使代碼更加簡潔。
但要注意的是，wsdl2java.bat命令生成的Stub類將WebService方法的參數(shù)都封裝在了相應(yīng)的類中，
類名為方法名，例如，sayHelloToPerson方法的參數(shù)都封裝在了SayHelloToPerson類中，
要想調(diào)用sayHelloToPerson方法，必須先創(chuàng)建SayHelloToPerson類的對象實例。
【Axis2創(chuàng)建WebService實例教程】相關(guān)文章：
h3c交換機配置telnet實例教程07-04
創(chuàng)建公司的過程01-22
CAD邊界如何創(chuàng)建10-02
CAD如何創(chuàng)建新布局06-09
品牌創(chuàng)建的成功與失敗原因01-05