使用ASP.Net WebAPI構建REST服務(五)——客戶端


WebAPI是標准的Http協議,支持Http協議的客戶端(如瀏覽器)都可以訪問。但是,有的時候我們如果想在自己的程序中使用WebAPI時,此時就要實現自己的客戶端了。我之前介紹過在.Net 4.5中新增的HttpClient庫,它對Http操作實現了非常好的封裝。我們可以通過它實現Http訪問,例如,我們對前文所示的API進行一次Post操作:

    // POST: api/Values
    public 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那樣能自動生成客戶端代碼,需要我們自己封裝對象,上面光封裝對象就用了四行代碼,對於不熟悉HttpClientd 朋友來說還是比較容易出錯的。因此微軟提供了一系列擴展函數方便我們簡化這一過程。

在NUGET中安裝WebApi.Client庫

    

這個庫安裝后會在引用中增加一個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<Product>();

對於Delete,卻沒有提供擴展函數,可能是官方認為Delete直接在URL中就傳ID就夠用了,沒必要在Request中封裝消息了吧。

限於篇幅,今天就介紹到這里了,更多內容的可以參看官方文檔:http://www.asp.net/web-api/overview/web-api-clients/calling-a-web-api-from-a-net-client

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM