xml地图|网站地图|网站标签 [设为首页] [加入收藏]
WebRequest异步请求与WebClient异步请求,进阶系列
分类:编程

前言:还记得刚使用WebApi那会儿,被它的传参机制折腾了好久,查阅了半天资料。如今,使用WebApi也有段时间了,今天就记录下API接口传参的一些方式方法,算是一个笔记,也希望能帮初学者少走弯路。本篇针对初初使用WebApi的同学们,比较基础,有兴趣的且看看。

很多情况下一般会使用同步方式发出请求,直到响应后再做后续的逻辑处理等,但有时候后续的逻辑处理不依赖于请求的结果或者是可以挂起等到响应后再处理,又或者是为了解决UI“假死”的现象,这时可以使用异步请求

1.异常处理

WebApi系列文章

使用WebRequest实例中的BeginGetResponse方法异步获取响应结果,其中参数callback是委托类型,state是自定义的对象,state用于保存一些信息,在callback对应的方法中可能需要用到这些信息。

 1)异常处理概念

  • C#进阶系列——WebApi接口测试工具:WebApiTestClient
  • C#进阶系列——WebApi 跨域问题解决方案:CORS
  • C#进阶系列——WebApi身份认证解决方案:Basic基础认证
  • C#进阶系列——WebApi接口传参不再困惑:传参详解
  • C#进阶系列——WebApi接口返回值不困惑:返回值类型详解
  • C#进阶系列——WebApi异常处理解决方案
  • C#进阶系列——WebApi区域Area使用小结

下面用一个例子说明,假设需要请求url,该url对应是一张图片,异步获取后展示到PictureBox中(该例子基于winform的一个窗体中)

 2)异常处理用法

本篇打算通过get、post、put、delete四种请求方式分别谈谈基础类型(包括int/string/datetime等)、实体、数组等类型的参数如何传递。

winform中定义了存放数据的变量

2.Windows窗体

一、get请求

对于取数据,我们使用最多的应该就是get请求了吧。下面通过几个示例看看我们的get请求参数传递。

List<byte> lstBuffer = new List<byte>();
byte[] buffers = new byte[8];

 1)windows窗体概念

1、基础类型参数

[HttpGet]
public string GetAllChargingData(int id, string name)
{
    return "ChargingData" + id;
}

$.ajax({
        type: "get",
        url: "http://localhost:27221/api/Charging/GetAllChargingData",
        data: { id: 1, name: "Jim", bir: "1988-09-11"},
        success: function (data, status) {
            if (status == "success") {
                $("#div_test").html(data);
            }
        }
    });

参数截图效果

图片 1

 这是get请求最基础的参数传递方式,没什么特别好说的。

在具体需要请求服务器的地方创建WebRequest实例,并调用BeginGetResponse方法

 2)Windows窗体属性

2、实体作为参数

如果我们在get请求时想将实体对象做参数直接传递到后台,是否可行呢?我们来看看。

    public class TB_CHARGING
    {
        /// <summary>
        /// 主键Id
        /// </summary>
        public string ID { get; set; }

        /// <summary>
        /// 充电设备名称
        /// </summary>
        public string NAME { get; set; }

        /// <summary>
        /// 充电设备描述
        /// </summary>
        public string DES { get; set; }

        /// <summary>
        /// 创建时间
        /// </summary>
        public DateTime CREATETIME { get; set; }
    }

[HttpGet]
public string GetByModel(TB_CHARGING oData)
{
     return "ChargingData" + oData.ID;
}

  $.ajax({
        type: "get",
        url: "http://localhost:27221/api/Charging/GetByModel",
        contentType: "application/json",
        data: { ID: "1", NAME: "Jim", CREATETIME: "1988-09-11" },
        success: function (data, status) {
            if (status == "success") {
                $("#div_test").html(data);
            }
        }
    });

测试结果

图片 2

由上图可知,在get请求时,我们直接将json对象当做实体传递后台,后台是接收不到的。这是为什么呢?我们来看看对应的http请求

图片 3

原来,get请求的时候,默认是将参数全部放到了url里面直接以string的形式传递的,后台自然接不到了。

原因分析:还记得有面试题问过get和post请求的区别吗?其中有一个区别就是get请求的数据会附在URL之后(就是把数据放置在HTTP协议头中),而post请求则是放在http协议包的包体中。

根据园友们的提议,Get请求的时候可以在参数里面加上[FromUri]即可直接得到对象。还是贴上代码:

    var postdata = { ID: "1", NAME: "Jim", CREATETIME: "1988-09-11" };
    $.ajax({
        type: "get",
        url: "http://localhost:27221/api/Charging/GetAllChargingData",
        data: postdata,
        success: function (data, status) { }
    });

        [HttpGet]
        public string GetAllChargingData([FromUri]TB_CHARGING obj)
        {
            return "ChargingData" + obj.ID;
        }

得到结果:

图片 4

如果你不想使用[FromUri]这些在参数里面加特性的这种“怪异”写法,也可以采用先序列化,再在后台反序列的方式。

  $.ajax({
        type: "get",
        url: "http://localhost:27221/api/Charging/GetByModel",
        contentType: "application/json",
        data: { strQuery: JSON.stringify({ ID: "1", NAME: "Jim", CREATETIME: "1988-09-11" }) },
        success: function (data, status) {
            if (status == "success") {
                $("#div_test").html(data);
            }
        }
    });

        [HttpGet]
        public string GetByModel(string strQuery)
        {
            TB_CHARGING oData = Newtonsoft.Json.JsonConvert.DeserializeObject<TB_CHARGING>(strQuery);
            return "ChargingData" + oData.ID;
        }

图片 5

这样在后台得到我们序列化过的对象,再通过反序列化就能得到对象。

