Як отримати значення спеціального заголовка в обробці повідомлень Web API?

На даний момент у моїй службі 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"

Як я можу отримати доступ до одного замовного заголовка запиту через екземпляр HttpRequestMessage( MSDN Documentation ), переданий у цей перекритий метод?

Спробуйте щось подібне:

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

Існує також метод TryGetValues ​​в заголовках, який ви можете використовувати, якщо не завжди гарантується доступ до заголовка.

Рядок нижче, 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();
     }           

Щоб розширити відповідь Юсефа, я написав цей метод, що ґрунтується на занепокоєнні Дрю з приводу того, що заголовок не існує, оскільки я потрапив у цю ситуацію під час тестування одиниць.

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 для більш загального рішення.

Створіть новий метод - " Повертає індивідуальне значення заголовка 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();
        }

Для подальшого розширення рішення @ 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");

Для ASP.Net Core є просте рішення, якщо ви хочете використовувати парам безпосередньо в методі контролера: Використовуйте анотацію [FromHeader].

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

Додаткова інформація: У моєму випадку "myParam" повинен був бути рядком, int завжди був 0.

Для ASP.NET ви можете отримати заголовок безпосередньо з параметра в методі контролера, використовуючи цю просту бібліотеку / пакет . Він надає [FromHeader]атрибут так само, як у вас в ASP.NET Core :). Наприклад:

    ...
    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}");
            ...
        }
    }

Рішення однієї лінії

var id = request.Headers.GetValues("MyCustomID").FirstOrDefault();

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

сучасний варіант :)