WebAPI请求

于即将要接手的新项目计划用ASP.NET MVC3来开发，所以最近一段时间一直在看相关的书或文章。因为之前在大学里也曾学习过MVC2开发，也做过几个简单的MVC2的小型测试项目，不过在后来工作以后主要还是开发WebForm的项目，所以MVC的东西也就逐渐的淡忘了。

　　经过这一段时间的系统学习，真的觉得MVC3相比于之前的MVC2还有WebForm来说，确实有一种让人欲罢不能爽歪歪的感觉。特别是Razor语法、Linq表达式等的结合运用。

　　为了将学习过程中遇到的一些值得留意的问题和知识点进行一个很好地整理，所以打算把对MVC的学习过程整理成一个文章系列，同时也希望能帮助那些初学ASP.NET MVC的童鞋们。可能文章的风格不会像其他文章那样讲的很深，主要还是通过实例来表达吧。由于自己也是初学，文章中难免有错误，也希望各位高手能够多多指教，大家共同学习。

　　好了，废话不多说，进入正题。

　　个人觉得在MVC中，路由规则算是比较重要的一点。记得之前曾看过dudu站长的一篇文章 HttpClient + ASP.NET Web API, WCF之外的另一个选择 ，对于用惯了“html+ajax+一般处理程序” 来开发项目的我来说，觉得这应该算是另一种更加高端的处理数据请求的方式吧，所以，今天我们就从这种“精简版的WebAPI” 开始说起。

 

　　首先，先创建一个“ASP.NET 空Web应用程序” ：

　　然后添加对 “System.Web.Http” 和 “System.Web.Http.WebHost” 的引用：

 

　　再添加对“System.Net.Http” 的引用：

 

　　由于需要用到对Json数据的处理，所以还要添加对 “Newtonsoft.Json” 的引用。

这里需要注意一下：

如果开始不添加对“Newtonsoft.Json”的引用，在项目运行时就会报错，具体报错原因稍后再说。

 

　　对四个类库的引用：

 

　　然后新建一个类，用于注册默认路由映射，这里类名为 WebAPIConfig ：

　　添加Global.asax文件，在 Application_Start 方法中 初始化路由映射：

        protected void Application_Start(object sender, EventArgs e)
        {
            //在应用程序启动时注册路由映射
            WebAPIConfig.Register(GlobalConfiguration.Configuration);
        }

　　记得引入命名空间：

using System.Web.Http;

　　注意：

上面我们提到，如果开始时不引用 “Newtonsoft.Json”，那么在运行时 注册路由映射这里就会报错：

 

　创建名为Controller的文件夹，然后添加一个类且类名以 Controller结尾，这里为UserController 。让这个类继承自 ApiController 基类：

　　创建名为Model的文件夹用来存放实体类，添加Users类：

　　在 UserController 类中，添加一个 GetUser() 方法，模拟一些数据：

//引入命名空间
using System.Web.Http;
using X_1_FirstWebAPI.Model;

namespace X_1_FirstWebAPI.Controller
{
    public class UserController : ApiController
    {

        public List<Users> GetUser()
        {
            var userList = new List<Users> { 
            new Users{ Id=1,UName="张三",UAge=12,UAddress="海淀区"},
            new Users{Id=2,UName="李四",UAge=23,UAddress="昌平区"},
            new Users{Id=3,UName="王五",UAge=34,UAddress="朝阳区"}
            };

            var temp = (from u in userList
                        select u).ToList();
            return temp;
        }

    }
}

 

　　我们之前添加的路由规则为 "api/{controller}/{action}/{id}" ，所以，我们在浏览器中访问数据的url为 http://localhost:****/api/controllerName/actionName  的形式，在这里即是 api/user/getuser :

　　OK，到这里，精简版的WebAPI项目就完成了，这个应该对于大部分.NET程序员来说理解起来是很简单的。

那下一篇文章我们就深入地来聊一聊如何调用WebAPI请求后台数据吧！

这里我使用Jquery 来发起异步请求实现数据调用。

　　继续使用上一文章中的示例，添加一个index.html页面，添加对jquery的引用。

 

一、无参数Get请求

　　一般的get请求我们可以使用jquery提供的$.get() 或者$.ajax({type:"get"}) 来实现：

　　请求的后台Action方法仍为上篇文章中的GetUser() :

　　也可以用$.ajax({type:"get"}) 方式，正确的获得了返回数据：

 

二、传递一个参数的Get请求

　　通常我们需要传递参数只需要指定ajax方法的data属性即可： data:{"name":"赵大宝"} 

　　后台正确的返回数据：

 

三、传递两个或多个参数的Get请求

　　按照上面的方法，对于多个参数我们可以很容易就写出来： data:{"name":"赵大宝","age":12}

 　　后台正确的返回数据：

四、无参数的Post请求

　　我们可以使用$.post() 或$.ajax({type:"post"}) 来发起post请求：

　　后台正确的返回了数据：

五、传递一个参数的Post请求：

　　首先这里需要提醒大家一下，我们在修改完后台代码后，如果没有重新生成项目，那么在请求时就会报错：“未找到与请求***匹配的HTTP资源” ：

　　所以，我们只要我们修改了后台代码，就一定要重新生成一下：

 

