首页 > 资讯 > 精选 >如何使用ASP.Net WebAPI构建REST服务

464

分享到

如何使用ASP.Net WebAPI构建REST服务

2023-07-02 08:07:39 464人浏览薄情痞子

摘要

这篇文章主要介绍了如何使用asp.net webapi构建REST服务的相关知识，内容详细易懂，操作简单快捷，具有一定借鉴价值，相信大家阅读完这篇如何使用ASP.net WEBapi构建REST服务文章都会有所收获，下面

这篇文章主要介绍了如何使用asp.net webapi构建REST服务的相关知识，内容详细易懂，操作简单快捷，具有一定借鉴价值，相信大家阅读完这篇如何使用ASP.net WEBapi构建REST服务文章都会有所收获，下面我们一起来看看吧。

一、创建WebAPI应用程序

1、Web API 1版本

首先创建一个Asp.Net mvc 4 Web应用程序（我这里用的是Visual Studio 2012）。

如何使用ASP.Net WebAPI构建REST服务

在出来的模板中选择Web API。点击确定后，就创建了一个空的WebAPI服务。

如何使用ASP.Net WebAPI构建REST服务

2、Web API 2版本

如何使用ASP.Net WebAPI构建REST服务

点击确定后，就创建了一个空的WebAPI服务。此时只有一个空项目，还没有任何功能

在进行下一步之前，首先我们来看一下REST的基本操作模型，大致可以分为如下四种：

POST — 创建资源
GET — 检索资源
PUT — 更新资源
DELETE — 删除资源

非常经典的CRUD模型。

在Web API中实现这样一个的模型是非常简单的，直接使用向导建一个Controller即可

如何使用ASP.Net WebAPI构建REST服务

在Web API中生成默认的ValuesController

如何使用ASP.Net WebAPI构建REST服务

默认的模板内容如下：

