如何在Web API消息處理程序中提取自定義標題值？

Question

我目前在我的Web API服務的消息處理程序覆蓋「SendAsync」如下：

protected override Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken) 
{ 
    //implementation 
} 

在這個代碼，我需要檢查一個名爲MyCustomID自定義添加請求標頭值。問題是，當我做到以下幾點：

if (request.Headers.Contains("MyCustomID")) //OK 
    var id = request.Headers["MyCustomID"]; //build error - not OK 

...我收到以下錯誤信息：

不能申請用[]索引到 型「的表達System.Net.Http .Headers.HttpRequestHeaders'

如何通過傳遞到此OVE的HttpRequestMessage（MSDN Documentation）實例訪問單個定製請求頭rridden方法？

Answer 1

嘗試這樣：

IEnumerable<string> headerValues = request.Headers.GetValues("MyCustomID"); 
var id = headerValues.FirstOrDefault(); 

還有你可以使用，如果你並不總是保證有機會獲得頭頭一個TryGetValues方法。

Answer 2

爲了擴大Youssef的回答，我寫了這個方法，這個方法是基於Drew關於頭部不存在的問題，因爲我在單元測試中遇到了這種情況。

private T GetFirstHeaderValueOrDefault<T>(string headerKey, 
    Func<HttpRequestMessage, string> defaultValue, 
    Func<string,T> valueTransform) 
    { 
     IEnumerable<string> headerValues; 
     HttpRequestMessage message = Request ?? new HttpRequestMessage(); 
     if (!message.Headers.TryGetValues(headerKey, out headerValues)) 
      return valueTransform(defaultValue(message)); 
     string firstHeaderValue = headerValues.FirstOrDefault() ?? defaultValue(message); 
     return valueTransform(firstHeaderValue); 
    } 

下面是一個例子用法：

GetFirstHeaderValueOrDefault("X-MyGuid", h => Guid.NewGuid().ToString(), Guid.Parse); 

也看看@ doguhan-uluca的回答一個更通用的解決方案。

Answer 3

如果密鑰不存在，則在throws exception以下的行。

IEnumerable<string> headerValues = request.Headers.GetValues("MyCustomID"); 

解決方法：

包含System.Linq的;

IEnumerable<string> headerValues; 
var userId = string.Empty; 

    if (request.Headers.TryGetValues("MyCustomID", out headerValues)) 
    { 
     userId = headerValues.FirstOrDefault(); 
    }   

Answer 4

要在@ neontapir的解決方案進一步擴大，這裏是一個可以適用於HttpRequestMessage或HttpResponseMessage同樣的，不需要手工編碼的表達式或函數更通用的解決方案。

using System.Net.Http; 
using System.Collections.Generic; 
using System.Linq; 

public static class HttpResponseMessageExtensions 
{ 
    public static T GetFirstHeaderValueOrDefault<T>(
     this HttpResponseMessage response, 
     string headerKey) 
    { 
     var toReturn = default(T); 

     IEnumerable<string> headerValues; 

     if (response.Content.Headers.TryGetValues(headerKey, out headerValues)) 
     { 
      var valueString = headerValues.FirstOrDefault(); 
      if (valueString != null) 
      { 
       return (T)Convert.ChangeType(valueString, typeof(T)); 
      } 
     } 

     return toReturn; 
    } 
} 

使用範例：

var myValue = response.GetFirstHeaderValueOrDefault<int>("MyValue"); 

Answer 5

創建一個新的方法 - 「返回一個單獨的HTTP標頭值」，當你需要從HttpRequestMessage訪問多個關鍵值調用此方法與關鍵值，每次。

public static string GetHeader(this HttpRequestMessage request, string key) 
     { 
      IEnumerable<string> keys = null; 
      if (!request.Headers.TryGetValues(key, out keys)) 
       return null; 

      return keys.First(); 
     } 

Answer 6

對於ASP.Net核心有一個簡單的解決方案，如果希望直接在控制器方法使用PARAM：使用[FromHeader]註釋。

 public JsonResult SendAsync([FromHeader] string myParam) 
     { 
     if(myParam == null) //Param not set in request header 
     { 
      return null; 
     } 
     return doSomething(); 
    } 

附加信息：在我的情況下， 「myParam」 必須是一個字符串，整數總是0

Answer 7

request.Headers.FirstOrDefault(x => x.Key == "MyCustomID").Value?.FirstOrDefault() 

現代變種:)

Answer 8

對於ASP.NET，你可以得到在控制器方法中使用this simple library/package直接從參數中獲取頭文件。它提供了一個[FromHeader]屬性，就像你在ASP.NET核心:)一樣。例如：

... 
    using RazHeaderAttribute.Attributes; 

    [Route("api/{controller}")] 
    public class RandomController : ApiController 
    { 
     ... 
     // GET api/random 
     [HttpGet] 
     public IEnumerable<string> Get([FromHeader("pages")] int page, [FromHeader] string rows) 
     { 
      // Print in the debug window to be sure our bound stuff are passed :) 
      Debug.WriteLine($"Rows {rows}, Page {page}"); 
      ... 
     } 
    }