前言
即时通信项目中初次调用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的方法:
![](https://i-blog.csdnimg.cn/blog_migrate/8f900a89c6347c561fdf2122f13be562.gif)
![](https://i-blog.csdnimg.cn/blog_migrate/961ddebeb323a10fe0623af514929fc1.gif)
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 }
附上post请求的方法:
![](https://i-blog.csdnimg.cn/blog_migrate/8f900a89c6347c561fdf2122f13be562.gif)
![](https://i-blog.csdnimg.cn/blog_migrate/961ddebeb323a10fe0623af514929fc1.gif)
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 }
总结
对于WebAPI调用,在BS端中,实在是很小白的东西,但是再怎么小白,没做过还是会花一些时间的。2019年,希望自己可以成长的更快,变得更优秀。