public class ValuesController : ApiController{        // GET api/values        public IEnumerable<string> Get()        {            return new string[] { "value1", "value2" };        }        // GET api/values/5        public string Get(int id)        {            return "value";        }        // POST api/values        public void Post([FromBody]string value)        {        }        // PUT api/values/5        public void Put(int id, [FromBody]string value)        {        }        // DELETE api/values/5        public void Delete(int id)        {        }}

这其实已经帮我们实现了一个最基本的服务了，不过这个服务中只实现了Get，它支持如下两种中方式的URL访问（其它的方式也能访问，但没有具体的效果）：

api/values 访问所有的Value列表
api/values/{id} 根据ID访问Value

按Ctrl + F5中执行，在浏览器中输入相应的地址即可看到结果

如何使用ASP.Net WebAPI构建REST服务

下面我们要做的就是完善它，实现一个简单的查询功能，这里我引用了微软官方的一个例子：

public class ProductsController : ApiController{        Product[] products = new Product[]        {            new Product { Id = 1, Name = "Tomato Soup", CateGory = "Groceries", Price = 1 },            new Product { Id = 2, Name = "Yo-yo", Category = "Toys", Price = 3.75M },            new Product { Id = 3, Name = "Hammer", Category = "Hardware", Price = 16.99M }        };        public IEnumerable Get()        {            return products;        }        public IHttpActionResult Get(int id)        {            var product = products.FirstOrDefault((p) => p.Id == id);            if (product == null)            {                return NotFound();            }            return Ok(product);        }}public class Product{        public int Id { get; set; }        public string Name { get; set; }        public string Category { get; set; }        public decimal Price { get; set; }}

此时，我们就可以在浏览器中看到结果了（由于Controller改名字了，此时的地址就变成了api/products）

如何使用ASP.Net WebAPI构建REST服务

到此为止，一个基于Asp.net Web API的简单的REST Web服务就构建完成了，由于篇幅所限，这里就不做更多的介绍了，跟多信息可以参看微软官方文档：Getting Started with ASP.NET Web API 2。

备注：WebAPI升级到 WebAPI 2如下命令更新web Api：

Install-Package Microsoft.AspNet.WebApi

二、路由

REST并没有像传统的rpc服务那样显式指定了服务器函数的访问路径，而是将URL根据一定的规则映射为服务函数入口，这个规则就称之为路由。Asp.Net WebAPI的路由方式和Asp.Net MVC是相同的，它支持两种路由方式，传统的路由映射和特性路由。路由规则WebApiConfig.cs中定义。

如何使用ASP.Net WebAPI构建REST服务

它的默认内容如下：

public static class WebApiConfig{    public static void ReGISter(HttpConfiguration config)    {        // Web API configuration and services        // Web API routes        config.MapHttpAttributeRoutes();        config.Routes.MapHttpRoute(            name: "DefaultApi",            routeTemplate: "api/{controller}/{id}",            defaults: new { id = RouteParameter.Optional }        );    }}

它默认注册了两种路由规则，第一行注册的是特性路由，第二行注册的则是传统的映射路由。默认情况下，由于我们没有编写特性路由规则，则是按照传统的Controller方式映射路由。

关于路由规则，MSDN文档ASP.NET 路由介绍得非常详细，但由于其介绍得太详细了，反而不容易得其门而入，这里我只拿默认的路由规则来简单但的介绍一下我的理解，它的uri格式是这样的"api/{controller}/{id}"，其中id是可选的。拿前文的例子来说吧，

当我们对api/products地址进行访问的时候，系统则会首先找到名为ProductsController的控制器。
然后，根据访问方式查找函数，由于这里是Get操作，则查找Get开头的函数，这里会找到Get()和Get(int id)两个重载版本。
最后，根据参数来匹配具体的函数，因为这里没有带参数id。因此匹配到了Get()函数，返回了所有的集合。

另外，这里也有几个常用的衍生规则：

根据操作方式找函数的时候，只需要匹配首部即可，因此我们编写函数的时候写成Get()和GetProduct()都是可以的。，
根据操作方式找函数的时候查找的时候不分大小写，因此写成Get()或get()都是可以的

当我们使用带参数的版本时候，也有几个需要注意的地方：

参数名不分大小写，我们写成id或ID都是可以的
参数名要求严格匹配的，我们写成ID2是不行的，此时则会匹配到错误的结果Get()

默认的规则虽然大多数的时候还是比较方便的，但是很多时候我们需要手动指定个性化的路由规则。例如，我们可以自定义一个按名称来查询的url：api/products/name=xxx。这个时候则可以用特性路由快速的实现了：

[Route("api/{controller}/name={name}")]public IHttpActionResult GetByName(string name)

三、返回值

Asp.Net WebAPI服务函数的返回值主要可以分为void、普通对象、HttpResponseMessag、IHttpActionResult e四种，本文这里简单的介绍一下它们的区别。

1、返回void

返回void一般常用于Put和Delete函数。

public void Delete(int id){}

当服务函数执行完成后，服务器端并不是啥都不干直接把客户端给断掉，而是发送一个标准的204 (No Content)的Http应答给客户端。

HTTP/1.1 204 No Content    Cache-Control: no-cache    Pragma: no-cache    Expires: -1    Server: Microsoft-IIS/8.0    X-AspNet-Version: 4.0.30319    X-SourceFiles: =?UTF-8?B?Zjpc5paH5qGjXHZpc3VhbCBzdHVkaW8gMjAxM1xQcm9qZWN0c1xXZWJBcHBsaWNhdGlvbjFcV2ViQXBwbGljYXRpb24xXGFwaVx2YWx1ZXNcMQ==?=    X-Powered-By: ASP.NET    Date: Fri, 02 May 2014 13:32:07 GMT

2、返回普通对象

返回普通对象时，服务器将返回的对象序列化后（默认是JSON），通过Http应答返回给客户端。例如，

public class ValuesController : ApiController{        public string Get()        {            return "hello";        }}

此时的返回结果是：

HTTP/1.1 200 OK    Cache-Control: no-cache    Pragma: no-cache    Content-Type: application/json; charset=utf-8    Expires: -1    Server: Microsoft-IIS/8.0    X-AspNet-Version: 4.0.30319    X-SourceFiles: =?UTF-8?B?Zjpc5paH5qGjXHZpc3VhbCBzdHVkaW8gMjAxM1xQcm9qZWN0c1xXZWJBcHBsaWNhdGlvbjFcV2ViQXBwbGljYXRpb24xXGFwaVx2YWx1ZXM=?=    X-Powered-By: ASP.NET    Date: Fri, 02 May 2014 12:54:18 GMT    Content-Length: 7"hello"

异步返回普通对象：

WebAPI也是支持异步返回对象的：

