Programmation PHP avec Symfony/HttpClient

Composant

Évènement

Programmation PHP avec Symfony

Version imprimable

[ Modifier le sommaire ]

Composant

Évènement

Installation[modifier | modifier le wikicode]

Composant pour lancer des requêtes HTTP depuis l'application, avec gestion des timeouts, redirections, cache, protocole et en-tête HTTP. Il est configurable en PHP ou dans framework.yaml.

Depuis Symfony 4^[1] :

Terminal

composer require symfony/http-client

Utilisation[modifier | modifier le wikicode]

Par défaut, l'appel statique à la classe HttpClient instancie un CurlHttpClient, alors que l'injection du service via HttpClientInterface récupère un TraceableHttpClient :

HttpClient::create();
__construct(HttpClientInterface $httpClient)

GET[modifier | modifier le wikicode]

On peut forcer l'utilisation de HTTP 2 à la création :

        $httpClient = HttpClient::create(['http_version' => '2.0']);
        $response = $httpClient->request('GET', 'https://fr.wikibooks.org/');
        if (200 == $response->getStatusCode()) {
            dd($response->getContent());
        } else {
            dd($response->getInfo('error'));
        }

Ce code ne lève pas les exceptions de résolution DNS.

POST[modifier | modifier le wikicode]

Exemple en POST avec authentification :

        $response = $httpClient->request('POST', 'https://fr.wikibooks.org/w/api.php', [
            'auth_bearer' => 'mon_token',
            'jsonA' => $keyValuePairs,
        ]);

Pour lancer plusieurs appels asynchrones, il suffit de placer leurs $response->getContent() ensemble, après tous les $httpClient->request().

Pour envoyer un fichier il y a plusieurs solutions :

Utiliser le type MIME correspondant à son extension (ex : 'application/pdf', 'application/zip'...). Mais on ne peut envoyer que le fichier dans la requête.
Utiliser le type MIME 'application/json' et l'encoder en base64. Il peut ainsi être envoyé avec d'autres données.
Utiliser le type MIME 'multipart/form-data'^[2].

Problèmes connus[modifier | modifier le wikicode]

Ce composant est relativement jeune et souffre d'incomplétudes.

On peut avoir du "null given" à tort sur un mapping DNS, solvable en rajoutant une option :

        $options = array_merge($options, [
            'resolve' => ['localhost' => '127.0.0.1']
        ]);

$httpClient->request() renvoie une Symfony\Contracts\HttpClient\ResponseInterface, mais en cas d'erreur, elle ne contient qu'une ligne de résumé, soit moins d'informations qu'un client comme Postman.

Tests[modifier | modifier le wikicode]

Ce composant peut aussi serveur aux tests fonctionnels via PhpUnit. On l'appelle alors avec static::createClient si le test extends WebTestCase. Dans le cas d'un projet API Platform, on l'appelle de la même manière mais le test extends ApiTestCase.

Exemple :

$client = static::createClient();
$client->request('GET', '/home');
var_dump($client->getResponse()->getContent());

Pour simuler plusieurs clients en parallèle : $client->insulate().

Pour simuler un utilisateur : $client->loginUser($monUser).

Pour un test de bundle, il faut créer une classe Kernel qui charge les routes en plus^[3].

Références[modifier | modifier le wikicode]

[1] ttps://symfony.com/doc/current/components/http_client.html

[2] ttps://dev.to/timoschinkel/sending-multipart-data-with-psr-18-2lb5

[3] ttps://symfonycasts.com/screencast/symfony-bundle/controller-functional-test

[1]

[2]

[3]