能省則省：在ASP.NET Web API中通過HTTP Headers返回資料

標籤：

對於一些返回資料非常簡單的 Web API，比如我們今天遇到的“返回指定使用者的未讀站內短訊息數”，返回資料就是一個數字，如果通過 http response body 返回資料，顯得有些奢侈。何不直接通過 http headers 返回呢？節能又環保。於是今天在 ASP.NET Web API 中實際試了一下，證明是可行的。

在 Web API 服務端藉助 HttpResponseMessage ，可以很輕鬆地實現，代碼如下：

public class MessagesController : ApiController{    [Route("api/messages/user-{userId}/unread/count")]    public async Task<HttpResponseMessage> GetUserUnreadMessageCount(int userId)    {        var unreadCount = 10;        var response = Request.CreateResponse(HttpStatusCode.OK);        response.Headers.Add("X-RESULT-COUNT", unreadCount.ToString());        return response;    }}

而調用用戶端只需直接從 http headers 中讀取資料，無需從 http response body 中讀取（如果用 HttpClient 就省掉了 Content.ReadAsStringAsync 操作），從而節省了資源。代碼如下：

public class WebApiTest{    [Fact]    public async Task Get_User_Unread_Message_Count()    {        using (var client = new HttpClient())        {            client.BaseAddress = new System.Uri("www.cnblogs.com");            var userId = 1;            var response = await client.GetAsync($"/api/messages/user-{userId}/unread/count");            if (response.IsSuccessStatusCode)            {                var unreadCount = response.Headers.GetValues("X-RESULT-COUNT").FirstOrDefault();                Console.WriteLine(unreadCount);                Assert.Equal(10, int.Parse(unreadCount));            }            else            {                Console.WriteLine(response.StatusCode);                Console.WriteLine(await response.Content.ReadAsStringAsync());            }        }    }}

【參考資料】

Getting a count of returns seen by a RESTful request

Paging in ASP.NET Web API: Using HTTP Headers

能省則省：在ASP.NET Web API中通過HTTP Headers返回資料