    public async Task<string> Get()    {        await Task.Delay(100);        return "hello";    }

异步返回的时候，服务器异步等待函数执行完成后再将返回值返回给对象。由于这个过程对于客户端来说是透明的，这里就不列举报文了。

3、返回HttpResponseMessage

HttpResponseMessage是标准Http应答了，此时服务器并不做任何处理，直接将HttpResponseMessage发送给客户端。

public HttpResponseMessage Get(){        var response = Request.CreateResponse(httpstatusCode.OK);        response.Content = new StrinGContent("hello", Encoding.UTF8);                    return response;}

此时的返回结果如下：

HTTP/1.1 200 OK    Cache-Control: no-cache    Pragma: no-cache    Content-Length: 5    Content-Type: text/plain; charset=utf-8    Expires: -1    Server: Microsoft-IIS/8.0    X-AspNet-Version: 4.0.30319    X-SourceFiles: =?UTF-8?B?Zjpc5paH5qGjXHZpc3VhbCBzdHVkaW8gMjAxM1xQcm9qZWN0c1xXZWJBcHBsaWNhdGlvbjFcV2ViQXBwbGljYXRpb24xXGFwaVx2YWx1ZXM=?=    X-Powered-By: ASP.NET    Date: Fri, 02 May 2014 13:09:57 GMThello

可以看到，这里返回的content-type仍然是原始定义的text类型，而不是json。要实现想上面的例子所示的结果，则需要将Get函数改写为如下形式

public HttpResponseMessage Get(){        return Request.CreateResponse(HttpStatusCode.OK, "hello");}

4、返回IHttpActionResult

IHttpActionResult是Web API 2 中引入的一个接口，它的定义如下：

public interface IHttpActionResult{        Task ExecuteAsync(CancellationToken cancellationToken);}

从它的定义可以看出，IHttpActionResult是HttpResponseMessage的一个工厂类，最终还是用于构建HttpResponseMessage返回，由于它可以取消，因而可以实现更为强大的返回功能（如流传输）。当服务函数返回IHttpActionResult对象时，服务器执行该对象的ExecuteAsync函数，并异步等待至函数完成后，获取其返回值HttpResponseMessage输出给客户端。

IHttpActionResult是WebAPI中推荐的标准返回值，ApiController类中也提供了不少标准的工厂函数方便我们快速构建它们，如BadRequest，Conflict，Ok，NotFound等，一个简单的示例如下：

public IHttpActionResult Get(int id){        var product = products.FirstOrDefault((p) => p.Id == id);        if (product == null)        {            return NotFound();        }        return Ok(product);}

四、参数绑定

1、默认绑定方式

WebAPI把参数分成了简单类型和复杂类型：

简单类型主要包括CLR的primitive types，（int、double、bool等），系统内置的几个struct类型（TimeSpan、Guid等）以及string。对于简单类型的参数，默认从URI中获取。
复杂类型的数据也可以直接作为参数传入进来，系统使用media-type fORMatter进行解析后传给服务函数。对于复杂类型，默认从正文中获取。

例如，对于如下函数

HttpResponseMessage Put(int id, Product item)

其id默认从url中获取，其item默认从正文中获取。

2、使用 [FromUri] 标记从URI中绑定参数

我们可以使用 [FromUri] 标记强制从URI中绑定参数，例如

public class GeoPoint{        public double Latitude { get; set; }        public double Longitude { get; set; }}public ValuesController : ApiController{        public HttpResponseMessage Get( [FromUri]  GeoPoint location) { ... }}

这样，Get参数就是从URI中获取了读取GeoPoint对象。需要注意的是，此时我们必须将GeoPoint对象的属性在URI中传入： http://localhost/api/values/?Latitude=47.678558&Longitude=-122.130989 。

这种默认的序列化方式比较冗长，我们也可以自定义反序列化格式为类似这样的形式：http://localhost/api/values/?location=47.678558,-122.130989。

3、使用 [FromBody] 标记从正文中绑定参数

同样，我们可以使用 [FromBody] 标记强制从正文中绑定参数，例如

public HttpResponseMessage Post( [FromBody] string name)

将强制从FormData等非URL参数中读取数据

如何使用ASP.Net WebAPI构建REST服务

4、绑定多个参数

前面介绍的方式中，只能从URI中绑定一个参数，虽然可以通过传入复杂类型解决多参数的问题，但很多时候不如在URI中来得直接。此时，我们则可以使用前面介绍的特性路由来实现多参的绑定，例如：

[Route("api/{controller}/{year}/{month}/{day}")]public string Get(int year, int month, int day){        return string.Join(",", year, month, day);}

五、客户端

WebAPI是标准的Http协议，支持Http协议的客户端（如浏览器）都可以访问。但是，有的时候我们如果想在自己的程序中使用WebAPI时，此时就要实现自己的客户端了。

1、使用HttpClient库

我之前介绍过在.Net 4.5中新增的HttpClient库，它对Http操作实现了非常好的封装。我们可以通过它实现Http访问，例如，我们对前文所示的API进行一次Post操作：

// POST: api/Valuespublic void Post(Product value){}

首先对HttpClient进行一些初始化操作：

var client = new HttpClient();client.BaseAddress = new Uri("http://localhost:1282/");client.DefaultRequestHeaders.Accept.Clear();client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));

这里主要进行了两部操作：1. 定义了默认的基地址，减少后续的URL长度，2. 定义了默认的接受的数据类型为Json。

下一步就要开始对Product对象的内容编码，默认是xml或json，这里我选择相对简单的json：

var product = new Product() { Id = 1, Name = "food" };var content = Newtonsoft.Json.JsonConvert.SerializeObject(product);var httpContent = new StringContent(content, Encoding.UTF8);httpContent.Headers.ContentType = new MediaTypeHeaderValue("application/json") { CharSet = "utf-8" };await httpContent.LoadIntoBufferAsync();var rsp = await client.PostAsync("api/values", httpContent);

从上面的代码可以看出，由于WebAPI不像WCF那样能自动生成客户端代码，需要我们自己封装对象，上面光封装对象就用了四行代码，对于不熟悉HttpClient朋友来说还是比较容易出错的。因此微软提供了一系列扩展函数方便我们简化这一过程。

2、使用WebApi.Client库

在Nuget中安装WebApi.Client库

如何使用ASP.Net WebAPI构建REST服务

这个库安装后会在引用中增加一个System.Net.Http.Formatting的程序集，它主要提供了一系列扩展函数（其实装这个库顺带也会把HttpClient和Json.Net一并安上），现在上面的代码就可以简化如下了：

var product = new Product() { Id = 1, Name = "food" };var rsp = await client.PostAsJsonAsync("api/values", product);

除了PostAsJsonAsync这个扩展函数外，还提供了PostAsXmlAsync这种以XML传输的方式。同样，Put也有PutAsJsonAsync和PutAsXmlAsync的扩展版本。对于Get，虽然也提供了扩展函数，但是使用的方式稍有不同：

var rsp = await client.GetAsync("api/values/1");rsp.EnsureSuccessStatusCode();var product = await rsp.Content.ReadAsAsync();

对于Delete，却没有提供扩展函数，可能是官方认为Delete直接在URL中就传ID就够用了，没必要在Request中封装消息了吧。

六、Self-Host

Asp.Net WebAPI生成的是一个程序集，并不是独立的进程，因此，要运行的时候必须将其承载在相应的宿主上，一般比较常见的是IIS承载。

很多时候，我们为了简化部署或者功能集成，需要将其承载到独立的进程上，这种方式一般称之为Self-Host，本文就简单的介绍一下WebAPI的SefHost方法。

首先在Nuget上安装Microsoft.AspNet.WebApi.SelfHost库。

如何使用ASP.Net WebAPI构建REST服务

附上我们的WebAPI控制器

public class ValuesController : ApiController{    public IEnumerable<string> Get()    {        return new string[] { "111", "222" };    }}

接下来的工作就是启动我们的服务器了。

