思享工具箱

C# WebApi 接口传参详解

摘要：
1234567891011$. ajax测试结果可以从上图中看到。当我们发出get请求时，我们直接将json对象作为实体传递给后台。后台无法接收它。123456[HttpGet]publicstringGetByModel｛TB_CHARGINGoData=Newtonsoft.Json.JsonConvert.DeserializeObject＜TB_CHARING˃；return“ChargingData”+oData.ID；｝通过这种方式，我们可以在后台获得序列化的对象，然后通过反序列化获得该对象。WebApi的方法名以get？开头？

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

一、get请求

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

1、基础类型参数

1
2
3
4
5
[HttpGet]
publicstringGetAllChargingData(intid, stringname)
{
  return"ChargingData"+ id;
}
1
2
3
4
5
6
7
8
9
10
$.ajax({
    type: "get",
    data: { id: 1, name: "Jim", bir: "1988-09-11"},
    success: function(data, status) {
      if(status == "success") {
        $("#div_test").html(data);
      }
    }
  });

参数截图效果

C# WebApi 接口传参详解第1张

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

2、实体作为参数

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
publicclassTB_CHARGING
  {
    /// <summary>
    /// 主键Id
    /// </summary>
    publicstringID { get; set; }
 
    /// <summary>
    /// 充电设备名称
    /// </summary>
    publicstringNAME { get; set; }
 
    /// <summary>
    /// 充电设备描述
    /// </summary>
    publicstringDES { get; set; }
 
    /// <summary>
    /// 创建时间
    /// </summary>
    publicDateTime CREATETIME { get; set; }
  }
1
2
3
4
5
[HttpGet]
publicstringGetByModel(TB_CHARGING oData)
{
   return"ChargingData"+ oData.ID;
}
1
2
3
4
5
6
7
8
9
10
11
$.ajax({
    type: "get",
    contentType: "application/json",
    data: { ID: "1", NAME: "Jim", CREATETIME: "1988-09-11"},
    success: function(data, status) {
      if(status == "success") {
        $("#div_test").html(data);
      }
    }
  });

测试结果

C# WebApi 接口传参详解第2张

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

C# WebApi 接口传参详解第3张

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

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

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

1
2
3
4
5
6
7
varpostdata = { ID: "1", NAME: "Jim", CREATETIME: "1988-09-11"};
  $.ajax({
    type: "get",
    data: postdata,
    success: function(data, status) { }
  });
1
2
3
4
5
[HttpGet]
publicstringGetAllChargingData([FromUri]TB_CHARGING obj)
{
  return"ChargingData"+ obj.ID;
}

得到结果：

C# WebApi 接口传参详解第4张

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

1
2
3
4
5
6
7
8
9
10
11
$.ajax({
    type: "get",
    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);
      }
    }
  });
1
2
3
4
5
6
[HttpGet]
    publicstringGetByModel(stringstrQuery)
    {
      TB_CHARGING oData = Newtonsoft.Json.JsonConvert.DeserializeObject<TB_CHARGING>(strQuery);
      return"ChargingData"+ oData.ID;
    }

C# WebApi 接口传参详解第5张

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

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

C# WebApi 接口传参详解第6张

至于还有园友们提到http://www.asp.net/web-api/overview/formats-and-model-binding/parameter-binding-in-aspnet-web-api的model binder这种方式，博主看了下，觉得略复杂。有兴趣的也可以试试。至于用哪一种方式传递对象，园友们可以自行选择。

3、数组作为参数

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

4、“怪异”的get请求

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

（1）WebApi的方法名称以get开头

1
2
3
4
5
6
7
8
9
10
11
$.ajax({
    type: "get",
    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);
      }
    }
  });
1
2
3
4
5
6
[HttpGet]
    publicstringGetByModel(stringstrQuery)
    {
      TB_CHARGING oData = Newtonsoft.Json.JsonConvert.DeserializeObject<TB_CHARGING>(strQuery);
      return"ChargingData"+ oData.ID;
    }

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