　　不过，当我们重新生成项目，再次发送请求，看到的仍然是404错误，再次检查一番代码，也没有发现是哪里的问题。

　　事实上，ASP.NET Web API能够正确的识别我们的UserController控制器处理Post /api/user ，但却不能找到一个可以接受的方法来处理请求。

也就是说，Web API接收到的请求能够找到User控制器，但在该控制器中找不到名称为Def 的这个Action。

那我们要怎么来解决呢？

通过搜索MSDN上Web API官网中的说明，我们可以找到下面的一段介绍：

即在Action 方法中我们需要使用 [FromBody] 属性标签来标明属性。

　　修改后，再次发送请求，我们可以看到，Status Code 为200，请求发送成功。

　　可以看到，在post请求中，方法的参数必须要用 [FromBody] 属性来修饰才可以， [FromBody] 就告诉Web API 要从post请求体重去获取参数的值。

但让我们诧异的却是，后台返回的数据中name的值为空。

　　通过调试，我们可以看到，后台Action 中接收到的name值为null。

 

　　通过上面的测试我就也能够猜测到，Web API 要求请求传递的 [FromBody] 参数，肯定是有一个特定的格式，才能被正确的获取到。而这种特定的格式并不是我们常见的 key=value 的键值对形式。Web API 的模型绑定器希望找到 [FromBody] 里没有键名的值，也就是说， 不是 key=value ，而是 =value 。

现在，咱们把data中的key设置为空，然后再次发送请求：

　　测试可见，后台正确的接收到了数据:

 六、传递两个参数的Post请求

　　按理说，一个参数的请求实现了，那么传递两个或者多个参数也就很顺利了，对于两个参数的后台接收方法，我们可能会这样来写:

但事实证明，这样是错误的。

 

那到底两个或者多个参数我们要怎样来定义呢？

再次查看官网中的介绍，我们了解到：

　　也就是说，[FromBody] 修饰的参数只能有一个。我们需要对传递的多个参数进行封装才行。

这里，我们可以将 Name和 Age 封装成一个Student 类：

　　前台页面再次发送请求：

　　Status Code为200，请求成功，并正确获取到后台返回的数据：

 

　　这里，我们通过上面图片中的请求头数据可以看到，Form Data 的格式是 key=value&key=value 这种表单数据格式 Name=%E8%B5%B5%E5%A4%A7%E5%AE%9D&Age=13 ，我们平时使用的比较多的一般为json格式。 这里，我们使用 JSON.stringify() 来序列化数据。

再次发送请求：

　　可以看到，From Data 中数据的格式为json字符串，Status Code为200，请求正确，但结果又出错了，后台又没有接收到数据参数：

那么问题到底出在哪呢？

　　我们再次查看上图中请求头内容，注意到，虽然我们传递的数据格式是json字符串，但请求头中的Content-type 却为 

application/x-www-form-urlencoded ，并不是json格式对于的 application/json 。 而编码格式 application/x-www-form-urlencoded 表示的是：窗体数据被编码为名称/值对。 

　　这里，也就是我想要说的一个注意点。平时我们在使用json数据的时候，很容易就忘记了 要指定 Content-type 为 "application/json" ，所以就容易导致很多“想不到”的错误。

所以，我们在 $.ajax() 中指定 Content-type :

　　这次，后台正确的接收并返回了数据：

 

七、传递多个参数的Post请求

　　有了上面的经验，传递多个参数的post请求我们就很容易能写出来了：

后台接收并返回数据：

 

八、传递多个不同对象的Post请求

　　有时候我们还会遇到需要传递多个不同对象参数的情况，对于这种特殊的情况在 Json.Net 中为我们提供了一个 名为 JObject 的通用对象容器，我们可以通过 .对象名 的方式来动态的遍历参数里面的属性的值，然后动态的转换和json类型中对应的属性类型。

比如：

后台调试，通过dynamic 动态转换获取属性的值：

后台正确的返回了数据：

 

九、获取不同类型的数据

　　一般我们获取到后台返回的数据格式类型为 json格式，我们也可以指定 请求头中的输出类型来获得不同的返回类型数据：

指定输出类型为xml格式：

指定输出类型为 json格式：

 

　　基本到这里，这篇文章的主要内容也就算说完了，其中的重点还是 Post请求中对于参数的处理是需要重点注意的。

　　上面我们在测试的过程中，都是通过自己创建的Controller控制器类来对参数进行接收处理，可能有人会问，我们这么写到底是否符合规范呢，Web API中默认是怎么来处理的呢？ 这里，Visual Studio 中也为我们自带了 Web API控制器类：

我们可以添加新建项选择 Web API控制器类 即可：

　　这里我们可以看到，默认创建的Controller控制器类中，对于Post请求的Action方法都自带了 [FromBody] 属性。 现在不用我说，你也已经知道为什么 它会为参数默认带一个 [FromBody]属性吧！

好了，今天的内容就到这里，下面附上我参考的几篇文章：

MSDN中关于Web API 中 [FromBody] 的介绍： Parameter Binding in ASP.NET Web API | The ASP.NET Site 

关于[FromBody]属性的介绍及Post参数说明（E文）： Using jQuery to POST [FromBody] parameters to Web API | Encosia