    class Program    {        static void Main(string[] args)        {            //Assembly.Load("WebApplication1, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null");    //加载外部程序集            var config = new HttpSelfHostConfiguration("http://localhost:8080");            config.Routes.MapHttpRoute(                "API Default", "api/{controller}/{id}",                new { id = RouteParameter.Optional });            using (var server = new HttpSelfHostServer(config))            {                server.OpenAsync().Wait();                Console.WriteLine("Press Enter to quit.");                Console.ReadLine();            }        }    }

从上面的代码可以看出，配置文件和Asp.Net程序中基本上是一样的，如果是直接用Asp.Net项目中生成的DLL的话，我们也可以直接用其WebApiConfig.Register的方法来进行配置的（需要像第一行注掉的那样使用Assembly.Load加载程序集）。下面一段就是启动服务器了，更多内容可以参看MSDN文档：http://www.asp.net/web-api/overview/hosting-aspnet-web-api/self-host-a-web-api

值得一提的是，SelfHost是在一个独立进程中启动了Http服务，也可以是说，它是一个mini版的Http服务器，我之前介绍过通过HttpListener实现简单的Http服务，到了现在，用WebAPI的SelfHost方式是可以更加快捷的实现扩展性更好的Mini Http服务器的，当我们需要一个简单的Http服务的时候，可以使用这种方式。

除了这种方式外，微软更加推荐用功能更加强大的OWIN来承载WebAPI服务。

另外，除了IIS、SelfHost等方式外，云时代发布到windows Azure也是非常便捷的，这里就不做多少介绍了。