這篇文章主要介紹“ASP.NET Web API示例分析”，在日常操作中，相信很多人在ASP.NET Web API示例分析問題上存在疑惑，小編查閱了各式資料，整理出簡(jiǎn)單好用的操作方法，希望對(duì)大家解答”ASP.NET Web API示例分析”的疑惑有所幫助！接下來，請(qǐng)跟著小編一起來學(xué)習(xí)吧！
創(chuàng)新互聯(lián)公司主營(yíng)饒陽網(wǎng)站建設(shè)的網(wǎng)絡(luò)公司,主營(yíng)網(wǎng)站建設(shè)方案,手機(jī)APP定制開發(fā),饒陽h5小程序開發(fā)搭建,饒陽網(wǎng)站營(yíng)銷推廣歡迎饒陽等地區(qū)企業(yè)咨詢環(huán)境基礎(chǔ)配置
首先我們新建一個(gè)類庫項(xiàng)目命名為Common，并且定義個(gè)貨品信息類型，示例代碼如下：
代碼1-1
重慶分公司
重慶分公司
namespaceCommon
{
publicclassProduct
{
publicstringProductID { get; set; }
publicstringProductName { get; set; }
publicstringProductCategory { get; set; }
}
}建立WebHost宿主環(huán)境
然后我們接著創(chuàng)建一個(gè)空的ASP.NET WEB應(yīng)用程序命名為WebHost,這里說明一下ASP.NET Web API框架只是個(gè)獨(dú)立框架，它并不能獨(dú)立運(yùn)行，所以它需要宿主環(huán)境，剛剛我們新建的WEB應(yīng)用程序則會(huì)在下面的示例中暫時(shí)的承載著ASP.NET Web API框架來運(yùn)行。
引用程序集
Newtonsoft.Json.dll 路徑： C:\Program Files\Microsoft ASP.NET\ASP.NET MVC 4\Packages\Newtonsoft.Json.4.5.6\lib\net40Newtonsoft.Json.dll
System.Net.Http.dll 路徑：C:\Program Files\Microsoft ASP.NET\ASP.NET MVC 4\Assemblies\ System.Net.Http.dll
System.Net.Http.Formatting.dll路徑：C:\Program Files\Microsoft ASP.NET\ASP.NET MVC 4\Assemblies\ System.Net.Http.Formatting.dll
System.Web.Http.dll 路徑：C:\Program Files\Microsoft ASP.NET\ASP.NET MVC 4\Assemblies\ System.Web.Http.dll
System.Web.Http.WebHost.dll路徑：C:\Program Files\Microsoft ASP.NET\ASP.NET MVC 4\Assemblies\System.Web.Http.WebHost.dll
Common.dll （項(xiàng)目引用）
或者采用這種引用方式：
（如果上文中所述的目錄位置沒有Newtonsoft.Json.dll的話可以文件搜索一下，然后手動(dòng)引用。）
隨之我們?cè)俳⒁粋€(gè)Web應(yīng)用程序處理類Globl.asax ，并在其Application_Start()方法中注冊(cè)路由，示例代碼如下：
代碼1-2
usingSystem.Web.Http;
namespaceWebHost
{
publicclassGlobal : System.Web.HttpApplication
{
protectedvoidApplication_Start(objectsender, EventArgse)
{
GlobalConfiguration.Configuration.Routes.MapHttpRoute(
"DefaultAPI", "api/{controller}/{id}", new { controller="product",id=RouteParameter.Optional });
}
}
}路由注冊(cè)好了之后，我們還得新建個(gè)Web API控制器，命名為ProductController，示例代碼如下：
代碼1-3
usingSystem.Web.Http;
usingCommon;
namespaceWebHost.Controllers
{
publicclassProductController:ApiController
{
privatestaticListproducts;
staticProductController()
{
products=newList();
products.AddRange(
newProduct[]
{
newProduct(){ ProductID="001", ProductName="牙刷",ProductCategory="洗漱用品"},
newProduct(){ ProductID="002", ProductName="《.NET框架設(shè)計(jì)—大型企業(yè)級(jí)應(yīng)用框架設(shè)計(jì)藝術(shù)》", ProductCategory="書籍"}
});
}
publicIEnumerableGet(stringid=null)
{
returnfromproductinproductswhereproduct.ProductID==id||string.IsNullOrEmpty(id) selectproduct;
}
}
} 在代碼1-3中我們看到ProductController控制器繼承自ApiController,這里的方式我的猜想應(yīng)該是跟ASP.NET MVC框架對(duì)控制器的處理一樣，在請(qǐng)求到來之后并且經(jīng)過路由處理之后，Web API框架會(huì)把當(dāng)前項(xiàng)目中所有引用的程序集全部查找一下并且搜出繼承自ApiController的類型，并且緩存在一個(gè)xml文件，不知道猜想的對(duì)不對(duì)在后面的篇幅我們?cè)賮眚?yàn)證，這里提一下。
細(xì)心的朋友的可能發(fā)現(xiàn)在路由注冊(cè)的時(shí)候并沒有對(duì)應(yīng)的Action的路由參數(shù)，其實(shí)這里就是Web API框架的一個(gè)不同之處，它是根據(jù)Http請(qǐng)求方法來確定Action的方法的，然而瀏覽器默認(rèn)的請(qǐng)求方法就是Http-get，所以我們這個(gè)時(shí)候可以直接運(yùn)行項(xiàng)目。
圖2
建立SelfHost
下面我們來看一下在SelfHost宿主環(huán)境中ASP.NET Web API框架的使用示例。
首先我們新建一個(gè)控制臺(tái)應(yīng)用程序命名為SelfHost，SelfHost環(huán)境項(xiàng)目的程序集引用和上面所說的WebHost項(xiàng)目引用唯一不同的就是把System.Web.Http.WebHost.dll程序集換成System.Web.Http.SelfHost.dll程序集，引用路徑不變，也可以利用引用里的擴(kuò)展欄來添加。
下面就讓我們看一下在SelfHost中我們需要做哪些事，首先我們需要注冊(cè)路由這是每次最先做的事情，示例代碼如下：
代碼1-4
usingSystem.Web.Http;
usingSystem.Web.Http.SelfHost;
namespaceSelfHost
{
classProgram
{
staticvoidMain(string[] args)
{
HttpSelfHostConfigurationselfHostConfiguration=
newHttpSelfHostConfiguration("http://localhost/selfhost");
using (HttpSelfHostServerselfHostServer=newHttpSelfHostServer(selfHostConfiguration))
{
selfHostServer.Configuration.Routes.MapHttpRoute(
"DefaultApi", "api/{controller}/{id}", new { id=RouteParameter.Optional});
selfHostServer.OpenAsync();
Console.WriteLine("服務(wù)器端服務(wù)監(jiān)聽已開啟");
Console.Read();
}
}
}
}這里就簡(jiǎn)要的說明一下，在1-4代碼中HttpSelfHostConfiguration對(duì)象示例中設(shè)置了基地址，對(duì)于HttpSelfHostConfiguration類型它是繼承自HttpConfiguration類型，HttpConfiguration類型是比較重要的一個(gè)類型，WebAPI框架中大多數(shù)的配置信息都在此類型實(shí)例中進(jìn)行設(shè)置。在后續(xù)的篇幅中會(huì)有說到。
HttpSelfHostServer對(duì)象就是在SelfHost宿主環(huán)境中擔(dān)當(dāng)著很重要的角色，它負(fù)責(zé)處理請(qǐng)求等一系列操作（因?yàn)樗荳ebAPI框架在SelfHost環(huán)境中的管道模型的“龍頭”），在這里只要稍作了解就行了，會(huì)在后面的管道篇幅揭開它的神秘面紗。
繼續(xù)向下看我們會(huì)看到HttpSelfHostServer對(duì)象實(shí)例中的Configuration屬性里的Routes屬性提供了對(duì)路由的注冊(cè)，這部分內(nèi)容會(huì)在后面的路由篇幅講解。
再之后就是我們看到的，打開服務(wù)監(jiān)聽，等待處理請(qǐng)求。（這里的監(jiān)聽/處理請(qǐng)求，并不是對(duì)真正的請(qǐng)求進(jìn)行處理，而是對(duì)已經(jīng)請(qǐng)求被封裝好了的對(duì)象進(jìn)行處理，管道篇幅中講解）
在路由注冊(cè)之后我們要新建個(gè)Web API控制器，就如同上面WebHost部分內(nèi)容一樣，拷貝一份過來，不過我們這里要對(duì)控制器的代碼稍作修改，示例代碼如下：
代碼1-5
usingSystem.Web.Http;
usingCommon;
namespaceSelfHost.Controllers
{
publicclassProductController:ApiController
{
privatestaticListproducts;
staticProductController()
{
products=newList();
products.AddRange(
newProduct[]
{
newProduct(){ ProductID="001", ProductName="牙刷",ProductCategory="洗漱用品"},
newProduct(){ ProductID="002", ProductName="《.NET框架設(shè)計(jì)—大型企業(yè)級(jí)應(yīng)用框架設(shè)計(jì)藝術(shù)》", ProductCategory="書籍"}
});
}
publicIEnumerableGet(stringid=null)
{
returnfromproductinproductswhereproduct.ProductID==id||string.IsNullOrEmpty(id) selectproduct;
}
publicvoidDelete(stringid)
{
products.Remove(products.First(product=>product.ProductID==id));
}
publicvoidPost(Productproduct)
{
products.Add(product);
}
publicvoidPut(Productproduct)
{
Delete(product.ProductID);
Post(product);
}
}
} 對(duì)于在代碼1-5中控制器新增的幾個(gè)Action方法，也是分別對(duì)應(yīng)著Http請(qǐng)求方法。這樣也就是能實(shí)現(xiàn)增刪改查的基礎(chǔ)功能了。那我們還需要一個(gè)對(duì)它進(jìn)行訪問的客戶端。
建立Clinet
我們?cè)俳ㄒ粋€(gè)控制臺(tái)應(yīng)用程序命名為Clinet，并且添加如下程序集引用：
Newtonsoft.Json.dll 路徑： C:\Program Files\Microsoft ASP.NET\ASP.NET MVC 4\Packages\Newtonsoft.Json.4.5.6\lib\net40Newtonsoft.Json.dll
System.Net.Http.dll 路徑：C:\Program Files\Microsoft ASP.NET\ASP.NET MVC 4\Assemblies\ System.Net.Http.dll
System.Net.Http.Formatting.dll路徑：C:\Program Files\Microsoft ASP.NET\ASP.NET MVC 4\Assemblies\ System.Net.Http.Formatting.dll
Common.dll （項(xiàng)目引用）
下面我們看一下在Client項(xiàng)目中對(duì)SelfHost環(huán)境中的資源進(jìn)行訪問的示例，示例代碼如下：
代碼1-6
usingCommon;
usingSystem.Net.Http;
namespaceClient
{
classProgram
{
staticvoidMain(string[] args)
{
AsyncProcess();
Console.Read();
}
privateasyncstaticvoidAsyncProcess()
{
HttpClienthttpClient=newHttpClient();
//獲取貨品信息列表
HttpResponseMessageresponseMessage=
awaithttpClient.GetAsync("http://localhost/selfhost/api/product");
IEnumerableproducts=awaitresponseMessage.Content.ReadAsAsync>();
OutputProductInfo(products);
//添加貨品
Productproduct=newProduct()
{
ProductID="003",
ProductName="《ASP.NET Web API 2 框架揭秘》",
ProductCategory="食品類"
};
awaithttpClient.PostAsJsonAsync("http://localhost/selfhost/api/product", product);
responseMessage=awaithttpClient.GetAsync("http://localhost/selfhost/api/product");
products=awaitresponseMessage.Content.ReadAsAsync>();
OutputProductInfo(products);
//修改指定貨品信息
responseMessage=awaithttpClient.GetAsync("http://localhost/selfhost/api/product/003");
product= (awaitresponseMessage.Content.ReadAsAsync>()).First();
product.ProductCategory="書籍";
awaithttpClient.PutAsJsonAsync("http://localhost/selfhost/api/product", product);
responseMessage=awaithttpClient.GetAsync("http://localhost/selfhost/api/product");
products=awaitresponseMessage.Content.ReadAsAsync>();
OutputProductInfo(products);
//刪除指定貨品
awaithttpClient.DeleteAsync("http://localhost/selfhost/api/product/001");
responseMessage=awaithttpClient.GetAsync("http://localhost/selfhost/api/product");
products=awaitresponseMessage.Content.ReadAsAsync>();
OutputProductInfo(products);
}
privatestaticvoidOutputProductInfo(IEnumerableproducts)
{
foreach (Productproductinproducts)
{
Console.WriteLine(
"ProductID:{0},ProductName:{1},ProductCategorm:{2}",
product.ProductID, product.ProductName, product.ProductCategory);
}
Console.WriteLine("—————————————————————————");
}
}
} 到此，關(guān)于“ASP.NET Web API示例分析”的學(xué)習(xí)就結(jié)束了，希望能夠解決大家的疑惑。理論與實(shí)踐的搭配能更好的幫助大家學(xué)習(xí)，快去試試吧！若想繼續(xù)學(xué)習(xí)更多相關(guān)知識(shí)，請(qǐng)繼續(xù)關(guān)注創(chuàng)新互聯(lián)網(wǎng)站制作公司網(wǎng)站，小編會(huì)繼續(xù)努力為大家?guī)砀鄬?shí)用的文章！
創(chuàng)新互聯(lián)www.cdcxhl.cn，專業(yè)提供香港、美國(guó)云服務(wù)器，動(dòng)態(tài)BGP最優(yōu)骨干路由自動(dòng)選擇，持續(xù)穩(wěn)定高效的網(wǎng)絡(luò)助力業(yè)務(wù)部署。公司持有工信部辦法的idc、isp許可證， 機(jī)房獨(dú)有T級(jí)流量清洗系統(tǒng)配攻擊溯源，準(zhǔn)確進(jìn)行流量調(diào)度，確保服務(wù)器高可用性。佳節(jié)活動(dòng)現(xiàn)已開啟，新人活動(dòng)云服務(wù)器買多久送多久。
