Android訪問WCF服務

原文連接:http://www.cnblogs.com/VinC/archive/2011/02/24/1964049.htmlhtml

 

本章目的: 用Wcf創建能夠上Android能夠訪問的數據服務, 數據傳輸格式採用比較適合於移動互聯網傳輸的Json格式.android

服務的開發流程咱們按照 服務契約(ServiceContract), 服務實現(Service), 實體對象模型(Model) 及服務發佈的流程來介紹.git

因爲本身對Http請求的連接認識的比較淺,對於有些問題無法作出清楚明瞭的解釋, Android訪問WCF這篇文章我會貼出來代碼, 讓後說明一下關注的地方, 不作深刻研究.github

一. 服務契約(Contract)

[ServiceContract]
    public interface IAccountJsonService
    {
        [OperationContract(Name = "GetAccountDataJson")]
        [WebGet(RequestFormat = WebMessageFormat.Json, ResponseFormat = WebMessageFormat.Json, UriTemplate = "GetAccountData", BodyStyle = WebMessageBodyStyle.Bare)]
        List<Account> GetAccountData();

        [OperationContract(Name = "SendMessageJson")]
        [WebInvoke(Method = "GET", ResponseFormat = WebMessageFormat.Json, UriTemplate = "SendMessage/{Message}", BodyStyle = WebMessageBodyStyle.Bare)]
        string SendMessage(string Message);
    }

此契約定義了兩個方法, GetAccountData(獲取Account數據列表, 方法不帶參數), SendMessage, 獲取從客戶端傳過來的數據, 並返回;web

1. 這裏面注意WebInvoke(SendMessage方法)這個Attribute, Method表明了Http的訪問方法, 咱們這是從服務器獲取數據,是請求數據, 因此用GET, 這個也能夠用另一個Attribute來替代-WebGet(GetAccountData方法);json

2. 咱們要給客戶端返回Json數據,咱們只需在WebInvoke or WebGet Attribute中指定ResponseFormat的格式便可, 這個從名字命名就能夠看出來是制定返回的數據格式的.瀏覽器

3. 要注意UriTemplate屬性, 這個是指定咱們請求時的方法路徑, 後面給出示例.服務器

二. 服務實現(Service)

public class AccountService : IAccountJsonService
{
    public List<Account> GetAccountData()
    {
        return MockAccount.AccountList;
    }
    public string SendMessage(string Message)
    {
        return " Message:" + Message;
    }
}

此處只是實現了IAccountJsonService接口.app

三. 實體對象模型&模擬數據

實體類定義:
[DataContract]
    public class Account
    {
        [DataMember]
        public string Name { get; set; }
        [DataMember]
        public int Age { get; set; }
        [DataMember]
        public string Address { get; set; }
        [DataMember]
        public DateTime Birthday { get; set; }
    }
模擬數據:
public class MockAccount
   {
       public static List<Account> AccountList
       {
           get
           {
               var list = new List<Account>();
               list.Add(new Account { Name = "Bill Gates", Address = "YouYi East Road", Age = 56, Birthday = DateTime.Now });
               list.Add(new Account { Name = "Steve Paul Jobs", Address = "YouYi West Road", Age = 57, Birthday = DateTime.Now });
               list.Add(new Account { Name = "John D. Rockefeller", Address = "YouYi North Road", Age = 65, Birthday = DateTime.Now });
               return list;
           }
       }
   }

模擬數據返回一個Account的列表, 含有三條模擬數據, Birthday用DateTime.Now但是隨時查看數據是否是最新生成的.異步

 

四. 服務發佈

在這個例子裏面, 咱們的服務採用Console的發佈形式, 若是採用IIS發佈, 只要參考WCF的服務配置信息, 在IIS環境下配置就OK了.

WCF配置信息

  <system.serviceModel>
    <behaviors>
      <serviceBehaviors>
        <behavior name="">
          <serviceMetadata httpGetUrl="mex" httpGetEnabled="true"/>
          <serviceDebug httpHelpPageEnabled="true" includeExceptionDetailInFaults="true"/>
        </behavior>
      </serviceBehaviors>
      <endpointBehaviors>
        <behavior name="WebHttpBindingBehavior">
          <webHttp/>
        </behavior>
      </endpointBehaviors>
    </behaviors>

    <services>
      <service name="Hosting.AccountService">
        <endpoint address="xml" binding="webHttpBinding"  contract="Hosting.IAccountXmlService" behaviorConfiguration="WebHttpBindingBehavior"/>
        <!--<endpoint address="json" binding="webHttpBinding"  contract="Hosting.IAccountJsonService" behaviorConfiguration="WebHttpBindingBehavior"/>-->
        <host>
          <baseAddresses>
            <add baseAddress="http://127.0.0.1:82/AccountService"/>
          </baseAddresses>
        </host>
      </service>
    </services>
  </system.serviceModel>

控制檯進行服務的託管發佈