C# WebApi 接口传参详解第7张

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

1
2
3
4
5
6
//[HttpGet]
    publicstringGetByModel(stringstrQuery)
    {
      TB_CHARGING oData = Newtonsoft.Json.JsonConvert.DeserializeObject<TB_CHARGING>(strQuery);
      return"ChargingData"+ oData.ID;
    }

C# WebApi 接口传参详解第8张

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

（2）WebApi的方法名称不以get开头

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

1
2
3
4
5
6
7
8
9
10
11
$.ajax({
    type: "get",
    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);
      }
    }
  });
1
2
3
4
5
6
[HttpGet]
    publicstringFindByModel(stringstrQuery)
    {
      TB_CHARGING oData = Newtonsoft.Json.JsonConvert.DeserializeObject<TB_CHARGING>(strQuery);
      return"ChargingData"+ oData.ID;
    }

C# WebApi 接口传参详解第9张

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

C# WebApi 接口传参详解第10张

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

C# WebApi 接口传参详解第11张

呵呵，这就奇怪了，就改了个方法名，至于这样么？还真至于！

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

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

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

二、post请求

在WebApi的RESETful风格里面，API服务的增删改查，分别对应着http的post/delete/put/get请求。我们下面就来说说post请求参数的传递方式。

1、基础类型参数

post请求的基础类型的参数和get请求有点不一样，我们知道get请求的参数是通过url来传递的，而post请求则是通过http的请求体中传过来的，WebApi的post请求也需要从http的请求体里面去取参数。

（1）错误的写法

1
2
3
4
5
6
7
8
9
10
$.ajax({
    type: "post",
    data: { NAME: "Jim"},
    success: function(data, status) {
      if(status == "success") {
        $("#div_test").html(data);
      }
    }
  });
1
2
3
4
5
[HttpPost]
publicboolSaveData(stringNAME)
{
  returntrue;
}

这是一种看上去非常正确的写法，可是实际情况是：

C# WebApi 接口传参详解第12张

（2）正确的用法

1
2
3
4
5
6
$.ajax({
    type: "post",
    data: { "": "Jim"},
    success: function(data, status) {}
  });
1
2
3
4
5
[HttpPost]
   publicboolSaveData([FromBody]stringNAME)
   {
     returntrue;
   }

这是一种另许多人头痛的写法，但是没办法，这样确实能得到我们的结果：

C# WebApi 接口传参详解第13张

我们一般的通过url取参数的机制是键值对，即某一个key等于某一个value，而这里的FromBody和我们一般通过url取参数的机制则不同，它的机制是=value，没有key的概念，并且如果你写了key(比如你的ajax参数写的{NAME:"Jim"})，后台反而得到的NAME等于null。不信你可以试试。

上面讲的都是传递一个基础类型参数的情况，那么如果我们需要传递多个基础类型呢？按照上面的推论，是否可以([FromBody]string NAME, [FromBody]string DES)这样写呢。试试便知。

（1）错误写法

1
2
3
4
5
6
$.ajax({
    type: "post",
    data: { "": "Jim","":"备注"},
    success: function(data, status) {}
  });
1
2
3
4
5
[HttpPost]
   publicboolSaveData([FromBody]stringNAME, [FromBody] stringDES)
   {
     returntrue;
   }

得到结果

C# WebApi 接口传参详解第14张

C# WebApi 接口传参详解第15张

这说明我们没办法通过多个[FromBody]里面取值，此法失败。

（2）正确用法

既然上面的办法行不通，那我们如何传递多个基础类型的数据呢？很多的解决办法是新建一个类去包含传递的参数，博主觉得这样不够灵活，因为如果我们前后台每次传递多个参数的post请求都去新建一个类的话，我们系统到时候会有多少个这种参数类？维护起来那是相当的麻烦的一件事！所以博主觉得使用dynamic是一个很不错的选择。我们来试试。

