本条类别深刻的啊咱讲课了pc客户端如何告webapi
相信大家在看了自转载的第一篇稿子和就首文章以后,对webapi再也不会惧怕了!


 

座谈webapi的知识,欢迎加我微信 
jkxx123321 交流


 

 

WCF的野心造成了其的大复杂,HTTP的单培养了它们的大概优美。为了兑现分布式Web应用,我们只好以两头凑合在一起
—— WCF服务为HTTP绑定宿主于IIS。

 

于是发生了被人口晕头转向的安排、让人郁闷不已的调试,还发出那么ServiceContract,
DataContract, EnumMember…还有还有,并非在using语句被调用WCF服务…

 

于是乎时常自问:拿在牛刀绞苹果来必不可少为?废话,当然没有必要,水果刀在哪里?

 

微软看正在这样多人口以在牛刀绞苹果,自己为看不下去了,于是,一栽水果刀横空出世
—— ASP.NET Web API。

 

日前咱们于事实上付出中起个地方因此WCF太费事,就小试了一下水果刀,感觉还不易。

 

下用一个简的以身作则分享一下ASP.NET Web API水果刀的用法。

 

服务端ASP.NET Web API的实现

 

内需未雨绸缪的家伙:Visual Studio 2010, NuGet

 

  1. 新建一个空的ASP.NET Web Application项目。

 

XML 1

 

  1. 经NuGet添加ASP.NET Web
    API的援,在NuGet中搜索时一旦用“AspNetWebApi”(用“ASP.NET Web
    API”是摸索未至的),然后选取ASP.NET Web API(Beta)进行设置。

 

XML 2

 

  1. 添加Global.asax,在Application_Start中注册Web
    API的路由,在Global.asax.cs中补充加如下代码:

 

protected void Application_Start(object sender, EventArgs e)
{
    RouteTable.Routes.MapHttpRoute("WebApi", "api/{controller}/{action}/{id}", 
        new { id = RouteParameter.Optional });
}

 

4.
添加Controllers文件夹,在内部添加类文件DemoController.cs,并吃DemoController继承自ApiController。代码如下:

 

XML 3

namespace CNBlogsWebApiDemo.Controllers
{
    public class DemoController : ApiController
    {
    }
}

XML 4

 

  1. 上加ViewModels文件夹,在中添加Site.cs,并定义Site。

 

XML 5

namespace CNBlogsWebApiDemo.ViewModels
{
    public class Site
    {
        public int SiteId { get; set; }
        public string Title { get; set; }
        public string Uri { get; set; }
    }
}

XML 6

 

6.
叫DemoController添加一个术SiteList,并勾画及我们的言传身教代码。代码如下:

 

XML 7

public class DemoController : ApiController
{
    public IList<Site> SiteList(int startId, int itemcount)
    {
        var sites = new List<Site>();
        sites.Add(new Site { SiteId = 1, Title = "test", Uri = "www.cnblogs.cc" });
        sites.Add(new Site { SiteId = 2, Title = "博客园首页", Uri = "www.cnblogs.com" });
        sites.Add(new Site { SiteId = 3, Title = "博问", Uri = "q.cnblogs.com" });
        sites.Add(new Site { SiteId = 4, Title = "新闻", Uri = "news.cnblogs.com" });
        sites.Add(new Site { SiteId = 5, Title = "招聘", Uri = "job.cnblogs.com" });

        var result = (from Site site in sites
                        where site.SiteId > startId
                        select site)
                        .Take(itemcount)
                        .ToList();
        return result;
    }
}

XML 8

 

  1. 安排一下Web项目的开行设置Specific Page与Specific port

 

XML 9

 

  1. Ctrl+F5运行品种,结果如下:

 

XML 10

 

结果是咱们意在之,用浏览器直接可以查阅Web
API的运转结果,测试时会见坏有益。

 

好了,服务端Web API就这样轻松打定矣!

 

客户端通过HttpClient调用服务端Web API

 

  1. 新建一个WebApiTest的类库项目。

 

  1. 每当NuGet中上加System.Net.Http(HttpClient就以这边), Json.NET,
    xUnit.net。

 

  1. 增补加类文件WebApiClientTest.cs,添加测试方法WebApi_SiteList_Test:

 

XML 11

namespace WebApiClientTest
{
    public class WebApiClientTest
    {
        [Fact]
        public void WebApi_SiteList_Test()
        {

        }
    }
}

XML 12

 

4. WebApi_SiteList_Test() 的代码实现

 

4.1 首先,要确定三个东西:

 

  a) 客户端调用WebAPI的法子是Http Get,还Http Post,我们这边选用Http
