一切福田，不離方寸，從心而覓，感無不通。

Daily Archives: 2017年10月15日

C#进阶系列——WebApi 接口参数不再困惑：传参详解

阅读目录 一、get请求 1、基础类型参数 2、实体作为参数 3、数组作为参数 4、“怪异”的get请求 二、post请求 1、基础类型参数 2、实体作为参数 3、数组作为参数 4、后台发送请求参数的传递 三、put请求 1、基础类型参数 2、实体作为参数 3、数组作为参数 四、delete请求 五、总结   正文 前言：还记得刚使用WebApi那会儿，被它的传参机制折腾了好久，查阅了半天资料。如今，使用WebApi也有段时间了，今天就记录下API接口传参的一些方式方法，算是一个笔记，也希望能帮初学者少走弯路。本篇针对初初使用WebApi的同学们，比较基础，有兴趣的且看看。 WebApi系列文章 C#进阶系列——WebApi接口测试工具：WebApiTestClient C#进阶系列——WebApi 跨域问题解决方案：CORS C#进阶系列——WebApi身份认证解决方案：Basic基础认证 C#进阶系列——WebApi接口传参不再困惑：传参详解 C#进阶系列——WebApi接口返回值不困惑：返回值类型详解 C#进阶系列——WebApi异常处理解决方案 C#进阶系列——WebApi区域Area使用小结 本篇打算通过get、post、put、delete四种请求方式分别谈谈基础类型（包括int/string/datetime等）、实体、数组等类型的参数如何传递。 一、get请求 对于取数据，我们使用最多的应该就是get请求了吧。下面通过几个示例看看我们的get请求参数传递。 1、基础类型参数

1
2
3
4
5
[HttpGet]
public string GetAllChargingData(int id, string name)
{
    return "ChargingData" + id;
}

1
2
3
4
5
6
7
8
9
10
$.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);
            }
        }
    });

参数截图效果 这是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
    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; }
    }

1
2
3
4
5
[HttpGet]
public string GetByModel(TB_CHARGING oData)
{
     return "ChargingData" + oData.ID;
}

1
2
3
4
5
6
7
8
9
10
11
　　$.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);
            }
        }
    });

测试结果 由上图可知，在get请求时，我们直接将json对象当做实体传递后台，后台是接收不到的。这是为什么呢？我们来看看对应的http请求 原来，get请求的时候，默认是将参数全部放到了url里面直接以string的形式传递的，后台自然接不到了。 原因分析：还记得有面试题问过get和post请求的区别吗？其中有一个区别就是get请求的数据会附在URL之后（就是把数据放置在HTTP协议头中），而post请求则是放在http协议包的包体中。 根据园友们的提议，Get请求的时候可以在参数里面加上[FromUri]即可直接得到对象。还是贴上代码：

1
2
3
4
5
6
7
    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) { }
    });

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

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

1
2
3
4
5
6
7
8
9
10
11
　　$.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);
            }
        }
    });

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

这样在后台得到我们序列化过的对象，再通过反序列化就能得到对象。 在url里面我们可以看到它自动给对象加了一个编码： 至于还有园友们提到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",
        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);
            }
        }
    });

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

这是标准写法，后台加[HttpGet]，参数正常得到： 为了对比，我将[HttpGet]去掉，然后再调用

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

貌似没有任何问题！有人就想，那是否所有的get请求都可以省略掉[HttpGet]这个标注呢。我们试试便知。 （2）WebApi的方法名称不以get开头 我们把之前的方法名由GetByModel改成FindByModel，这个再正常不过了，很多人查询就不想用Get开头，还有直接用Query开头的。这个有什么关系吗？有没有关系，我们以事实说话。

1
2
3
4
5
6
7
8
9
10
11
    $.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);
            }
        }
    });

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

貌似又可行，没有任何问题啊。根据上面的推论，我们去掉[HttpGet]也是可行的，好，我们注释掉[HttpGet]，运行起来试试。 结果是不进断点，有些人不信，我们在浏览器里面看看http请求： 呵呵，这就奇怪了，就改了个方法名，至于这样么？还真至于！ 博主的理解是：方法名以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",
        url: "http://localhost:27221/api/Charging/SaveData",
        data: { NAME: "Jim" },
        success: function (data, status) {
            if (status == "success") {
                $("#div_test").html(data);
            }
        }
    });

1
2
3
4
5
        [HttpPost]
        public bool SaveData(string NAME)
        {
            return true;
        }

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

1
2
3
4
5
6
    $.ajax({
        type: "post",
        url: "http://localhost:27221/api/Charging/SaveData",
        data: { "": "Jim" },
        success: function (data, status) {}
    });