class Program
   {
       static void Main(string[] args)
       {
           using (ServiceHost host = new ServiceHost(typeof(AccountService)))
           {
               host.Open();
               Console.WriteLine("AccountService Address:");
               foreach (var endpoint in host.Description.Endpoints)
               {
                   Console.WriteLine(endpoint.Address.ToString());
               }
               Console.WriteLine("AccountService Started,Press any key to stop service...");
               Console.ReadKey();
               host.Close();
           }
       }
   }

下篇將介紹Android如何訪問咱們編寫的服務.

示例代碼下載

 

 

 

此部分分爲 創建Http請求 跟 接受WCF 返回的數據.

一. 創建Http請求的方法

protected String getRequest(String url, DefaultHttpClient client)
            throws Exception {
        String result = null;
        int statusCode = 0;
        HttpGet getMethod = new HttpGet(url);
        Log.d(TAG, "do the getRequest,url=" + url + "");
        try {
            getMethod.setHeader("User-Agent", USER_AGENT);
            // HttpParams params = new HttpParams();

            // 添加用戶密碼驗證信息
            // client.getCredentialsProvider().setCredentials(
            // new AuthScope(null, -1),
            // new UsernamePasswordCredentials(mUsername, mPassword));

            HttpResponse httpResponse = client.execute(getMethod);
            // statusCode == 200 正常
            statusCode = httpResponse.getStatusLine().getStatusCode();
            Log.d(TAG, "statuscode = " + statusCode);
            // 處理返回的httpResponse信息
            result = retrieveInputStream(httpResponse.getEntity());
        } catch (Exception e) {
            Log.e(TAG, e.getMessage());
            throw new Exception(e);
        } finally {
            getMethod.abort();
        }
        return result;
    }

 

參數URL: 咱們要請求的地址

Client:  這個能夠直接用new DefaultHttpClient(new BasicHttpParams()) 來初始化.

這個方法中須要注意RetrieveInputStream方法, 這個是當Http請求完成以後, 用來處理服務器返回數據的方法,

 

二. 接受從WCF端傳回的數據

protected  String retrieveInputStream(HttpEntity httpEntity) {
        int  length = (int) httpEntity.getContentLength();
        if  (length < 0)
            length = 10000;
        StringBuffer stringBuffer = new  StringBuffer(length);
        try  {
            InputStreamReader inputStreamReader = new  InputStreamReader(
                    httpEntity.getContent(), HTTP.UTF_8);
            char  buffer[] = new char[length];
            int  count;
            while  ((count = inputStreamReader.read(buffer, 0, length - 1)) > 0) {
                stringBuffer.append(buffer, 0, count);
            }
        } catch  (UnsupportedEncodingException e) {
            Log.e(TAG, e.getMessage());
        } catch  (IllegalStateException e) {
            Log.e(TAG, e.getMessage());
        } catch  (IOException e) {
            Log.e(TAG, e.getMessage());
        }
        return  stringBuffer.toString();
    }

此方法在接受到WCF服務端返回的數據以後,  轉換程String類型返回.

附加內容:

請求數據以前封裝方法:

    private static final String BASE_URL = "http://10.0.2.2:82/BlogCategoryService/";
    private static final String EXTENSION = "Json/";;
    private static final String TAG = "API";
    private static final String USER_AGENT = "Mozilla/4.5";

    public JSONObject getObject(String sbj) throws JSONException, Exception {
        return new JSONObject(getRequest(BASE_URL + EXTENSION + sbj));
    }

    public JSONArray getArray(String sbj) throws JSONException,
            Exception {
        return new JSONArray(getRequest(BASE_URL + EXTENSION + sbj));
    }

    protected String getRequest(String url) throws Exception {
        return getRequest(url, new DefaultHttpClient(new BasicHttpParams()));
    }

 

 

總結 : 此篇主要說明了Http請求的的兩個階段, 創建請求跟接受服務器返回的數據, 在下篇再主要說明如何處理服務端返回的JSON數據,並把數據顯示在UI上面.

 

 

 

1.寫做背景:

  筆者想實現android調用webservice,但是網上全是無論對與錯亂轉載的文章,結果不但不能解決問題,只會讓人心煩,因此筆者決定將本身整理好的能用的android調用webservice的實現分享給你們,供之後遇到相同需求的人能少走彎路。

  源碼使用android studio編寫,能夠在github上面下載觀看:https://github.com/jhscpang/TestWebSwervice。

 

2.具體實現:

  本文的重點是android怎麼調用webservice而不是用哪一個webservice,因此這裏就用網上傳的比較多的計算來電歸屬地的webservice進行測試。這個webservice地址爲:http://webservice.webxml.com.cn/WebServices/MobileCodeWS.asmx?wsdl。

用瀏覽器訪問這個網址能夠看到以下界面:

圖中被圈起來的部分1說明soap版本爲12, 被圈起來的部分2說明了namespace地址,這兩個值稍後在代碼中能用到。

圖中被圈起來的部分說明了調用的方法的名字,裏面的說明文檔告訴了輸入參數和返回值等信息,這些信息稍後代碼中也會用到。

 

  下面寫請求webservice的方法,代碼以下, 具體每句的解釋有備註:

複製代碼
/**
     * 手機號段歸屬地查詢
     *
     * @param phoneSec 手機號段
     */
    public String getRemoteInfo(String phoneSec) throws Exception{
        String WSDL_URI = "http://webservice.webxml.com.cn/WebServices/MobileCodeWS.asmx?WSDL";//wsdl 的uri
        String namespace = "http://WebXml.com.cn/";//namespace
        String methodName = "getMobileCodeInfo";//要調用的方法名稱

        SoapObject request = new SoapObject(namespace, methodName);
        // 設置需調用WebService接口須要傳入的兩個參數mobileCode、userId
        request.addProperty("mobileCode", phoneSec);
        request.addProperty("userId", "");

        //建立SoapSerializationEnvelope 對象,同時指定soap版本號(以前在wsdl中看到的)
        SoapSerializationEnvelope envelope = new SoapSerializationEnvelope(SoapSerializationEnvelope.VER12);
        envelope.bodyOut = request;//因爲是發送請求,因此是設置bodyOut
        envelope.dotNet = true;//因爲是.net開發的webservice,因此這裏要設置爲true

        HttpTransportSE httpTransportSE = new HttpTransportSE(WSDL_URI);
        httpTransportSE.call(null, envelope);//調用

        // 獲取返回的數據
        SoapObject object = (SoapObject) envelope.bodyIn;
        // 獲取返回的結果
        result = object.getProperty(0).toString();
        Log.d("debug",result);
        return result;

    }
複製代碼

  由於調用webservice屬於聯網操做,所以不能再UI線程中執行訪問webservice,爲了便於將結果反饋給UI線程,採用AsyncTask線程,代碼以下:

複製代碼
 class QueryAddressTask extends AsyncTask<String, Integer, String> {
        @Override
        protected String doInBackground(String... params) {
            // 查詢手機號碼(段)信息*/
            try {
                result = getRemoteInfo(params[0]);

            } catch (Exception e) {
                e.printStackTrace();
            }
            //將結果返回給onPostExecute方法
            return result;
        }

        @Override
        //此方法能夠在主線程改變UI
        protected void onPostExecute(String result) {
            // 將WebService返回的結果顯示在TextView中
            resultView.setText(result);
        }
    }
複製代碼

  而後在主線程中給用戶設置使用該功能的方法,代碼以下:

複製代碼
private EditText phoneSecEditText;
    private TextView resultView;
    private Button queryButton;
    private String result;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        phoneSecEditText = (EditText) findViewById(R.id.phone_sec);
        resultView = (TextView) findViewById(R.id.result_text);
        queryButton = (Button) findViewById(R.id.query_btn);

        queryButton.setOnClickListener(new OnClickListener() {
            @Override
            public void onClick(View v) {
                // 手機號碼(段)
                String phoneSec = phoneSecEditText.getText().toString().trim();
                // 簡單判斷用戶輸入的手機號碼(段)是否合法
                if ("".equals(phoneSec) || phoneSec.length() < 7) {
                    // 給出錯誤提示
                    phoneSecEditText.setError("您輸入的手機號碼(段)有誤!");
                    phoneSecEditText.requestFocus();
                    // 將顯示查詢結果的TextView清空
                    resultView.setText("");
                    return;
                }

                //啓動後臺異步線程進行鏈接webService操做,而且根據返回結果在主線程中改變UI
                QueryAddressTask queryAddressTask = new QueryAddressTask();
                //啓動後臺任務
                queryAddressTask.execute(phoneSec);

            }
        });
    }
複製代碼

  佈局文件以下:

複製代碼
<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    android:orientation="vertical"
    android:layout_width="fill_parent"
    android:layout_height="fill_parent"
    android:paddingTop="5dip"
    android:paddingLeft="5dip"
    android:paddingRight="5dip"
    >
    <TextView
        android:layout_width="fill_parent"
        android:layout_height="wrap_content"
        android:text="手機號碼(段):"
        />
    <EditText android:id="@+id/phone_sec"
        android:layout_width="fill_parent"
        android:layout_height="wrap_content"
        android:inputType="textPhonetic"
        android:singleLine="true"
        android:hint="例如:1398547"
        />
    <Button android:id="@+id/query_btn"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_gravity="right"
        android:text="查詢"
        />
    <TextView android:id="@+id/result_text"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_gravity="center_horizontal|center_vertical"
        />
</LinearLayout>
複製代碼

  AndroidManifest文件以下:

複製代碼
<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.jhsc.testwebservice" >

    <uses-permission android:name="android.permission.INTERNET" />

    <application
        android:allowBackup="true"
        android:icon="@mipmap/ic_launcher"
        android:label="@string/app_name"
        android:supportsRtl="true"
        android:theme="@style/AppTheme" >
        <activity android:name=".MainActivity" >
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />

                <category android:name="android.intent.category.LAUNCHER" />
            </intent-filter>
        </activity>
    </application>

</manifest>
複製代碼

  運行效果以下圖:

 
分類:  Android
相關文章
相關標籤/搜索