WebAPI調用筆記

前言

即時通信項目中初次調用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的方法：

        [ScriptMethod(ResponseFormat = ResponseFormat.Json)]
        [WebMethod(Description = " 獲取篩選條件", EnableSession = true)]
        public void GetTestList(string Type,string UserID)
        {
            Context.Response.ContentType = "text/plain";
            Context.Response.Charset = "UTF-8";
            Context.Response.ContentEncoding = System.Text.Encoding.UTF8;
            Dictionary<string, object> dicReturn = new Dictionary<string, object>();
            Dictionary<string, object> dic = new Dictionary<string, object>();
            string jsonStr = string.Empty;//保存返回的json字符串
            try
            {
                  //將返回的結果放到dic中
                  //可以放到list里也可以放到DataTable中
                  List<SortModel> list = xxx.GetXXXXXList(parames1, parames2);
                 dic.Add("Count", xxx.GetXXXXXCount(parames1, parames2));
                 dic.Add("List", list);
                 //或者
                 DataTable dt = xxx.GetXXXXX(parames1, parames2);
                 dic.Add("Count", xxx.GetXXXXXCount(parames1, parames2);
                 dic.Add("List2", dt);
                 //獲取成功
                dicReturn.Add("State", "1");
                dicReturn.Add("ErrorMsg", "獲取成功");
                dicReturn.Add("Data", dic);
                dicReturn.Add("ErrCode", "0");
          }
          catch (Exception ex)
          {
               dicReturn.Add("State", "0");
               dicReturn.Add("ErrorMsg", ex.Message);
               dicReturn.Add("Data", "");
               dicReturn.Add("ErrCode", "1");
          }
          //序列化 json字符串
          jsonStr = JsonConvert.SerializeObject(dicReturn);
          Context.Response.Write(jsonStr);
          Context.Response.End();

}          

 附上post請求的方法：

/// <summary>
        /// 同步Post
        /// </summary>
        /// <param name="Url"></param>
        /// <param name="postDataStr"></param>
        /// <returns>返回json格式</returns>
        public static string HttpPost(string Url, IDictionary<string, string> Params)
        {
            HttpWebRequest request = (HttpWebRequest)WebRequest.Create(Url);
            request.Method = "POST";
            //request.ContentType = "application/x-www-form-urlencoded";
            request.ContentType = "application/json";
            request.CookieContainer = cookie;

            //發送POST數據  
            StringBuilder bufferParams = new StringBuilder();
            if (!(Params == null || Params.Count == 0))
            {
                int i = 0;
                foreach (string key in Params.Keys)
                {
                    if (i > 0)
                    {
                        bufferParams.AppendFormat("&{0}={1}", key, Params[key]);
                    }
                    else
                    {
                        bufferParams.AppendFormat("{0}={1}", key, Params[key]);
                        i++;
                    }
                }
            }
            request.ContentLength = Encoding.UTF8.GetByteCount(bufferParams.ToString());

            Stream myRequestStream = request.GetRequestStream();
            StreamWriter myStreamWriter = new StreamWriter(myRequestStream, Encoding.GetEncoding("gb2312"));
            myStreamWriter.Write(bufferParams);
            myStreamWriter.Close();

            HttpWebResponse response = (HttpWebResponse)request.GetResponse();

            response.Cookies = cookie.GetCookies(response.ResponseUri);
            Stream myResponseStream = response.GetResponseStream();
            StreamReader myStreamReader = new StreamReader(myResponseStream, Encoding.GetEncoding("utf-8"));
            string retString = myStreamReader.ReadToEnd();
            #region ContentType = "application/x-www-form-urlencoded"處理方式
            //服務器端返回的是一個XML格式的字符串，XML的Content才是我們所需要的數據
            //XmlTextReader Reader = new XmlTextReader(myResponseStream);
            //Reader.MoveToContent();
            //string retString = Reader.ReadInnerXml();//取出Content中的數據
            //Reader.Close();
            #endregion
            myStreamReader.Close();
            myResponseStream.Close();

            return retString;
        }

 

總結

對於WebAPI調用，在BS端中，實在是很小白的東西，但是再怎么小白，沒做過還是會花一些時間的。2019年，希望自己可以成長的更快，變得更優秀。