Comment extraire la valeur d'un en-tête personnalisé dans le gestionnaire de messages de l'API Web ?

Question

J'ai actuellement un gestionnaire de messages dans mon service d'API Web qui remplace "SendAsync" comme suit :

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

Dans ce code, je dois inspecter une valeur d'en-tête de demande ajoutée personnalisée nommée MyCustomID . Le problème est que lorsque je fais ce qui suit :

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

...je reçois le message d'erreur suivant :

Impossible d'appliquer l'indexation avec [] à une expression de type System.Net.Http.Headers.HttpRequestHeaders'.

Comment puis-je accéder à un simple l'en-tête de demande personnalisé via l'en-tête HttpRequestMessage ( Documentation MSDN ) passée dans cette méthode surchargée ?

Answer 1

Essayez quelque chose comme ça :

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

Il y a aussi un TryGetValues sur les en-têtes que vous pouvez utiliser si vous n'avez pas toujours la garantie d'avoir accès à l'en-tête.

Answer 2

La ligne ci-dessous throws exception si la clé n'existe pas.

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

Solution sûre utilisant TryGetValues :

Inclure System.Linq ;

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

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

Answer 3

Pour développer la réponse de Youssef, j'ai écrit cette méthode en me basant sur les préoccupations de Drew concernant l'inexistence de l'en-tête, car j'ai rencontré cette situation lors des tests unitaires.

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

Voici un exemple d'utilisation :

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

Consultez également la réponse de @doguhan-uluca pour une solution plus générale.

Answer 4

Créer une nouvelle méthode - ' Renvoie une valeur d'en-tête HTTP individuelle et appelez cette méthode avec la valeur de la clé à chaque fois que vous avez besoin d'accéder à plusieurs valeurs de clé à partir de 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 5

Pour approfondir la solution de @neontapir, voici une solution plus générique qui peut s'appliquer aussi bien à HttpRequestMessage qu'à HttpResponseMessage et qui ne nécessite pas d'expressions ou de fonctions codées à la main.

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

Exemple d'utilisation :

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