1
2
3
4
5
6
7
$.ajax({
    type: "post",
    contentType: 'application/json',
    data: JSON.stringify({ NAME: "Jim",DES:"备注"}),
    success: function(data, status) {}
  });
1
2
3
4
5
6
[HttpPost]
    publicobjectSaveData(dynamic obj)
    {
      var strName = Convert.ToString(obj.NAME);
      returnstrName;
    }

C# WebApi 接口传参详解第16张

通过dynamic动态类型能顺利得到多个参数，省掉了[FromBody]这个累赘，并且ajax参数的传递不用使用"无厘头"的{"":"value"}这种写法，有没有一种小清新的感觉~~有一点需要注意的是这里在ajax的请求里面需要加上参数类型为Json，即contentType: 'application/json',这个属性。

（3）推荐用法

通过上文post请求基础类型参数的传递，我们了解到了dynamic的方便之处，为了避免[FromBody]这个累赘和{"":"value"}这种"无厘头"的写法。博主推荐所有基础类型使用dynamic来传递，方便解决了基础类型一个或多个参数的传递，示例如上文。如果园友们有更好的办法，欢迎讨论。

2、实体作为参数

（1）单个实体作为参数

上面我们通过dynamic类型解决了post请求基础类型数据的传递问题，那么当我们需要传递一个实体作为参数该怎么解决呢？我们来看下面的代码便知：

1
2
3
4
5
6
$.ajax({
    type: "post",
    data: { ID: "1", NAME: "Jim", CREATETIME: "1988-09-11"},
    success: function(data, status) {}
  });
1
2
3
4
5
[HttpPost]
    publicboolSaveData(TB_CHARGING oData)
    {
      returntrue;
    }

得到结果

C# WebApi 接口传参详解第17张

原理解释：使用实体作为参数的时候，前端直接传递普通json，后台直接使用对应的类型去接收即可，不用FromBody。但是这里需要注意的一点就是，这里不能指定contentType为appplication/json，否则，参数无法传递到后台。我们来看看它默认的contentType是什么：

C# WebApi 接口传参详解第18张

为了弄清楚原因，博主查了下http的Content-Type的类型。看到如下说明：

  • application/x-www-form-urlencoded ： <form encType=””>中默认的encType，form表单数据被编码为key/value格式发送到服务器（表单默认的提交数据的格式）；
  • application/json ： JSON数据格式

也就是说post请求默认是将表单里面的数据的key/value形式发送到服务，而我们的服务器只需要有对应的key/value属性值的对象就可以接收到。而如果使用application/json，则表示将前端的数据以序列化过的json传递到后端，后端要把它变成实体对象，还需要一个反序列化的过程。按照这个逻辑，那我们如果指定contentType为application/json，然后传递序列化过的对象应该也是可以的啊。博主好奇心重，还是打算一试到底，于是就有了下面的代码：

1
2
3
4
5
6
7
8
varpostdata = { ID: "1", NAME: "Jim", CREATETIME: "1988-09-11"};
  $.ajax({
    type: "post",
    contentType: 'application/json',
    data: JSON.stringify(postdata),
    success: function(data, status) {}
  });
1
2
3
4
5
[HttpPost]
   publicboolSaveData(TB_CHARGING lstCharging)
   {
     returntrue;
   }

得到结果：

C# WebApi 接口传参详解第19张

尝试成功，也就是说，两种写法都是可行的。如果你指定了contentType为application/json，则必须要传递序列化过的对象；如果使用post请求的默认参数类型，则前端直接传递json类型的对象即可。

（2）实体和基础类型一起作为参数传递

有些时候，我们需要将基础类型和实体一起传递到后台，这个时候，我们神奇的dynamic又派上用场了。

1
2
3
4
5
6
7
8
varpostdata = { ID: "1", NAME: "Jim", CREATETIME: "1988-09-11"};
  $.ajax({
    type: "post",
    contentType: 'application/json',
    data: JSON.stringify({ NAME:"Lilei", Charging:postdata }),
    success: function(data, status) {}
  });
