Android呼叫WebService詳解

lostinai發表於2013-04-20
AndroidWeb

轉自http://blog.csdn.net/lyq8479/article/details/6428288#reply

上篇文章已經對Web Service及其相關知識進行了介紹（Android開發之WebService介紹 ），相信有的朋友已經忍耐不住想試試在Android應用中呼叫Web Service。本文將通過一個簡單的示例講解和演示Android平臺的Web Service開發。

Ksoap2-android簡介
      在Android平臺呼叫Web Service需要依賴於第三方類庫ksoap2，它是一個SOAP Web service客戶端開發包，主要用於資源受限制的Java環境如Applets或J2ME應用程式（CLDC/ CDC/MIDP）。認真讀完對ksoap2的介紹你會發現並沒有提及它應用於Android平臺開發，沒錯，在Android平臺中我們並不會直接使用ksoap2，而是使用ksoap2 android。KSoap2 Android 是Android平臺上一個高效、輕量級的SOAP開發包，等同於Android平臺上的KSoap2的移植版本。

Ksoap2-android jar包下載
      ksoap2 android當前的最新版本為2.5.4，名為ksoap2-android-assembly-2.5.4-jar-with-dependencies.jar，它的下載地址是：http://code.google.com/p/ksoap2-android/，進入頁面後，點選“Downloads”標籤頁，如下圖所示：
     
      在“Downloads”頁面的下方，找到如下圖所示的紫色的連結，然後在連結上點選右鍵，找到相關下載項進行下載即可。右鍵選單中顯示的下載項依據瀏覽器的不同而有所區別，比如我使用的360瀏覽器，在鍵接上點選右鍵，然後選擇“使用360安全瀏覽器下載”即可彈出下載儲存對話方塊。
     

Android平臺呼叫Web Service示例
     下面將通過一個示例講解如何在Android平臺呼叫Web Service。既然要呼叫Web Service，那就要先有Web Service。我們還是選擇使用上篇文章中介紹的查詢手機號碼歸屬地的Web service，它的WSDL為http://webservice.webxml.com.cn/WebServices/MobileCodeWS.asmx?wsdl。
1）新建Android工程，引入上面下載的ksoap2-android類庫
      Android工程的建立就不多說了，主要想說明的是如何向Android工程中新增第三方jar包。當然，新增第3方jar的方式有多種，我個人比較喜歡用下面這種方式，即先將第三方jar包拷貝到工程某個目錄下，再將其加入到工程的Build Path中。
      例如，我建立的Android工程名為WSClient，在工程名上點選右鍵，新建一個Folder（目錄或資料夾），名為libs，然後將ksoap2-android類庫拷貝到libs目錄中，如下圖所示：
            
      接著，在jar包ksoap2-android-assembly-2.4-jar-with-dependencies.jar上點選右鍵，依次選擇“Build Path”-“Add to Build Path”。再在工程名上點選右鍵，依次選擇“Build Path”-“Config Build Path...”，將看到如下所示介面：
     
選中ksoap2 jar包前面的選項框，點選OK，則完成了ksoap2 jar包的新增（說明：在Android工程中，新增其它jar包的方法完全一樣，操作一兩遍後，你會發現其實很簡單的）。
2）編寫佈局檔案res/layout/main.xml      

[html] view plaincopy
  1. <?xml version="1.0" encoding="utf-8"?>  
  2. <LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"  
  3.     android:orientation="vertical"  
  4.     android:layout_width="fill_parent"  
  5.     android:layout_height="fill_parent"  
  6.     android:paddingTop="5dip"  
  7.     android:paddingLeft="5dip"  
  8.     android:paddingRight="5dip"  
  9.     >  
  10.     <TextView  
  11.         android:layout_width="fill_parent"   
  12.         android:layout_height="wrap_content"   
  13.         android:text="手機號碼(段)："  
  14.     />  
  15.     <EditText android:id="@+id/phone_sec"  
  16.         android:layout_width="fill_parent"  
  17.         android:layout_height="wrap_content"  
  18.         android:inputType="textPhonetic"  
  19.         android:singleLine="true"  
  20.         android:hint="例如：1398547"  
  21.     />  
  22.     <Button android:id="@+id/query_btn"  
  23.         android:layout_width="wrap_content"  
  24.         android:layout_height="wrap_content"  
  25.         android:layout_gravity="right"  
  26.         android:text="查詢"  
  27.     />  
  28.     <TextView android:id="@+id/result_text"  
  29.         android:layout_width="wrap_content"   
  30.         android:layout_height="wrap_content"   
  31.         android:layout_gravity="center_horizontal|center_vertical"  
  32.     />  
  33. </LinearLayout>  

3）編寫MainActivity類