[…]

龙生   15 Oct 2017
View Details

ASP.NET WebApi 路由配置

一、路由介绍 ASP.NET Web API路由是整个API的入口。我们访问某个资源就是通过路由映射找到对应资源的URL。通过URL来获取资源的。 对于ASP.NET Web API内部实现来讲，我们的请求最终将定位到一个具体的Action上。所以说，ASP.NET Web API路由就是把客户端请求映射到对应的Action上的过程。   二、两种路由模式 2.1 模板路由 模板路由是ASP.NET Web API默认提供的路由。下面我们就简单讲解此中路由的用法。 默认模板路由 模板路由使用前需要定义路由模板。如下面默认的路由模板：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web.Http;
 
namespace Supernova.Webapi
{
    public static class WebApiConfig
    {
        public static void Register(HttpConfiguration config)
        {
            // Web API 配置和服务
 
            // Web API 路由
            config.MapHttpAttributeRoutes();
 
            config.Routes.MapHttpRoute(
                name: "DefaultApi",
                routeTemplate: "api/{controller}/{id}",
                defaults: new { id = RouteParameter.Optional }
            );
        }
    }
}

此模板路由是新建项目默认生成的，在App_Start文件夹下。 我们可以看到此模板的URL格式是api/{controller}/{id}。api代表在资源前面要带上api目录，controller代表请求资源的控制器名称。id代表一条资源的id，id 是可选的。这种默认的模板是不带action的，所以它是以请求方式来区分资源的，我们必须在action上添加请求方式特性加以区分。 1.我们添加一个测试控制器api。  

1
2
3
4
5
6
7
    public class TestController : ApiController
    {
        public object Get1()
        {
            return "d1";
        }      
    }

用fiddldr调试如下： 2.我们添加两个方法如下：  

1
2
3
4
5
6
7
8
9
10
11
    public class TestController : ApiController
    {
        public object Get1()
        {
            return "d1";
        }
        public object Get2()
        {
            return "d2";
        }
    }

  我们再用fiddler调试如下： 错误信息是： {"Message":"出现错误。","ExceptionMessage":"找到了与该请求匹配的多个操作: \r\n类型 Supernova.Webapi.Controllers.TestController 的 Get1\r\n类型 Supernova.Webapi.Controllers.TestController 的 Get2","ExceptionType":"System.InvalidOperationException","StackTrace":"   在 System.Web.Http.Controllers.ApiControllerActionSelector.ActionSelectorCacheItem.SelectAction(HttpControllerContext controllerContext)\r\n   在 System.Web.Http.ApiController.ExecuteAsync(HttpControllerContext controllerContext, CancellationToken cancellationToken)\r\n   在 System.Web.Http.Dispatcher.HttpControllerDispatcher.<SendAsync>d__1.MoveNext()"} 我们将代码改为如下：  

1
2
3
4
5
6
7
8
9
10
11
12
    public class TestController : ApiController
    {
        public object Get1()
        {
            return "d1";
        }
        [HttpPost]
        public object Get2()
        {
            return "d2";
        }
    }

调试返回Get1的信息。 从上面两个测试我们可以得出如下结论： action的默认请求方式是HttpGet。 当多个action的 请求方式一样的话，在默认路由模板下(没有action)，将会匹配多个操作。 基于上面两点结论，默认路由模板无法满足针对一种资源一种请求方式的多种操作(比如修改操作，可能针对不同的字段进行修改)。 定制模板路由 我们重新定制模板路由，如下：  

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web.Http;
 
namespace Supernova.Webapi
{
    public static class WebApiConfig
    {
        public static void Register(HttpConfiguration config)
        {
            // Web API 配置和服务
 
            // Web API 路由
            config.MapHttpAttributeRoutes();
 
            config.Routes.MapHttpRoute(
                name: "DefaultApi",
                routeTemplate: "api/{controller}/{action}/{id}",
                defaults: new { id = RouteParameter.Optional }
            );
        }
    }
}

从上面我们可以看出，在默认路由的基础上，我们队路由模板增加了一级action。 测试api如下：  

1
2
3
4
5
6
7
8
9
10
11
   public class TestController : ApiController
    {
        public object Get1()
        {
            return "d1";
        }        
        public object Get2()
        {
            return "d2";
        }
    }

