使用axis2發佈web service

   Axis2 是一套嶄新的WebService 引擎，該版本是對Axis1.x 從新設計的產物。Axis2 不只支持SOAP1.1 和SOAP1.2 ，還集成了很是流行的REST WebService ，同時還支持Spring 、JSON 等技術。這些都將在後面的系列教程中講解。在本文中主要介紹瞭如何使用Axis2 開發一個不須要任何配置文件的WebService ，並在客戶端使用Java 和C# 調用這個WebService 。

1、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安裝成功。

圖1

2、編寫和發佈WebService

  對於用Java實現的服務程序給人的印象就是須要進行大量的配置，不過這一點在Axis2中將被終結。在Axis2中不須要進行任何的配置，就能夠直接將一個簡單的POJO發佈成WebService。其中POJO中全部的public方法將被髮布成WebService方法。

    下面咱們來實現一個簡單的POJO，代碼以下：

Code highlighting produced by Actipro CodeHighlighter (freeware)
http://www.CodeHighlighter.com/

--> 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，如圖2所示。

圖2

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

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

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

    圖3和圖4分別顯示了getGreeting和getPrice方法的測試結果。

圖3  getGreeting方法的測試結果

圖4  getPrice方法的測試結果

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

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

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

Code highlighting produced by Actipro CodeHighlighter (freeware)
http://www.CodeHighlighter.com/

--> < 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>元素中添加以下的子元素：

Code highlighting produced by Actipro CodeHighlighter (freeware)
http://www.CodeHighlighter.com/

-->      < 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會重名）。

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

    WebService是爲程序服務的，只在瀏覽器中訪問WebService是沒有意義的。所以，在本節使用Java實現了一個控制檯程序來調用上一節發佈的WebService。調用WebService的客戶端代碼以下：

Code highlighting produced by Actipro CodeHighlighter (freeware)
http://www.CodeHighlighter.com/

--> 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 ]);
    } 
}

運行上面的程序後，將在控制檯輸出以下的信息：

Code highlighting produced by Actipro CodeHighlighter (freeware)
http://www.CodeHighlighter.com/

--> 你好 超人
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文件的代碼片斷：

Code highlighting produced by Actipro CodeHighlighter (freeware)
http://www.CodeHighlighter.com/

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

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

Code highlighting produced by Actipro CodeHighlighter (freeware)
http://www.CodeHighlighter.com/

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

5、使用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中的全部的方法，如圖5所示。

圖5

    在完成上面的工做後，只須要以下三行C#代碼就能夠調用getGreeting和getPrice方法，並顯示這兩個方法的返回值：

Code highlighting produced by Actipro CodeHighlighter (freeware)
http://www.CodeHighlighter.com/

--> WebService.SimpleService simpleService  =   new  WSC.WebService.SimpleService();
MessageBox.Show( simpleService.getGreeting( " 比爾 " ));
MessageBox.Show(simpleService.getPrice().@return.ToString());

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