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的方法：

 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年，希望自己可以成长的更快，变得更优秀。