我们再通过http://192.168.0.230/api/test访问，返回404，如图： 我们通过http://192.168.0.230/api/test/Get1访问，结果正确，如图： 我们通过http://192.168.0.230/api/test/Get2访问，结果正确，如图：   通过定制路由模板我们可以得出如下结论： 通过在路由模板中增加action目录，对资源的定位直接作用到action上。 多个HttpGet方法可以共存于一个controller中。 基于上面两点结论，通过修改路由模板可以满足针对一种资源一种请求方式的多种操作。   2.2 特性路由 特性路由是通过给action打attribute的方式定义路由规则。 有时候我们会有这样的需求，我们请求的一个资源带有子资源。比如文章评论这样有关联关系的资源。我们希望通过如下URL获得某篇文章下的所有评论：api/book/id/comments。而仅仅凭借模板路由很难实现这种路由模式。这时候我们就需要特性路由来解决这个问题了。ASP.NET Web API为我们准备了Route特性，该特性可以直接打到Action上，使用非常灵活、直观。 下面我将先简单的介绍特性路由的使用方法。 我们重新定义api如下：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
   public class TestController : ApiController
    {
       [Route("demo")]  
        [HttpGet]
        public object Get1()
        {
            return "d1";
        }
       [Route("demo/get")]
       [HttpGet]
        public object Get2()
        {
            return "d2";
        }
    }

[…]

龙生   15 Oct 2017
View Details

c# webapi POST 参数解决方法

HttpWebRequest POST请求webapi：如果参数是简单类型，比如字符串（注意，拼接的字符串要HttpUtility.UrlEncode才行，否则服务端会丢失特殊字符&后面的数据） 要点：如下代码统一设置为：ContentType = "application/x-www-form-urlencoded"; 服务端代码1：URL格式为 POSTapi/Values public string Post([FromBody] string value) 则客户端Post的数据：拼接的字符串必须以 =开头，否则服务端无法取得value。例如：=rfwreewr2332322232 或者 {":value} 服务端代码2：URL格式为 POST api/Values?value={value} public string Post(string value) 则客户端Post的数据：需要url里拼接出KeyValue这样的数据 服务端代码3：URL格式为 POST api/Values public string Post() 则客户端Post的数据：无要求。例如：key=rfwreewr2332322232。 服务端：可以用HttpContext.Current.Request.InputStream或者HttpContext.Current.Request.Form[0]都可以获取 如果post的参数类型比较复杂，则需要自定义类 要点：如下代码统一设置为：ContentType = "application/json"; 服务端代码1：URL格式为 POST api/Values public string Post([FromBody] Model value)或者 public string Post(Model value) 则客户端Post的数据：{\"id\":\"test1\",\"name\":\"value\"}。服务端会自动映射到对象。 提交代码如下：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
            HttpWebRequest wReq = (HttpWebRequest)WebRequest.Create("http://localhost:37831/api/Values");
            wReq.Method = "Post";
            //wReq.ContentType = "application/json";
            //wReq.ContentType = "application/x-www-form-urlencoded";
            wReq.ContentType = "application/json";
 
            //byte[] data = Encoding.Default.GetBytes(HttpUtility.UrlEncode("key=rfwreewr2332322232&261=3&261=4"));
            byte[] data = Encoding.Default.GetBytes("{\"id\":\"test1\",\"name\":\"value\"}");
            wReq.ContentLength = data.Length;
            Stream reqStream = wReq.GetRequestStream();
            reqStream.Write(data, 0, data.Length);
            reqStream.Close();
            using (StreamReader sr = new StreamReader(wReq.GetResponse().GetResponseStream()))
            {
                string result = sr.ReadToEnd();
 
              
            }

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
        // POST api/values
        //public string Post()
        //{
        //    FileInfo fi = new FileInfo(AppDomain.CurrentDomain.BaseDirectory + "log.txt");
        //    StreamWriter sw = fi.CreateText();
        //    StreamReader sr = new StreamReader(HttpContext.Current.Request.InputStream);
        //    sw.WriteLine("1:" + sr.ReadToEnd()+"--"+ HttpContext.Current.Request.Form[0]);
        //    sw.Flush();
        //    sw.Close();
        //    return "{\"test\":\"1\"}";
        //}
 
        // POST api/values
        public HttpResponseMessage PostStudent(Student student)
        {
            FileInfo fi = new FileInfo(AppDomain.CurrentDomain.BaseDirectory + "log.txt");
            StreamWriter sw = fi.AppendText();
 
            sw.WriteLine("2:" + student.id);
            sw.Flush();
            sw.Close();
            HttpResponseMessage result = new HttpResponseMessage { Content = new StringContent("{\"test\":\"2\"}", Encoding.GetEncoding("UTF-8"), "application/json") };
            return result;
        }

这篇文章里有的方法也不错：http://www.cnblogs.com/rohelm/p/3207430.html   from:http://blog.csdn.net/wyqlxy/article/details/49303345

龙生   15 Oct 2017
View Details

Copyright © 2025 Longsheng All rights reserved