本筆記中附有Post請求方法,調用WebAPI,反序列化成json格式後,如果json字元串中包含有d,取出d中的對象json字元串的方法。 ...
前言
即時通信項目中初次調用OA介面遇到了一些問題,因為本人從業後幾乎一直做CS端項目,一個簡單的WebAPI調用居然浪費了不少時間,特此記錄。
介面描述
首先說明一下,基於Http協議的Get、Post請求,網上有很多例子,其實方法都是一樣的,這塊沒什麼好說的,我也測試過我的代碼,正常的調用是沒問題的。問題不是在請求方法上,而是在如何取出數據上。
因為對應我需求介面的開發是個實習生,對於如何提供介面,他並不熟悉,其中我還幫了一些忙,但我畢竟不是很熟BS端那塊,糾結了1天多才調通介面。
描述一下需求介面:
OA方需要提供頭像下載的介面供即時通信初次登陸時下載頭像。
思路如下:
1.介面內將OA頭像文件夾打包壓縮成zip文件
2.將zip文件,轉成位元組流byte[]
3.將位元組流byte[]序列化成json格式 返回
問題
思路1、2他按照我的要求做了,我測試介面後遇到的問題是取出的byte[]順序不對,我本地反序列化後轉成zip文件沒法解壓,多次測試後我又讓他按照思路3來做。
測試介面,遇到了個問題,我反序列化出來的json字元串,包含了d,如下:
解決
因為不熟悉這塊,我不知道如何取出d中的數據,上網查也不好查,因為幾乎沒有問這塊的,後來我問OA做手機端的同事,才知道他們提供的介面方法都是void,不在返回值的,都是通過http的Context.Response返回的,在調用的時候不會出現這個d字元。然而他也不知道如何取出d中的數據,沒辦法只能在網上再找,後來在一篇CSDN的博客中的評論里找到了辦法,將json轉換成hash表的格式,然後直接取出來d的數據,然後反序列化json成對象,如下:
string headjson = WebAPIHelper.HttpPost(OAAddress, null); JavaScriptSerializer json = new JavaScriptSerializer(); Hashtable table = (Hashtable)json.Deserialize(headjson, typeof(Hashtable)); string d = table["d"].ToString();//取出d中的數據 HeadByte h1 = JsonConvert.DeserializeObject<HeadByte>(d);
到此為止,問題終於解決。
拓展
因為比較在意普通的介面是如何提供返回結果的,我特意看一下OA中的WebAPI方法,同事說過,不帶d的方法無需返回值,使用void即可,請求返回的結果都在Response中,json字元串出現d的原因是方法的返回值是string類型,特附上不需要另外取json中d的方法:
1 [ScriptMethod(ResponseFormat = ResponseFormat.Json)] 2 [WebMethod(Description = " 獲取篩選條件", EnableSession = true)] 3 public void GetTestList(string Type,string UserID) 4 { 5 Context.Response.ContentType = "text/plain"; 6 Context.Response.Charset = "UTF-8"; 7 Context.Response.ContentEncoding = System.Text.Encoding.UTF8; 8 Dictionary<string, object> dicReturn = new Dictionary<string, object>(); 9 Dictionary<string, object> dic = new Dictionary<string, object>(); 10 string jsonStr = string.Empty;//保存返回的json字元串 11 try 12 { 13 //將返回的結果放到dic中 14 //可以放到list里也可以放到DataTable中 15 List<SortModel> list = xxx.GetXXXXXList(parames1, parames2); 16 dic.Add("Count", xxx.GetXXXXXCount(parames1, parames2)); 17 dic.Add("List", list); 18 //或者 19 DataTable dt = xxx.GetXXXXX(parames1, parames2); 20 dic.Add("Count", xxx.GetXXXXXCount(parames1, parames2); 21 dic.Add("List2", dt); 22 //獲取成功 23 dicReturn.Add("State", "1"); 24 dicReturn.Add("ErrorMsg", "獲取成功"); 25 dicReturn.Add("Data", dic); 26 dicReturn.Add("ErrCode", "0"); 27 } 28 catch (Exception ex) 29 { 30 dicReturn.Add("State", "0"); 31 dicReturn.Add("ErrorMsg", ex.Message); 32 dicReturn.Add("Data", ""); 33 dicReturn.Add("ErrCode", "1"); 34 } 35 //序列化 json字元串 36 jsonStr = JsonConvert.SerializeObject(dicReturn); 37 Context.Response.Write(jsonStr); 38 Context.Response.End(); 39 40 }View Code
附上post請求的方法:
1 /// <summary> 2 /// 同步Post 3 /// </summary> 4 /// <param name="Url"></param> 5 /// <param name="postDataStr"></param> 6 /// <returns>返回json格式</returns> 7 public static string HttpPost(string Url, IDictionary<string, string> Params) 8 { 9 HttpWebRequest request = (HttpWebRequest)WebRequest.Create(Url); 10 request.Method = "POST"; 11 //request.ContentType = "application/x-www-form-urlencoded"; 12 request.ContentType = "application/json"; 13 request.CookieContainer = cookie; 14 15 //發送POST數據 16 StringBuilder bufferParams = new StringBuilder(); 17 if (!(Params == null || Params.Count == 0)) 18 { 19 int i = 0; 20 foreach (string key in Params.Keys) 21 { 22 if (i > 0) 23 { 24 bufferParams.AppendFormat("&{0}={1}", key, Params[key]); 25 } 26 else 27 { 28 bufferParams.AppendFormat("{0}={1}", key, Params[key]); 29 i++; 30 } 31 } 32 } 33 request.ContentLength = Encoding.UTF8.GetByteCount(bufferParams.ToString()); 34 35 Stream myRequestStream = request.GetRequestStream(); 36 StreamWriter myStreamWriter = new StreamWriter(myRequestStream, Encoding.GetEncoding("gb2312")); 37 myStreamWriter.Write(bufferParams); 38 myStreamWriter.Close(); 39 40 HttpWebResponse response = (HttpWebResponse)request.GetResponse(); 41 42 response.Cookies = cookie.GetCookies(response.ResponseUri); 43 Stream myResponseStream = response.GetResponseStream(); 44 StreamReader myStreamReader = new StreamReader(myResponseStream, Encoding.GetEncoding("utf-8")); 45 string retString = myStreamReader.ReadToEnd(); 46 #region ContentType = "application/x-www-form-urlencoded"處理方式 47 //伺服器端返回的是一個XML格式的字元串,XML的Content才是我們所需要的數據 48 //XmlTextReader Reader = new XmlTextReader(myResponseStream); 49 //Reader.MoveToContent(); 50 //string retString = Reader.ReadInnerXml();//取出Content中的數據 51 //Reader.Close(); 52 #endregion 53 myStreamReader.Close(); 54 myResponseStream.Close(); 55 56 return retString; 57 }View Code
總結
對於WebAPI調用,在BS端中,實在是很小白的東西,但是再怎麼小白,沒做過還是會花一些時間的。2019年,希望自己可以成長的更快,變得更優秀。