1
2
3
4
5
6
7
[HttpPost]
    publicobjectSaveData(dynamic obj)
    {
      var strName = Convert.ToString(obj.NAME);
      var oCharging = Newtonsoft.Json.JsonConvert.DeserializeObject<TB_CHARGING>(Convert.ToString(obj.Charging));
      returnstrName;
    }

得到结果：

C# WebApi 接口传参详解第20张

原理也不用多说，同上。

3、数组作为参数

（1）基础类型数组

1
2
3
4
5
6
7
8
vararr = ["1", "2", "3", "4"];
  $.ajax({
    type: "post",
    contentType: 'application/json',
    data: JSON.stringify(arr),
    success: function(data, status) { }
  });
1
2
3
4
5
[HttpPost]
   publicboolSaveData(string[] ids)
   {
     returntrue;
   }

得到结果：

C# WebApi 接口传参详解第21张

（2）实体集合

1
2
3
4
5
6
7
8
9
10
11
12
vararr = [
    { ID: "1", NAME: "Jim", CREATETIME: "1988-09-11"},
    { ID: "2", NAME: "Lilei", CREATETIME: "1990-12-11"},
    { ID: "3", NAME: "Lucy", CREATETIME: "1986-01-10"}
  ];
  $.ajax({
    type: "post",
    contentType: 'application/json',
    data: JSON.stringify(arr),
    success: function(data, status) {}
  });
1
2
3
4
5
[HttpPost]
    publicboolSaveData(List<TB_CHARGING> lstCharging)
    {
      returntrue;
    }

得到结果：

C# WebApi 接口传参详解第22张

4、后台发送请求参数的传递

上面写了那么多，都是通过前端的ajax请求去做的，我们知道，如果调用方不是web项目，比如Android客户端，可能需要从后台发送http请求来调用我们的接口方法，如果我们通过后台去发送请求是否也是可行的呢？我们以实体对象作为参数来传递写写代码试一把。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
publicvoidTestReques()
　　　　{
  　　　　 //请求路径
 
      //定义request并设置request的路径
      WebRequest request = WebRequest.Create(url);
      request.Method = "post";
 
      //初始化request参数
      stringpostData = "{ ID: "1", NAME: "Jim", CREATETIME: "1988-09-11" }";
 
      //设置参数的编码格式，解决中文乱码
      byte[] byteArray = Encoding.UTF8.GetBytes(postData);
 
      //设置request的MIME类型及内容长度
      request.ContentType = "application/json";
      request.ContentLength = byteArray.Length;
 
      //打开request字符流
      Stream dataStream = request.GetRequestStream();
      dataStream.Write(byteArray, 0, byteArray.Length);
      dataStream.Close();
 
      //定义response为前面的request响应
      WebResponse response = request.GetResponse();
 
      //获取相应的状态代码
      Console.WriteLine(((HttpWebResponse)response).StatusDescription);
 
      //定义response字符流
      dataStream = response.GetResponseStream();
      StreamReader reader = newStreamReader(dataStream);
      stringresponseFromServer = reader.ReadToEnd();//读取所有
      Console.WriteLine(responseFromServer);
　　　　}

当代码运行到request.GetResponse()这一句的时候，API里面进入断点

C# WebApi 接口传参详解第23张

尝试成功。

三、put请求

WebApi里面put请求一般用于对象的更新。它和用法和post请求基本相同。同样支持[FromBody]，同样可以使用dynamic。

1、基础类型参数

1
2
3
4
5
6
7
$.ajax({
    type: "put",
    contentType: 'application/json',
    data: JSON.stringify({ ID: "1"}),
    success: function(data, status) {}
  });
1
2
3
4
5
[HttpPut]
   publicboolUpdate(dynamic obj )
   {
     returntrue;
   }

C# WebApi 接口传参详解第24张

2、实体作为参数

和post请求相同。

3、数组作为参数

和post请求相同。

