Maîtriser PHP : techniques de type Hinting

Photo par ???? ??? sur Unsplash

Les indications de type sont considérées par certains comme le Saint Graal des fonctionnalités. Celui que tous les langages de programmation doivent avoir. Pendant très longtemps, PHP n'a pas disposé d'un tel système, mais il a maintenant été largement adopté par la plupart des développeurs.

Cela dit, le système de types de PHP ne va pas aussi loin que celui des autres langages. Beaucoup mettent en œuvre ce que l’on appelle les génériques. Il s'agit de la capacité d'imposer un type parmi les structures et les collections. Par exemple, en Java, nous pouvons spécifier que les tableaux ne doivent contenir que des éléments d'un certain type, par exemple un tableau de chaînes.

Peut-être qu'un jour nous aurons également cette fonctionnalité en PHP, mais d'ici là, nous pouvons réellement résoudre ce problème avec quelques techniques différentes. Faute d'une meilleure description, je les appelle Astuces Soft Type et Astuces d'exécution.

Conseils de saisie

Les premiers et les plus évidents indices de type sont ceux introduits dans PHP 7 et sont toujours ajoutés à PHP. Les constantes d'indication de type n'ont été ajoutées que dans PHP 8.3.

Les indices de type sont utiles pour aider à transmettre ce qui doit être transmis à une méthode ou une fonction en tant que paramètre ou ce que cette méthode renverra. Les indices de type affecteront les signatures de toutes les classes avec lesquelles ils les utilisent, car étendre une classe avec des indices de type déjà établis signifiera qu'ils ne pourront pas être remplacés.

Un exemple de classe utilisant pleinement les types serait :

<?php

class Foo
{
    public function bar(array $strings): \Closure
    {
       return function (string $string) use ($strings): bool {
           return in_array($string, $strings);
       };
    }
}

Il y a, bien sûr, des limites dans nos indications de type car, comme mentionné précédemment, nous ne pouvons pas conformer un tableau pour qu'il soit tous du même type et nous devons simplement utiliser array . Nous ne pouvons pas non plus limiter les nombres à être uniquement positifs ou dans une certaine plage.

Un autre peut être les fermetures car il n'y a aucun moyen de décrire les fonctions anonymes dans les types natifs de PHP. Au lieu de cela, nous devons soit utiliser Closure, soit callable . Souvent, callable ne peut pas non plus être utilisé comme type.

Heureusement, il existe encore un moyen de décrire ces scénarios plus compliqués avec des indices de type.

Conseils de type doux

Nos prochains types d'indices de type sont fournis via PHPDocs. Alors que les types natifs lèveront des exceptions pendant l'exécution si une méthode est passée ou renvoie le mauvais type, les astuces de type PHPDoc n'ont aucun effet sur le temps d'exécution de l'application.

Au lieu de cela, les astuces de type logiciel nous aident uniquement lorsque nous utilisons un IDE tel que VS Code ou PHPStorm, qui détectera ces types pour nous. L'autre cas d'utilisation concerne les outils d'analyse statique comme PHPStan puis Rector.

Le plus grand avantage de l'utilisation des types logiciels est qu'ils vous permettent de décrire avec plus de précision le type de n'importe quel paramètre, propriété, etc. Par exemple, nous pouvons prendre la classe précédente et faciliter la compréhension des tableaux ou des fermetures utilisés .

<?php

class Foo
{
    /**
     * @param string[] $strings
     * @return \Closure(string): bool
     */
    public function bar(array $strings): \Closure
    {
       return function (string $string) use ($strings): bool {
           return in_array($string, $strings);
       };
    }
}

La meilleure façon de vous assurer que toute votre utilisation de type est correcte est d'installer PHPStan. À partir de là, vous devrez probablement utiliser au moins le niveau 5. Cela peut ensuite être appliqué via des étapes d'intégration continue qui vérifient que l'indication de type est correcte.

Il existe en fait une liste que vous pouvez utiliser si vous souhaitez utiliser le bon indice de type logiciel. Mieux encore, il existe un outil PHPStan que vous pouvez utiliser pour tester si tous les types qui le suggèrent sont corrects selon PHPStan si vous n'êtes pas sûr et souhaitez exécuter un test rapide.

Conseils d'exécution

Notre prochaine façon de prendre en charge les types consiste à utiliser des astuces d'exécution. Cela signifie en réalité exécuter notre propre code pour vérifier les types à partir des paramètres. Par exemple, nous pouvons vérifier si un tableau ne contient qu’un type particulier d’objet. Si ce n’est pas le cas, nous lançons une InvalidArgumentException.

<?php

/**
 * @param string[] $foo
 */
function bar(array $foo) {
    foreach ($foo as $string) {
        if (! is_string($string)) {
            throw new \InvalidArgumentException('foo contains non-string value');
        }
    }

    // rest of the code
}

D'ailleurs, cette technique est parfois appelée programmation défensive. En regardant l'exemple de code, c'est assez fastidieux. Cela fait beaucoup de code simplement pour vérifier si un tableau est correct. C'est pourquoi nous avons souvent recours à une bibliothèque, en l'occurrence webmozart/assert .

composer require webmozart/assert

Maintenant, avec ce package installé, nous pouvons raccourcir cela à une simple ligne.

<?php

use Webmozart\Assert;

/**
 * @param string[] $foo
 */
function bar(array $foo) {
    Assert::allStrings($foo);
}

L'un des avantages de cette bibliothèque est que si vous ajoutez l'extension Assert à PHPStan, cela vous aidera à couvrir vos types lorsque le code sera analysé.

Kesimpulan

Kesimpulannya, menguasai pembayang jenis dalam PHP ialah kemahiran penting untuk pembangun yang ingin menulis kod yang bersih, boleh diselenggara dan boleh dipercayai. Walaupun sistem jenis PHP masih kekurangan beberapa ciri yang terdapat dalam bahasa lain, seperti generik, terdapat berbilang strategi yang tersedia untuk menguatkuasakan penaipan yang lebih ketat — sama ada melalui pembayang jenis asli, anotasi PHPDoc atau semakan masa jalan. Memanfaatkan alatan seperti PHPStan dan perpustakaan seperti Assert boleh membantu anda memastikan keselamatan jenis, walaupun dalam senario yang rumit. Dengan menyepadukan teknik ini ke dalam aliran kerja pembangunan anda, anda akan lebih bersedia untuk mengendalikan sifat dinamik PHP dengan yakin dan tepat.

Saya Peter Fox, pembangun perisian di UK yang bekerja dengan Laravel. Terima kasih kerana membaca artikel saya, saya ada banyak lagi untuk dibaca di https://articles.peterfox.me. Saya juga kini Ditaja di GitHub. Jika anda ingin menggalakkan saya menulis lebih banyak artikel seperti ini, sila pertimbangkan untuk menghulurkan sedikit sumbangan sekali sahaja.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!