在url里面我们可以看到它自动给对象加了一个编码:

图片 6

至于还有园友们提到的model binder这种方式,博主看了下,觉得略复杂。有兴趣的也可以试试。至于用哪一种方式传递对象,园友们可以自行选择。

string url = "http://localhost/1.jpg";
var request = WebRequest.Create(url);
request.BeginGetResponse(RespCallBack, request);

RespCallBack方法如下,此处ar.AsyncState也就是上面调用BeginGetResponse方法中参数state对应的信息,也就是request

private void RespCallBack(IAsyncResult ar)
{
    var request = ar.AsyncState as WebRequest;
    var response = request?.EndGetResponse(ar);
    Stream responseStream = response?.GetResponseStream();
    responseStream?.BeginRead(buffers, 0, 8, ReadCallBack, responseStream);
}

 3)Windows窗体事件

3、数组作为参数

一般get请求不建议将数组作为参数,因为我们知道get请求传递参数的大小是有限制的,最大1024字节,数组里面内容较多时,将其作为参数传递可能会发生参数超限丢失的情况。

由于是异步,此处读数据也是异步读取,ReadCallBack如下:

 4)MDI窗体设置与用法

4、“怪异”的get请求

为什么会说get请求“怪异”呢?我们先来看看下面的两种写法对比。

private void ReadCallBack(IAsyncResult ar)
{
    using (var responseStream = ar.AsyncState as Stream)
    {
        if (responseStream == null) return;
        var read = responseStream.EndRead(ar);
        if (read > 0)
        {
            lstBuffer.AddRange(buffers);
            responseStream.BeginRead(buffers, 0, 8, ReadCallBack, responseStream);
        }
        else
        {
            lstBuffer.AddRange(buffers);
            Stream s = new MemoryStream(lstBuffer.ToArray());
            pictureBox1.Image = Image.FromStream(s);
            pictureBox1.SizeMode = PictureBoxSizeMode.Zoom;
            responseStream.Dispose();
        }
    }
}

 5)继承窗体

(1)WebApi的方法名称以get开头

    $.ajax({
        type: "get",
        url: "http://localhost:27221/api/Charging/GetByModel",
        contentType: "application/json",
        data: { strQuery: JSON.stringify({ ID: "1", NAME: "Jim", CREATETIME: "1988-09-11" }) },
        success: function (data, status) {
            if (status == "success") {
                $("#div_test").html(data);
            }
        }
    });

        [HttpGet]
        public string GetByModel(string strQuery)
        {
            TB_CHARGING oData = Newtonsoft.Json.JsonConvert.DeserializeObject<TB_CHARGING>(strQuery);
            return "ChargingData" + oData.ID;
        }

这是标准写法,后台加[HttpGet],参数正常得到:

图片 7

为了对比,我将[HttpGet]去掉,然后再调用

        //[HttpGet]
        public string GetByModel(string strQuery)
        {
            TB_CHARGING oData = Newtonsoft.Json.JsonConvert.DeserializeObject<TB_CHARGING>(strQuery);
            return "ChargingData" + oData.ID;
        }

图片 8

貌似没有任何问题!有人就想,那是否所有的get请求都可以省略掉[HttpGet]这个标注呢。我们试试便知。

每次读一定的字节,填充到指定的容器中(lstBuffer),当数据还没有读取完毕就一直调用responseStream.BeginRead(buffers, 0, 8, ReadCallBack, responseStream);

教学视频:百度网盘: 密码:72d2

(2)WebApi的方法名称不以get开头

我们把之前的方法名由GetByModel改成FindByModel,这个再正常不过了,很多人查询就不想用Get开头,还有直接用Query开头的。这个有什么关系吗?有没有关系,我们以事实说话。

    $.ajax({
        type: "get",
        url: "http://localhost:27221/api/Charging/FindByModel",
        contentType: "application/json",
        data: { strQuery: JSON.stringify({ ID: "1", NAME: "Jim", CREATETIME: "1988-09-11" }) },
        success: function (data, status) {
            if (status == "success") {
                $("#div_test").html(data);
            }
        }
    });

        [HttpGet]
        public string FindByModel(string strQuery)
        {
            TB_CHARGING oData = Newtonsoft.Json.JsonConvert.DeserializeObject<TB_CHARGING>(strQuery);
            return "ChargingData" + oData.ID;
        }

图片 9

貌似又可行,没有任何问题啊。根据上面的推论,我们去掉[HttpGet]也是可行的,好,我们注释掉[HttpGet],运行起来试试。

图片 10

结果是不进断点,有些人不信,我们在浏览器里面看看http请求:

图片 11

呵呵,这就奇怪了,就改了个方法名,至于这样么?还真至于!

博主的理解是:方法名以Get开头,WebApi会自动默认这个请求就是get请求,而如果你以其他名称开头而又不标注方法的请求方式,那么这个时候服务器虽然找到了这个方法,但是由于请求方式不确定,所以直接返回给你405——方法不被允许的错误。

最后结论:所有的WebApi方法最好是加上请求的方式([HttpGet]/[HttpPost]/[HttpPut]/[HttpDelete]),不要偷懒,这样既能防止类似的错误,也有利于方法的维护,别人一看就知道这个方法是什么请求。

这也就是为什么很多人在园子里面问道为什么方法名不加[HttpGet]就调用不到的原因!

当读取完毕后,将读取的数据(lstBuffer)转换成图片,赋值给pictureBox。

随手笔记:百度网盘: 密码:7ttc

本文由澳门新葡亰手机版发布于编程,转载请注明出处:WebRequest异步请求与WebClient异步请求,进阶系列

上一篇:没有了 下一篇:编码问题,python中类属性和数据属性的解释
猜你喜欢
热门排行
精彩图文