四、delete请求

顾名思义，delete请求肯定是用于删除操作的。参数传递机制和post也是基本相同。下面简单给出一个例子，其他情况参考post请求。

1
2
3
4
5
6
7
8
9
10
11
12
vararr = [
    { ID: "1", NAME: "Jim", CREATETIME: "1988-09-11"},
    { ID: "2", NAME: "Lilei", CREATETIME: "1990-12-11"},
    { ID: "3", NAME: "Lucy", CREATETIME: "1986-01-10"}
  ];
  $.ajax({
    type: "delete",
    contentType: 'application/json',
    data: JSON.stringify(arr),
    success: function(data, status) {}
  });
1
2
3
4
5
[HttpDelete]
   publicboolOptDelete(List<TB_CHARGING> lstChargin)
   {
     returntrue;
   }

C# WebApi 接口传参详解第25张

五、总结

以上比较详细的总结了WebApi各种请求的各种参数传递。每种情况都是博主实际代码测试过的，内容不难，但如果刚接触这么些东西还是需要一点时间去熟悉的，在此做个总结，希望能帮到刚刚接触WebApi的园友们。如果本文能帮到你，不妨推荐下，您的推荐是博主继续总结的动力！

标签：#post#string#delete#webapi | 浏览：1195 | 发布日期：

免责声明：文章转载自《C# WebApi 接口传参详解》仅用于学习参考。如对内容有疑问，请及时联系本站处理。

上篇Sublime报错Python——彩图变线稿下篇

宿迁高防，2C2G15M，22元/月；香港BGP，2C5G5M，25元/月 雨云优惠码：MjYwNzM=

相关文章

Java实现加密和解密的源代码

本文转载于网络，抄录下来只是为了方便以后查找。原文地址：http://snowolf.iteye.com/blog/379860 加密解密，曾经是我一个毕业设计的重要组件。在工作了多年以后回想当时那个加密、解密算法，实在是太单纯了。言归正传，这里我们主要描述Java已经实现的一些加密解密算法，最后介绍数字证书。如基本的单向加密算法： BASE64 严格...

字符串包括

字符串包括 题目：如果这有一个各种字母组成的字符串A，和另外一个字符串B，字符串里B的字母数相对少一些。什么方法能最快的查出全部小字符串B 里的字母在大字符串A里都有？ <<<<<<<<<<<<<<<<<<<<<<&l...

ElasticSearch（八）：springboot集成ElasticSearch集群并使用

1. 集群的搭建 见：ElasticSearch（七） 2. springboot配置集群 2.1 创建springboot项目，使用idea创建，不过多介绍（创建项目时候建议不要勾选elasticsearch，springboot目前自带的elasticsearch版本为5.6.10，如果你版本高于这个版本，还是自己手动导入。） 2.2 导入依赖...

攻防世界 — Web进阶题(第11

https://knlvre.github.io/ PHP2 进入题目后只有一句话： Can you anthenticate to this website? ，没有其他东西，扫描目录页无果。尝试在index.phps，得到源码 但是显然代码并不完整，右键查看源代码，得到如下 <?php if("admin"===$_GET[id]) {...

用Javascript进行HTML转义（分享）

  众所周知页面上的字符内容通常都需要进行HTML转义才能正确显示，尤其对于Input，Textarea提交的内容，更是要进行转义以防止javascript注入攻击。   通常的HTML转义主要是针对内容中的"<"，">"，"&"，以及空格、单双引号等。但其实还有很多字符也需要进行转义。具体的可以参考这篇文章。   ** 1、HTML转...

java socket 实现多个一对一聊天

此程序能够实现同一网络下多个一对一聊天，必须服务器先启动 ，然后客户端启动并且服务器ip要填正确，并且每个客户端的自身编号必须唯一。 服务器端： packagecn.com.test09; importjava.io.DataInputStream; importjava.io.DataOutputStream; importjava.io.IOExce...

最新文章

随机推荐

思享工具箱导航