Jak wyodrębnić niestandardową wartość nagłówka w programie obsługi komunikatów interfejsu API sieci Web?

Obecnie mam program obsługi komunikatów w mojej usłudze interfejsu API sieci Web, która zastępuje „SendAsync” w następujący sposób:

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

W tym kodzie muszę sprawdzić niestandardową wartość nagłówka żądania o nazwie MyCustomID . Problem pojawia się, gdy wykonuję następujące czynności:

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

... pojawia się następujący komunikat o błędzie:

Nie można zastosować indeksowania z [] do wyrażenia typu „System.Net.Http.Headers.HttpRequestHeaders”

Jak mogę uzyskać dostęp do pojedynczego niestandardowego nagłówka żądania za pośrednictwem wystąpienia HttpRequestMessage( Dokumentacja MSDN ) przekazanego do tej zastąpionej metody?

Spróbuj czegoś takiego:

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

Istnieje również metoda TryGetValues ​​w nagłówkach, której możesz użyć, jeśli nie zawsze masz gwarancję dostępu do nagłówka.

Wiersz poniżej, throws exceptionjeśli klucz nie istnieje.

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

Obejść:

Uwzględnij System.Linq;

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

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

Aby rozwinąć odpowiedź Youssefa, napisałem tę metodę w oparciu o obawy Drew dotyczące nieistnienia nagłówka, ponieważ napotkałem taką sytuację podczas testów jednostkowych.

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

Oto przykład użycia:

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

Spójrz także na odpowiedź @ doguhan-uluca, aby uzyskać bardziej ogólne rozwiązanie.

Utwórz nową metodę - „ Zwraca indywidualną wartość nagłówka HTTP ” i wywołuj tę metodę z wartością klucza za każdym razem, gdy chcesz uzyskać dostęp do wielu wartości klucza z 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();
        }

Aby jeszcze bardziej rozwinąć rozwiązanie @ neontapir, oto bardziej ogólne rozwiązanie, które można zastosować w równym stopniu do HttpRequestMessage lub HttpResponseMessage i nie wymaga ręcznie zakodowanych wyrażeń ani funkcji.

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;
    }
}

Przykładowe użycie:

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

W przypadku ASP.Net Core istnieje proste rozwiązanie, jeśli chcesz użyć parametru bezpośrednio w metodzie kontrolera: użyj adnotacji [FromHeader].

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

Dodatkowe informacje: W moim przypadku „myParam” musiało być ciągiem znaków, int zawsze wynosił 0.

W przypadku ASP.NET można uzyskać nagłówek bezpośrednio z parametru w metodzie kontrolera za pomocą tej prostej biblioteki / pakietu . Zapewnia [FromHeader]atrybut, tak jak w ASP.NET Core :). Na przykład:

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

Rozwiązanie jednoprzewodowe

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

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

wariant nowoczesny :)