Как извлечь пользовательское значение заголовка в обработчик сообщений 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 ), переданный в этот переопределенный метод?

Попробуйте что-то вроде этого:

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()

современный вариант :)