Apprendre à tout faire ou presque avec le pipeline de HttpClient

Thomas Levesque

Le système de pipeline de HttpClient offre de nombreuses possibilités pour modifier le traitement des requêtes et réponses. Cet article vous guidera à travers quelques exemples. Commentez

- Titre : Apprendre à tout faire ou presque avec le pipeline de HttpClient

- Auteur : Thomas Levesque

- Parution : 27 juin 2017

- Public visé :

- Licence : Les sources présentées sur cette page sont libres de droits et vous pouvez les utiliser à votre convenance. Par contre, la page de présentation constitue une œuvre intellectuelle protégée par les droits d'auteur. Copyright ® 2017 Thomas Levesque. Aucune reproduction, même partielle, ne peut être faite de ce site et de l'ensemble de son contenu : textes, documents, images, etc. sans l'autorisation expresse de l'auteur. Sinon vous encourez selon la loi jusqu'à trois ans de prison et jusqu'à 300 000 € de dommages et intérêts.

Sommaire

- Introduction

- Le pipeline

- Tests unitaires

- Logging

- Réessayer les requêtes qui ont échoué

- Autres cas d'utilisations

- Note de la rédaction de Developpez.com

Introduction

Il y a quelques années, Microsoft a introduit la classe HttpClient comme substitut moderne à HttpWebRequest pour faire des requêtes web depuis des applications .NET. Non seulement cette nouvelle API est beaucoup plus facile à utiliser, plus propre, et asynchrone, mais elle est aussi facilement extensible.

Vous avez peut-être remarqué que HttpClient a un constructeur qui accepte un HttpMessageHandler. De quoi s'agit-il ? Un HttpMessageHandler est un objet qui accepte une requête (HttpRequestMessage) et renvoie une réponse (HttpResponseMessage) ; la façon dont il le fait dépend complètement de l'implémentation. Par défaut, HttpClient utilise HttpClientHandler, un handler qui envoie une requête vers un serveur sur le réseau et renvoie la réponse du serveur. L'autre implémentation fournie de HttpMessageHandler est une classe abstraite nommée DelegatingHandler, et c'est de celle-là que je voudrais parler.

Le pipeline

DelegatingHandler est un handler qui est conçu pour être chaîné à un autre handler, ce qui donne un pipeline à travers lequel les requêtes et réponses vont passer, comme illustré par ce schéma :

(Image tirée du site officiel ASP.NET)

Chaque handler a la possibilité d'examiner et/ou de modifier la requête avant de la passer au handler suivant, et d'examiner et/ou de modifier la réponse reçue du handler suivant. Habituellement, le dernier handler dans le pipeline est le HttpClientHandler, qui communique directement avec le réseau.

La chaîne de handlers peut être configurée comme ceci :

1. var pipeline = new MyHandler1()

2. {

3. InnerHandler = new MyHandler2()

4. {

5. InnerHandler = new HttpClientHandler()

6. }

7. };

8. var client = new HttpClient(pipeline);

Mais si vous préférez les interfaces « fluent », il est facile de créer une méthode d'extension qui permet de le faire comme ceci :

1. var pipeline = new HttpClientHandler()

2. .DecorateWith(new MyHandler2())

3. .DecorateWith(new MyHandler1());

4. var client = new HttpClient(pipeline);

Tout ça semble peut-être un peu abstrait pour l'instant, mais cette architecture à base de pipeline rend possibles plein de scénarios intéressants. En effet, ces handlers de messages HTTP peuvent être utilisés pour ajouter des comportements personnalisés au traitement des requêtes et réponses. Je vais en donner quelques exemples.

Remarque : je présente cette fonctionnalité d'un point de vue client (vu que je développe essentiellement des applis clientes), mais le même système de handlers est également utilisé côté serveur dans ASP.NET Web API.

Tests unitaires

Le premier cas d'utilisation qui vient à l'esprit, et le premier que j'ai mis en œuvre, c'est les tests unitaires. Si vous testez une classe qui fait des paiements en ligne via HTTP, vous ne voulez pas que vos tests envoient réellement des requêtes au vrai serveur… Vous voulez juste vous assurer que les requêtes envoyées sont correctes, et que le code réagit correctement à des réponses spécifiques. Une solution simple à ce problème est de créer un handler « stub », et de l'injecter dans votre classe à la place de HttpClientHandler. Voici une implémentation possible :

1. class StubHandler : HttpMessageHandler

2. {

3. // Responses to return

4. private readonly Queue<HttpResponseMessage> _responses =

5. new Queue<System.Net.Http.HttpResponseMessage>();

7. // Requests that were sent via the handler

8. private readonly List<HttpRequestMessage> _requests =

9. new List<System.Net.Http.HttpRequestMessage>();

11. protected override Task<HttpResponseMessage> SendAsync(

12. HttpRequestMessage request,

13. CancellationToken cancellationToken)

14. {

15. if (_responses.Count == 0)

16. throw new InvalidOperationException("No response configured");

18. _requests.Add(request);

19. var response = _responses.Dequeue();

20. return Task.FromResult(response);

21. }

23. public void EnqueueResponse(HttpResponseMessage response) =>

24. _responses.Enqueue(response);

26. public IEnumerable<HttpRequestMessage> GetRequests() =>

27. _requests;

28. }

Cette classe permet d'enregistrer les requêtes qui sont envoyées via le handler et de spécifier les réponses qui doivent être renvoyées. Par exemple, on pourrait écrire un test comme celui-ci :

1. // Arrange

2. var handler = new StubHandler();

3. handler.EnqueueResponse(new HttpResponseMessage(HttpStatusCode.Unauthorized));

4. var processor = new PaymentProcessor(handler);

6. // Act

7. var paymentResult = await processor.ProcessPayment(new Payment());

9. // Assert

10. Assert.AreEqual(PaymentStatus.Failed, paymentResult.Status);

Bien sûr, plutôt que de créer un stub manuellement, il est possible d'utiliser un framework de mock pour générer un faux handler. Le fait que la méthode SendAsync soit protégée rend cette approche un peu moins facile qu'elle devrait l'être, mais on peut facilement contourner le problème en créant une classe dérivée qui expose une méthode publique virtuelle, et en faisant un mock de cette classe :

1. public abstract class MockableMessageHandler : HttpMessageHandler

2. {

3. protected override sealed Task<HttpResponseMessage> SendAsync(

4. HttpRequestMessage request,

5. CancellationToken cancellationToken)

6. {

7. return DoSendAsync(request);

8. }

10. public abstract Task<HttpResponseMessage> DoSendAsync(HttpRequestMessage request);

11. }

Exemple d'utilisation avec FakeItEasy :

1. // Arrange

2. var handler = A.Fake<MockableMessageHandler>();

3. A.CallTo(() => handler.DoSendAsync(A<HttpRequestMessage>._))

4. .Returns(new HttpResponseMessage(HttpStatusCode.Unauthorized));

5. var processor = new PaymentProcessor(handler);

6. ...

Logging

Écrire dans le log les requêtes envoyées et les réponses reçues peut aider à diagnostiquer certains problèmes. C'est très facile à mettre en œuvre avec un DelegatingHandler personnalisé :

1. public class LoggingHandler : DelegatingHandler

2. {

3. private readonly ILogger _logger;

5. public LoggingHandler(ILogger logger)

6. {

7. _logger = logger;

8. }

10. protected override async Task<HttpResponseMessage> SendAsync(

11. HttpRequestMessage request,

12. CancellationToken cancellationToken)

13. {

14. _logger.Trace($"Request: {request}");

15. try

16. {

17. // base.SendAsync calls the inner handler

18. var response = await base.SendAsync(request, cancellationToken);

19. _logger.Trace($"Response: {response}");

20. return response;

21. }

22. catch (Exception ex)

23. {

24. _logger.Error($"Failed to get response: {ex}");

25. throw;

26. }

27. }

28. }

Réessayer les requêtes qui ont échoué

Un autre cas d'utilisation intéressant des handlers de messages HTTP est de réessayer automatiquement les requêtes qui ont échoué. Par exemple, le serveur auquel on s'adresse peut être temporairement indisponible (503), il peut limiter nos requêtes (429), ou on peut tout simplement avoir perdu l'accès à Internet. Dans toutes ces situations, réessayer la même requête plus tard a de bonnes chances de fonctionner (le serveur peut avoir redémarré, on peut avoir retrouvé du Wi-Fi…). Gérer la retentative au niveau du code applicatif est laborieux, car ça peut se produire pratiquement n'importe où. Avoir cette logique au plus bas niveau possible et implémentée d'une façon complètement transparente pour l'appelant rend les choses beaucoup plus simples.

Voici une implémentation possible d'un handler qui réessaie les requêtes qui ont échoué :

public class RetryHandler : DelegatingHandler
{
protected override async Task<HttpResponseMessage> SendAsync(
HttpRequestMessage request,
CancellationToken cancellationToken)
{
while (true)
{
try
{
// base.SendAsync calls the inner handler
var response = await base.SendAsync(request, cancellationToken);

if (response.StatusCode == HttpStatusCode.ServiceUnavailable)
{
// 503 Service Unavailable
// Wait a bit and try again later
await Task.Delay(5000, cancellationToken);
continue;
}

if (response.StatusCode == (HttpStatusCode)429)
{
// 429 Too many requests
// Wait a bit and try again later
await Task.Delay(1000, cancellationToken);
continue;
}

// Not something we can retry, return the response as is
return response;
}
catch (Exception ex) when(IsNetworkError(ex))
{
// Network error
// Wait a bit and try again later
await Task.Delay(2000, cancellationToken);
continue;
}
}
}

private static bool IsNetworkError(Exception ex)
{
// Check if it's a network error
if (ex is SocketException)
return true;
if (ex.InnerException != null)
return IsNetworkError(ex.InnerException);
return false;
}
}

Remarquez que cette implémentation est un peu simpliste ; pour l'utiliser dans du code de production, il faudra sans doute ajouter un « exponential backoff » (attendre de plus en plus longtemps entre chaque tentative), prendre en compte l'en-tête Retry-After pour déterminer combien de temps il faut attendre, ou encore déterminer de façon un peu plus subtile si une exception correspond à une erreur réseau. De plus, en l'état actuel, ce handler réessaiera indéfiniment jusqu'à ce que la requête réussisse ; assurez-vous donc de passer un jeton d'annulation (CancellationToken) pour pouvoir l'arrêter si besoin.

Autres cas d'utilisations

Je ne peux pas donner d'exemples pour chaque scénario possible, mais voilà quelques autres cas d'utilisation possible des handlers de messages HTTP :

- gestion personnalisée des cookies (quelque chose que j'ai réellement fait, pour contourner un bogue dans CookieContainer) ;

- authentification personnalisée (également quelque chose que j'ai fait, pour implémenter l'authentification OAuth2) ;

- utiliser l'en-tête X-HTTP-Method-Override pour passer les proxy qui refusent certaines méthodes HTTP (voir l'article de Scott Hanselman pour plus de détails) ;

- chiffrement ou encodage personnalisé ;

- mise en cache ;

- etc.

Comme vous le voyez, il y a tout un monde de possibilités. Si vous avez d'autres idées, indiquez-les dans les commentaires !

Note de la rédaction de Developpez.com

Nous tenons à remercier Claude Leloup pour la relecture orthographique de ce tutoriel.