Axis2建立WebService實例

1、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：
     http://localhost:8080/axis2/，如看到axis2的主頁面則安裝成功。

 

  2、編寫和發佈WebService

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

    在Axis2中不須要進行任何的配置，就能夠直接將一個簡單的POJO發佈成WebService。
    其中POJO中全部的public方法將被髮布成WebService方法。
    示例代碼以下：

    

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

  頁面顯示以下結果：

<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，
        找到以下的配置代碼：

<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方法
     參數的值，請求參數名與方法參數名要一致，例如，要測試sayHelloToPerson方法，請求參數名應爲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。
   例如，將本例中的HelloService.class複製到my目錄中也能夠成功發佈
   （但要刪除pojo目錄中的SimpleService.class，不然WebService會重名）。

 

(2)使用services.xml配置文件發佈

  用Axis2實現Web Service，雖然能夠將POJO類放在axis2\WEB-INF\pojo目錄中直接發佈成Web Service，
  這樣作不須要進行任何配置，但這些POJO類不能在任何包中。這彷佛有些不方便.
  爲此，Axis2也容許將帶包的POJO類發佈成Web Service。先實現一個POJO類，代碼以下：

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 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

<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>元素

<serviceGroup>
<service name="myService1">
    ...
</service>
<service name="myService2">
    ...
</service>
</serviceGroup>

 

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

 

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

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

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

 

  4、用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，能夠在程序中直接使用這個類，代碼以下：

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類的對象實例。