[java] view plaincopy
  1. package com.liufeng.ws.activity;  
  2.   
  3. import org.ksoap2.SoapEnvelope;  
  4. import org.ksoap2.serialization.SoapObject;  
  5. import org.ksoap2.serialization.SoapSerializationEnvelope;  
  6. import org.ksoap2.transport.HttpTransportSE;  
  7.   
  8. import android.app.Activity;  
  9. import android.os.Bundle;  
  10. import android.view.View;  
  11. import android.view.View.OnClickListener;  
  12. import android.widget.Button;  
  13. import android.widget.EditText;  
  14. import android.widget.TextView;  
  15.   
  16. /** 
  17.  * Android平臺呼叫WebService（手機號碼歸屬地查詢） 
  18.  *  
  19.  * @author liufeng 
  20.  * @date 2011-05-18 
  21.  */  
  22. public class MainActivity extends Activity {  
  23.     private EditText phoneSecEditText;  
  24.     private TextView resultView;  
  25.     private Button queryButton;  
  26.   
  27.     @Override  
  28.     public void onCreate(Bundle savedInstanceState) {  
  29.         super.onCreate(savedInstanceState);  
  30.         setContentView(R.layout.main);  
  31.   
  32.         phoneSecEditText = (EditText) findViewById(R.id.phone_sec);  
  33.         resultView = (TextView) findViewById(R.id.result_text);  
  34.         queryButton = (Button) findViewById(R.id.query_btn);  
  35.   
  36.         queryButton.setOnClickListener(new OnClickListener() {  
  37.             @Override  
  38.             public void onClick(View v) {  
  39.                 // 手機號碼（段）  
  40.                 String phoneSec = phoneSecEditText.getText().toString().trim();  
  41.                 // 簡單判斷使用者輸入的手機號碼（段）是否合法  
  42.                 if ("".equals(phoneSec) || phoneSec.length() < 7) {  
  43.                     // 給出錯誤提示  
  44.                     phoneSecEditText.setError("您輸入的手機號碼（段）有誤！");  
  45.                     phoneSecEditText.requestFocus();  
  46.                     // 將顯示查詢結果的TextView清空  
  47.                     resultView.setText("");  
  48.                     return;  
  49.                 }  
  50.                 // 查詢手機號碼（段）資訊  
  51.                 getRemoteInfo(phoneSec);  
  52.             }  
  53.         });  
  54.     }  
  55.   
  56.     /** 
  57.      * 手機號段歸屬地查詢 
  58.      *  
  59.      * @param phoneSec 手機號段 
  60.      */  
  61.     public void getRemoteInfo(String phoneSec) {  
  62.         // 名稱空間  
  63.         String nameSpace = "http://WebXml.com.cn/";  
  64.         // 呼叫的方法名稱  
  65.         String methodName = "getMobileCodeInfo";  
  66.         // EndPoint  
  67.         String endPoint = "http://webservice.webxml.com.cn/WebServices/MobileCodeWS.asmx";  
  68.         // SOAP Action  
  69.         String soapAction = "http://WebXml.com.cn/getMobileCodeInfo";  
  70.   
  71.         // 指定WebService的名稱空間和呼叫的方法名  
  72.         SoapObject rpc = new SoapObject(nameSpace, methodName);  
  73.   
  74.         // 設定需呼叫WebService介面需要傳入的兩個引數mobileCode、userId  
  75.         rpc.addProperty("mobileCode", phoneSec);  
  76.         rpc.addProperty("userId", "");  
  77.   
  78.         // 生成呼叫WebService方法的SOAP請求資訊,並指定SOAP的版本  
  79.         SoapSerializationEnvelope envelope = new SoapSerializationEnvelope(SoapEnvelope.VER10);  
  80.   
  81.         envelope.bodyOut = rpc;  
  82.         // 設定是否呼叫的是dotNet開發的WebService  
  83.         envelope.dotNet = true;  
  84.         // 等價於envelope.bodyOut = rpc;  
  85.         envelope.setOutputSoapObject(rpc);  
  86.   
  87.         HttpTransportSE transport = new HttpTransportSE(endPoint);  
  88.         try {  
  89.             // 呼叫WebService  
  90.             transport.call(soapAction, envelope);  
  91.         } catch (Exception e) {  
  92.             e.printStackTrace();  
  93.         }  
  94.   
  95.         // 獲取返回的資料  
  96.         SoapObject object = (SoapObject) envelope.bodyIn;  
  97.         // 獲取返回的結果  
  98.         String result = object.getProperty(0).toString();  
  99.   
  100.         // 將WebService返回的結果顯示在TextView中  
  101.         resultView.setText(result);  
  102.     }  
  103. }  

