基於Web Service的客戶端框架搭建一:C#使用Http Post方式傳遞Json數據字符串調用Web Service


 

引言

  前段時間一直在做一個ERP系統,隨着系統功能的完善,客戶端(CS模式)變得越來越臃腫。現在想將業務邏輯層以下部分和界面層分離,使用Web Service來做。由於C#中通過直接添加引用的方來調用Web Service的方式不夠靈活,故采取手動發送Http請求的方式來調用Web Service。最后選擇使用Post方式來調用Web Service,至於安全性和效率暫不考慮。在學習使用的過程,遇到了很多問題,也花了很長時間來解決,網上相關的帖子很少,如果各位在使用的過程中有一些問題難以解決,可以找我哦。

 

前提

  使用Post方式調用Web Service,需要在服務項目配置文件Web.config中添加使用Http協議的配置,在<system.web>標簽中添加<webServices> <protocols> <add name= "HttpPost"/></protocols></webServices>配置,同時我們還可以添加<customErrors mode="Off" />配置,這樣可以在服務方法的返回值帶出服務方法調用的異常信息,異常信息同樣以xml的形式返回,這樣便於客戶端進行調試。

 

Web Service接口方法

   [WebMethod]
        public string Project(string paramaters)
        {
            return paramaters;
        }

 

實現代碼

 

 1        public string Post(string methodName, string jsonParas)
 2         {
 3             string strURL = Url + "/" + methodName;
 4 
 5             //創建一個HTTP請求  
 6             HttpWebRequest request = (HttpWebRequest)WebRequest.Create(strURL);
 7             //Post請求方式  
 8             request.Method = "POST";
 9             //內容類型
10             request.ContentType = "application/x-www-form-urlencoded";
11 
12             //設置參數,並進行URL編碼  
13             //雖然我們需要傳遞給服務器端的實際參數是JsonParas(格式:[{\"UserID\":\"0206001\",\"UserName\":\"ceshi\"}]),
14             //但是需要將該字符串參數構造成鍵值對的形式(注:"paramaters=[{\"UserID\":\"0206001\",\"UserName\":\"ceshi\"}]"),
15             //其中鍵paramaters為WebService接口函數的參數名,值為經過序列化的Json數據字符串
16             //最后將字符串參數進行Url編碼
17             string paraUrlCoded = System.Web.HttpUtility.UrlEncode("paramaters");
18             paraUrlCoded += "=" + System.Web.HttpUtility.UrlEncode(jsonParas);
19 
20             byte[] payload;
21             //將Json字符串轉化為字節  
22             payload = System.Text.Encoding.UTF8.GetBytes(paraUrlCoded);
23             //設置請求的ContentLength   
24             request.ContentLength = payload.Length;
25             //發送請求,獲得請求流  
26 
27             Stream writer;
28             try
29             {
30                 writer = request.GetRequestStream();//獲取用於寫入請求數據的Stream對象
31             }
32             catch (Exception)
33             {
34                 writer = null;
35                 Console.Write("連接服務器失敗!");
36             }
37             //將請求參數寫入流
38             writer.Write(payload, 0, payload.Length);
39             writer.Close();//關閉請求流
40 
41             String strValue = "";//strValue為http響應所返回的字符流
42             HttpWebResponse response;
43             try
44             {
45                 //獲得響應流
46                 response = (HttpWebResponse)request.GetResponse();
47             }
48             catch (WebException ex)
49             {
50                 response = ex.Response as HttpWebResponse;
51             }
52 
53             Stream s = response.GetResponseStream();
54 
55             //服務器端返回的是一個XML格式的字符串,XML的Content才是我們所需要的Json數據
56             XmlTextReader Reader = new XmlTextReader(s);
57             Reader.MoveToContent();
58             strValue = Reader.ReadInnerXml();//取出Content中的Json數據
59             Reader.Close();
60             s.Close();
61 
62             return strValue;//返回Json數據
63         }

  Url的格式樣例:"http://59.68.29.106:8087/IFT_Project.asmx"

  methodName參數就是"Project"

  JsonParas就是使用C# JavaScriptSerializer將List<Object>類型的對象序列化之后得到的值,數據格式:[{\"UserID\":\"0206001\",\"UserName\":\"ceshi\"}],Json數據中的中括號代表由着多個對象集合序列化,花括號代表一個對象序列化得到的結果,花括號里面的內容使用鍵值對的方式展示,多個屬性之間用逗號隔開,每個對象也用逗號隔開。

  request.ContentType必須設置值,建議使用"application/x-www-form-urlencoded",設置其他值就很容易報服務器內部異常,使用這種方式服務接口方法返回的是xml格式的字符串

  payload將請求參數轉換成二進制來保存,此處一定要將“paramaters”加入其中,不然會報異常缺少參數,paramaters就是服務接口函數的參數名。函數中使用了URL編碼,注意在編碼的時候只需要將鍵和值進行編碼,不要將中間的=進行編碼,不然getResponse的時候會報異常。

  request.ContentLength也是必須設置的值

  在得到響應流之后Stream s = response.GetResponseStream();需要使用Reader來解析響應流,這個地方我使用的是XmlTextReader,因為我服務方法返回的是xml格式的字符串,其中Json數據在xml的Content中。在取出Json數據之后,再進行相應的反序列化即可得到對象。

 

小結

  在學習使用Post調用方式的過程中,查看了一些帖子,但是網上的帖子很少,不少帖子中也給出了一下Post方法的樣例,給出的很多post方法沒有明確給出傳入字符串的格式,導致我的傳入參數jsonParas缺少了鍵paramaters,測試調試了很久才發現這個錯誤,最終差點放棄了。還有ContentType的設置也很重要,使用其他的值對傳入參數的要求很高,初學者不建議使用其他方式。初期使用Post方式的時候,在getResponse()處容易報異常,可以設置customerErrors mode將異常信息返回給客戶端,這樣容易調試。


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM