使用axis2建立webservice步驟以及客戶端呼叫service服務程式碼
一、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釋出到Web容器中。
2.將axis2-1.5.4-war.zip檔案解壓到相應的目錄,將目錄中的axis2.war檔案放到<Tomcat安裝目錄>\webapps目錄中,
並啟動Tomcat,在瀏覽器位址列中輸入如下的URL:
二、編寫和釋出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安裝目錄>\webapps\axis2\WEB-INF\pojo目錄中
(如果沒有pojo目錄,則建立該目錄)。現在我們已經成功將HelloService類釋出成了WebService。
在瀏覽器位址列中輸入如下的URL:
在瀏覽器位址列中輸入如下的兩個URL來分別測試sayHelloToPerson和sayHello方法:
1.http://localhost:8080/axis2/services/HelloService/sayHello
2.http://localhost:8080/axis2/services/HelloService/sayHelloToPerson?name=bill
頁面顯示如下結果:
Xml程式碼
- <ns:sayHelloToPersonResponse xmlns:ns="http://ws.apache.org/axis2">
- <return>hello,bill</return>
- </ns:sayHelloToPersonResponse>
在編寫、釋出和測試WebService時應注意如下幾點:
1. POJO類不能使用package關鍵字宣告包。
2. Axis2在預設情況下可以熱釋出WebService,也就是說,將WebService的.class檔案複製到pojo目錄中時,
Tomcat不需要重新啟動就可以自動釋出WebService。
如果想取消Axis2的熱釋出功能,可以開啟<Tomcat安裝目錄>\webapps\axis2\WEB-INF\conf\axis2.xml,
找到如下的配置程式碼:
Xml程式碼
- <parameter name="hotdeployment">true</parameter>
將true改為false即可。要注意的是,Axis2在預設情況下雖然是熱釋出,但並不是熱更新.
也就是說,一旦成功釋出了WebService,再想更新該WebService,就必須重啟Tomcat。
這對於開發人員除錯WebService非常不方便,因此,在開發WebService時,可以將Axis2設為熱更新。
在axis2.xml檔案中找到
Xml程式碼
- <parameter name="hotupdate">false</parameter>
將false改為true即可。
3. 在瀏覽器中測試WebService時,如果WebService方法有引數,需要使用URL的請求引數來指定該WebService方法
引數的值,請求引數名與方法引數名要一致,例如,要測試sayHelloToPerson方法,請求引數名應為name,如上面的URL所示。
4. 釋出WebService的pojo目錄只是預設的,如果讀者想在其他的目錄釋出WebService,
可以開啟axis2.xml檔案,並在<axisconfig>元素中新增如下的子元素:
Xml程式碼
- <deployer extension=".class" directory="my" class="org.apache.axis2.deployment.POJODeployer"/>
上面的配置允許在<Tomcat安裝目錄>\webapps\axis2\WEB-INF\my目錄中釋出WebService。
例如,將本例中的HelloService.class複製到my目錄中也可以成功釋出
(但要刪除pojo目錄中的SimpleService.class,否則WebService會重名)。
(2)使用services.xml配置檔案釋出
用Axis2實現WebService,雖然可以將POJO類放在axis2\WEB-INF\pojo目錄中直接釋出成Web Service,
這樣做不需要進行任何配置,但這些POJO類不能在任何包中。這似乎有些不方便.
為此,Axis2也允許將帶包的POJO類釋出成Web Service。先實現一個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類釋出成Web Service,需要一個services.xml檔案,
這個檔案需要放在META-INF目錄中,該檔案的內容如下:
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>元素用於釋出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,必須打包成.aar檔案,.aar檔案實際上就是改變了副檔名的.jar檔案。
現在建立了兩個檔案: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檔案也可以釋出webservice,但axis2官方文件中建議使用.aar檔案釋出webservice.
最後將ws.aar檔案複製到<Tomcat安裝目錄>\webapps\axis2\WEB-INF\services目錄中,
啟動Tomcat後,就可以呼叫這個WebService了。
另外services.xml檔案中也可以直接指定WebService類的方法,如可以用下面的配置程式碼來發布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>
如果想釋出多個WebService,可以使用<serviceGroup>元素
Xml程式碼
- <serviceGroup>
- <service name="myService1">
- ...
- </service>
- <service name="myService2">
- ...
- </service>
- </serviceGroup>
中間省略的程式碼同上面services.xml檔案的配置。
三、 用Java實現呼叫WebService的客戶端程式
WebService是為程式服務的,只在瀏覽器中訪問WebService是沒有意義的。呼叫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方式呼叫WebService
- RPCServiceClient serviceClient = new RPCServiceClient();
- Options options = serviceClient.getOptions();
- // 指定呼叫WebService的URL
- EndpointReference targetEPR = new EndpointReference(
- "http://localhost:8080/axis2/services/HelloService");
- options.setTo(targetEPR);
- // 指定sayHelloToPerson方法的引數值
- Object[] opAddEntryArgs = new Object[] {"美女"};
- // 指定sayHelloToPerson方法返回值的資料型別的Class物件
- Class[] classes = new Class[] {String.class};
- // 指定要呼叫的sayHelloToPerson方法及WSDL檔案的名稱空間
- QName opAddEntry = new QName("http://ws.apache.org/axis2", "sayHelloToPerson");
- // 呼叫sayHelloToPerson方法並輸出該方法的返回值
- System.out.println(serviceClient.invokeBlocking(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提供了一個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/HelloService?wsdl
-p client -s -o stub
其中-url引數指定了wsdl檔案的路徑,可以是本地路徑,也可以是網路路徑。
-p引數指定了生成的Java類的包名,-o引數指定了生成的一系列檔案儲存的根目錄。
在執行完上面的命令後,就會發現在當前目錄下多了個stub目錄,
在stub/src/client目錄可以找到一個HelloServiceStub.java檔案,
該檔案複雜呼叫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());
- }
- }
輸出結果如下:
hello
hello,美女
上面的程式碼大大簡化了呼叫WebService的步驟,並使程式碼更加簡潔。
但要注意的是,wsdl2java.bat命令生成的Stub類將WebService方法的引數都封裝在了相應的類中,
類名為方法名,例如,sayHelloToPerson方法的引數都封裝在了SayHelloToPerson類中,
要想呼叫sayHelloToPerson方法,必須先建立SayHelloToPerson類的物件例項。
參考:http://clq9761.iteye.com/blog/976029