講解：
      注意點1：如程式碼中的62-69行所示，呼叫Web Service之前你需要先弄清楚這4個的值分別是什麼：名稱空間、呼叫的方法名稱、EndPoint和SOAP Action。當在瀏覽器中訪問WSDL時，很容易得知名稱空間、呼叫的方法名稱是什麼（不明白的請看上篇文章），至於EndPoint通常是將WSDL地址末尾的"?wsdl"去除後剩餘的部分；而SOAP Action通常為名稱空間 + 呼叫的方法名稱。
      注意點2：75-76行是設定呼叫WebService介面方法需要傳入的引數。（在WSDL中能夠看到呼叫方法需要傳入的引數個數及引數名稱，在設定引數時最好指明每一個傳入引數的名稱，如本例中的mobileCode、userId。網上有些資料說在需要傳入多個引數時，只要多個引數的順序與WSDL中引數出現的順序一致即可，名稱並不需要和WSDL中的一致，但實際測試發現，大多數情況下並不可行！）
      例如下面圖版上顯示的WSDL片段，呼叫該Web Service的checkUserInfo方法就需要傳入4個引數，引數名稱分別為：in0、in1、in2和in3。
           
      注意點3：也許你會對第100行程式碼產生疑惑，為什麼要用object.getProperty("getMobileCodeInfoResult")來取得呼叫結果？那是因為WSDL中明確告訴了返回結果是String陣列，它的名稱為getDatabaseInfoResult，WSDL中的描述如下：
           <s:elementminOccurs="0" maxOccurs="1" name="getDatabaseInfoResult" type="tns:ArrayOfString" /> 
      本例中呼叫WebService後返回的結果如下所示：
           <?xml version="1.0" encoding="utf-8"?> 
            <string xmlns="http://WebXml.com.cn/">1398547：貴州 貴陽 貴州移動黔中游卡</string>
咦，這裡明明返回的是xml格式的內容，為什麼我們不需要通過解析xml來獲取我們需要的內容呢？其實如果你仔細看程式碼中的96-97行並不難發現：
            // 獲取返回的資料
            SoapObject object = (SoapObject) envelope.bodyIn;
ksoap2能夠將返回的xml轉換成SoapObject物件，然後我們就可以通過操作物件的方式來獲取需要的資料了。
      注意點4：同樣還是第100行程式碼。從有些WSDL中我們並不能得知返回結果的名稱（如本例中的getMobileCodeInfoResult），那又該如何呼叫呢？其實上面已經暗示了這個問題：當通過第97行程式碼獲取返回結果並將其轉換成SoapObject物件後，如果你並不知道通過該物件的哪個屬性來取值，你完全可以呼叫物件的toString()方法來檢視返回的內容，例如將本例中的第100行程式碼替換成：
            // 獲取返回的結果
             String result = object.toString();
這樣得到的返回結果為：
     
注意看括號{}裡面的內容是一個鍵-值對形式，以等號=分隔，我們正是通過=號左邊的“getMobileCodeInfoResult”來獲取右邊的查詢結果。
      其實在不知道返回結果名稱時（如本例的100行，我們並不知道返回結果中有屬性getMobileCodeInfoResult），有一種更為簡便的方法，直接通過索引下標來獲取屬性值，也就是將第100行程式碼替換為：
            String result = object.getProperty(0).toString();
      注意點5：本例中只返回了一個值，但有些WebService會返回多個值該怎麼獲取？獲取方法與本例完全一樣，只是需要注意的是如果是返回多個值，通過第100程式碼object.getProperty(0);得到的可能仍然是一個SoapObject。不斷地呼叫getProperty()方法；總能得到你想要的全部結果。
      注意點6：在呼叫某些WebService時，可能會報一些異常，但你又發現除了呼叫的WebService不同之外，其它地方的寫法和我的完全一樣，這又該如何解決呢？嘗試改變第79程式碼中SOAP的版本號，可以分別嘗試使用SoapEnvelope.VER10、SoapEnvelope.VER11、SoapEnvelope.VER12這樣三個值。另外，在呼叫某些WebService時，可能在第91行程式碼中，呼叫WebService時並不需要傳入soapAction，將其置為null即可。
4）在AndroidManifest.xml中配置新增訪問網路的許可權（千萬別忘記!!!）      

[html] view plaincopy
  1. <?xml version="1.0" encoding="utf-8"?>  
  2. <manifest xmlns:android="http://schemas.android.com/apk/res/android"  
  3.       package="com.liufeng.ws.activity"  
  4.       android:versionCode="1"  
  5.       android:versionName="1.0">  
  6.     <application android:icon="@drawable/icon" android:label="@string/app_name">  
  7.         <activity android:name=".MainActivity" android:label="@string/app_name">  
  8.             <intent-filter>  
  9.                 <action android:name="android.intent.action.MAIN" />  
  10.                 <category android:name="android.intent.category.LAUNCHER" />  
  11.             </intent-filter>  
  12.         </activity>  
  13.     </application>  
  14.   
  15.     <uses-sdk android:minSdkVersion="4" />  
  16.     <!-- 訪問網路的許可權 -->  
  17.     <uses-permission android:name="android.permission.INTERNET" />   
  18. </manifest>   

5）執行結果
     


相關文章