Post;

 

  b) 客户端调用WebAPI时传递的参数格式,我们这边选用的凡Json。

 

  c) WebAPI返回的数额格式,我们这里选用的为是Json(这为是事先添加Json.NET引用的案由)。

 

4.2 用到之好像

 

  • System.Net.Http.HttpClient
  • System.Net.Http.httpContent
  • System.Net.Http.StringContent
  • System.Net.Http.Headers.MediaTypeHeaderValue
  • Newtonsoft.Json.JsonConvert

 

4.3 准备要传递给WebAPI的参数

 

  需要传递的鲜单参数是startId
,itemcount,传递的格式是Json。这里可是没Javascript中的JSON.stringify(),但咱发Json.NET,再添加匿名类型,有硌用js的觉得,代码如下:

 

var requestJson = JsonConvert.SerializeObject(new { startId = 1, itemcount = 3 });

 

  代码的运作结果:{“startId”:1,”itemcount”:3}

 

  然后因故System.Net.Http.StringContent把她由独确保:

 

HttpContent httpContent = new StringContent(requestJson);

 

  然后设置一下ContentType:

 

httpContent.Headers.ContentType = new MediaTypeHeaderValue("application/json");

 

4.4 通过XMLHttp Post调用WebAPI得到返回结果

 

  HttpClient闪亮登场,调用它的PostAsync()方法轻松搞定:

 

var httpClient = new HttpClient();
var responseJson = httpClient.PostAsync("http://localhost:9000/api/demo/sitelist", httpContent)
    .Result.Content.ReadAsStringAsync().Result;

 

  看一下responseJson的结果:

 

[{"SiteId":2,"Title":"博客园首页","Uri":"www.cnblogs.com"},{"SiteId":3,"Title":"博问","Uri":"q.cnblogs.com"},{"SiteId":4,"Title":"新闻","Uri":"news.cnblogs.com"}]

 

  正宗的Json!你注意到没有,服务端WebAPI的代码未发任何改动,我们只是以Http
Headers中以ContentType设置为application/json,返回的就是Json格式的数。而我们透过浏览器访问,得到的尚是专业的XML。这里就是是ASP.NET
Web API的魅力有 —— 一不善实现,按需服务。

 

4.5 将Json格式返回的结果相反序列化为强类型

 

  Json.NET又登场:

 

var sites = JsonConvert.DeserializeObject<IList<Site>>(responseJson);

 

  展示一下返回结果:

 

  代码

 

sites.ToList().ForEach(x => Console.WriteLine(x.Title + ":" + x.Uri));

 

  结果  

 

  博客园首页:www.cnblogs.com
  博问:q.cnblogs.com
  新闻:news.cnblogs.com

 

4.6 WebApi_SiteList_Test() 完整兑现代码

 

XML 13

public class WebApiClientTest
{
    [Fact]
    public void WebApi_SiteList_Test()
    {            
        var requestJson = JsonConvert.SerializeObject(new { startId = 1, itemcount = 3 });

        HttpContent httpContent = new StringContent(requestJson);
        httpContent.Headers.ContentType = new MediaTypeHeaderValue("application/json");

        var httpClient = new HttpClient();
        var responseJson = httpClient.PostAsync("http://localhost:9000/api/demo/sitelist", httpContent)
            .Result.Content.ReadAsStringAsync().Result;

        var sites = JsonConvert.DeserializeObject<IList<Site>>(responseJson);

        sites.ToList().ForEach(x => Console.WriteLine(x.Title + ":" + x.Uri));
    }
}

XML 14

 

注:运行此的代码之前,要事先运行WebAPI项目,先把劳动跑起,客户端才会享用到劳动。

 

跟jQuery ajax调用代码比较一下:

 

XML 15

var requestJson = JSON.stringify({ startId: 1, itemcount: 3 });
$.ajax({
    url: '/api/demo/sitelist',
    data: requestJson,
    type: "post",
    dataType: "json",
    contentType: "application/json; charset=utf8",
    success: function (data) {
        jQuery.each(data, function (i, val) {
            $("#result").append(val.Title + ': ' + val.Uri +'<br/>');
        });
    }
});

XML 16

 

流淌:上面的代码是只是真运行的哦,代码在演示代码WebApiDemo项目的AjaxWebApi.htm文件被。这也是ASP.NET
Web API “一不好实现,按需要服务”的体现。

 

小结 

 

水果刀(ASP.NET Web
API)用下来感觉还不易,不仅可以削苹果,还好削梨子,切西瓜也不值一提。用非用牛刀(WCF),还得几近考虑考虑。

 

相关文章

网站地图xml地图